azure.azcollection.azure_rm_adgroup 模块 – 管理 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。
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 找到
参数
参数 |
注释 |
|---|---|
断言不属于该组的 Azure AD 对象。 |
|
断言不是该组所有者的 Azure AD 对象。 |
|
Active Directory 用户名。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时要使用的 API 配置文件。对于公共云， 默认值： |
|
控制用于身份验证的凭据来源。 也可以通过 设置为 设置为 设置为 设置为 设置为 Ansible 2.6 中添加了 选项
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。在使用服务主体或托管身份 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 默认值： |
|
组的可选描述。 |
|
确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索授权元数据以验证授权。将其设置为 **True** 将禁用授权的验证。因此，必须确保配置的授权主机有效且值得信赖。 通过凭据文件配置文件或 选项
|
|
AD 组的显示名称。 可以与 mail_nickname 一起使用，而不是 object_id 来引用现有组。 创建新的 AD 组时必填。 |
|
父参数。 |
|
父参数。 |
|
AD 组的邮件昵称。 可以与 display_name 一起使用，而不是 object_id 来引用现有组。 创建新的 AD 组时必填。 |
|
AD 组的 object id。 可以用于在更新现有组时进行引用。 尝试创建组时将被忽略。 |
|
活动目录用户密码。在使用活动目录用户而不是服务主体进行身份验证时使用。 |
|
声明为该组成员的 Azure AD 对象。 此列表无需包含所有成员。不在此列表中但属于成员的对象仍然保持成员身份。 |
|
声明为该组所有者的 Azure AD 对象。 此列表无需包含所有所有者。不在此列表中但属于所有者的对象仍然保持所有者身份。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
默认情况下，group_members 返回属性会在返回之前被展平并部分过滤掉非用户对象。此参数会禁用这些转换。 选项
|
|
Azure 客户端密钥。在使用服务主体进行身份验证时使用。 |
|
声明资源组的状态。使用 选项
|
|
您的 Azure 订阅 ID。 |
|
Azure 租户 ID。在使用服务主体进行身份验证时使用。 |
|
在 *x509_certificate_path* 中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则为必需。 |
|
PEM 格式的服务主体使用的 X509 证书的路径。 证书必须附加到私钥。 在使用服务主体进行身份验证时使用。 |
注释
注意
对于使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用
az login登录。也可以使用服务主体或活动目录用户进行身份验证。
要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。
要通过活动目录用户进行身份验证，请传递 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: Create Group
azure_rm_adgroup:
display_name: "Group-Name"
mail_nickname: "Group-Mail-Nickname"
description: 'fortest'
state: 'present'
- name: Delete Group using display_name and mail_nickname
azure_rm_adgroup:
display_name: "Group-Name"
mail_nickname: "Group-Mail-Nickname"
state: 'absent'
- name: Delete Group using object_id
azure_rm_adgroup:
object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: 'absent'
- name: Ensure Users are Members of a Group using display_name and mail_nickname
azure_rm_adgroup:
display_name: "Group-Name"
mail_nickname: "Group-Mail-Nickname"
state: 'present'
present_members:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
- name: Ensure Users are Members of a Group using object_id
azure_rm_adgroup:
object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: 'present'
present_members:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
- name: Ensure Users are Members of a Group using object_id. Specify the group_membership return should be unfiltered
azure_rm_adgroup:
object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: 'present'
present_members:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
raw_membership: true
- name: Ensure Users are not Members of a Group using display_name and mail_nickname
azure_rm_adgroup:
display_name: "Group-Name"
mail_nickname: "Group-Mail-Nickname"
state: 'present'
absent_members:
- "{{ ad_object_1_object_id }}"
- name: Ensure Users are not Members of a Group using object_id
azure_rm_adgroup:
object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: 'present'
absent_members:
- "{{ ad_object_1_object_id }}"
- name: Ensure Users are Owners of a Group using display_name and mail_nickname
azure_rm_adgroup:
display_name: "Group-Name"
mail_nickname: "Group-Mail-Nickname"
state: 'present'
present_owners:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
- name: Ensure Users are Owners of a Group using object_id
azure_rm_adgroup:
object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: 'present'
present_owners:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
- name: Ensure Users are not Owners of a Group using display_name and mail_nickname
azure_rm_adgroup:
display_name: "Group-Name"
mail_nickname: "Group-Mail-Nickname"
state: 'present'
absent_owners:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
- name: Ensure Users are not Owners of a Group using object_id
azure_rm_adgroup:
object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: 'present'
absent_owners:
- "{{ ad_object_1_object_id }}"
- "{{ ad_object_2_object_id }}"
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
Key |
描述 |
|---|---|
组的可选描述。 返回：始终 示例： |
|
组的显示名称。 返回：始终 示例： |
|
组的成员。如果 raw_membership 为 false，则包含传递成员属性。否则，它包含成员属性。 返回：始终 |
|
组的所有者。 返回：始终 |
|
组是否启用了邮件。必须为 false。这是因为只能使用 Graph API 创建纯安全组。 返回：始终 示例： |
|
组的邮件别名。 返回：始终 示例： |
|
组的 object_id。 返回：始终 示例： |
|
组是否启用了安全性。 返回：始终 示例： |