azure.azcollection.azure_rm_adgroup_info 模块 – 获取 Azure Active Directory 组信息

注意

此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_adgroup_info。

azure.azcollection 1.6.0 中的新增功能

概要

  • 获取 Azure Active Directory 组信息。

要求

执行此模块的主机需要以下要求。

  • python >= 2.7

  • 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

  • 集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 中模块的主机上

  • 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数

注释

ad_user

字符串

Active Directory 用户名。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

adfs_authority_url

字符串

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。

all

布尔值

如果为 True，则返回租户中的所有组。

如果为 False，则不返回任何用户。

建议您改为识别组的子集并使用过滤器。

选项

  • false ← (默认)

  • true

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时要使用的 API 配置文件。 latest 的默认值适用于公有云；未来的值将允许与 Azure Stack 一起使用。

默认： "latest"

attribute_name

字符串

您想要与 *attribute_value* 匹配的属性的名称。

如果 *attribute_name* 不是集合类型，它将返回 *attribute_name* 等于 *attribute_value* 的组。

如果 *attribute_name* 是集合类型，它将返回 *attribute_value* 在 *attribute_name* 中的组。

attribute_value

字符串

与 attribute_name 匹配的值。

如果 *attribute_name* 不是集合类型，它将返回 *attribute_name* 等于 *attribute_value* 的组。

如果 *attribute_name* 是集合类型，它将返回 *attribute_value* 在 *attribute_name* 中的组用户。

auth_source

字符串

在 azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。

当设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。

当设置为 env 时，凭据将从环境变量中读取。

当设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。

当设置为 cli 时，凭据将来自 Azure CLI 配置文件。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于识别订阅 ID（如果存在多个），否则使用默认的 az cli 订阅。

当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于识别订阅 ID（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "auto" ← (默认)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

字符串

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选项

  • "ignore"

  • "validate"

check_membership

字符串

要检查其在返回的组中是否存在成员资格的联系人、组、用户或服务主体的对象 ID。

client_id

字符串

Azure 客户端 ID。在使用服务主体或托管身份 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

字符串

在 azure.azcollection 0.0.1 中添加

对于除美国公共云以外的其他云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud，AzureUSGovernment）或元数据发现端点 URL（Azure Stack 所需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

布尔值

azure.azcollection 2.3.0 版本中添加

确定尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选项

  • false ← (默认)

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

object_id

字符串

AD 组的 object id。

返回具有此 object ID 的组。

odata_filter

字符串

根据传递到此参数中的 OData 筛选器返回组。

password

字符串

Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

raw_membership

布尔值

默认情况下，group_members 返回属性在返回之前会被展平并部分过滤掉非用户对象。此参数禁用这些转换。

选项

  • false ← (默认)

  • true

return_group_members

布尔值

指示是否应将组的成员与返回的组一起返回。

选项

  • false ← (默认)

  • true

return_member_groups

布尔值

指示是否应将组所属的组与返回的组一起返回。

选项

  • false ← (默认)

  • true

return_owners

布尔值

指示是否应将组的所有者与返回的组一起返回。

选项

  • false ← (默认)

  • true

secret

字符串

Azure 客户端密钥。使用服务主体进行身份验证时使用。

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

Azure 租户 ID。使用服务主体进行身份验证时使用。

thumbprint

字符串

azure.azcollection 1.14.0 版本中添加

在 *x509_certificate_path* 中指定的私钥的指纹。

使用服务主体进行身份验证时使用。

如果定义了 *x509_certificate_path*，则需要此参数。

x509_certificate_path

路径

azure.azcollection 1.14.0 版本中添加

PEM 格式的服务主体使用的 X509 证书的路径。

证书必须附加到私钥。

使用服务主体进行身份验证时使用。

备注

注意

  • 对于 Azure 身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或 playbook 之前使用 az login 登录。

  • 也可以使用服务主体或 Active Directory 用户进行身份验证。

  • 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

  • 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

  • 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Return a specific group using object_id
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Return a specific group using object_id and  return the owners of the group
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true

- name: Return a specific group using object_id and return the owners and members of the group
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true
    return_group_members: true
- name: Return a specific group using object_id and return the owners and members of the group. Return service principals and nested groups.
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_owners: true
    return_group_members: true
    raw_membership: true

- name: Return a specific group using object_id and return the groups the group is a member of
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    return_member_groups: true

- name: Return a specific group using object_id and check an ID for membership
  azure_rm_adgroup_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    check_membership: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Return a specific group using displayName for attribute_name
  azure_rm_adgroup_info:
    attribute_name: "displayName"
    attribute_value: "Display-Name-Of-AD-Group"

- name: Return groups matching odata_filter
  azure_rm_adgroup_info:
    odata_filter: "mailNickname eq 'Mail-Nickname-Of-AD-Group'"

- name: Return all groups
  azure_rm_adgroup_info:
    all: true

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

描述

字符串

组的可选描述。

返回：始终

示例： "fortest"

display_name

字符串

组的显示名称。

返回：始终

示例： "GroupName"

group_members

列表 / 元素=字符串

组的成员。如果设置了 raw_membership，则此字段可能包含非用户对象（组、服务主体等）

返回：始终

group_owners

列表 / 元素=字符串

组的所有者。

返回：始终

mail

字符串

组的主要电子邮件地址。

返回：始终

示例： "[email protected]"

mail_enabled

布尔值

组是否启用了邮件。必须为 false。这是因为只能使用 Graph API 创建纯安全组。

返回：始终

示例： false

mail_nickname

字符串

组的邮件别名。

返回：始终

示例： "groupname"

object_id

字符串

组的 object_id。

返回：始终

示例： "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

security_enabled

布尔值

组是否启用了安全。

返回：始终

示例： false

作者

  • Cole Neubauer(@coleneubauer)

  • 张旭(@xuzhang)