azure.azcollection.azure_rm_aduser 模块 – 修改 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_aduser。

azure.azcollection 1.5.0 中的新增功能

概要

• 创建、删除和更新 Azure Active Directory 用户。

要求

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

• python >= 2.7

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

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

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

参数

参数	注释
account_enabled 布尔值	一个布尔值，用于确定用户帐户是否启用。 在创建或更新用户帐户时使用。 选项 false true
ad_user 字符串	Active Directory 用户名。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 azure.azcollection 0.0.1 中新增	Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。
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* 中的用户。 与 *object_id*、*user_principal_name* 和 *odata_filter* 互斥。 与 *attribute_value* 一起使用时为必填项。
attribute_value 字符串	要与 *attribute_name* 匹配的值。 如果 *attribute_name* 不是集合类型，则它将更新或删除 *attribute_name* 等于 *attribute_value* 的用户。 如果 *attribute_name* 是集合类型，则它将更新或删除 *attribute_value* 位于 *attribute_name* 中的用户。 与 *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"
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"
company_name 字符串	用户关联的公司的名称。 此属性可用于描述外部用户来自的公司。 最大长度为 64 个字符。仅在 $select 中返回。 支持 $filter （eq、ne、not、ge、le、in、startsWith 和对空值的 eq）。
disable_instance_discovery 布尔值 azure.azcollection 2.3.0 版本中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的情况，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← (默认) true
display_name 字符串	用户的显示名称。 在创建或更新用户帐户时使用。
given_name 字符串	用户的给定名称。 在创建或更新用户帐户时使用。
log_mode 字符串	父参数。
log_path 字符串	父参数。
mail 字符串	用户的首要电子邮件地址。 在创建或更新用户帐户时使用。
mail_nickname 字符串	用户的邮件别名。 在创建或更新用户帐户时使用。
mobile_phone 字符串	用户的手机号码。 在创建或更新用户帐户时使用。
object_id 字符串	用户的对象 ID。 更新或删除拥有此对象 ID 的用户。 与 *user_principal_name*、*attribute_name* 和 *odata_filter* 互斥。
odata_filter 字符串	可用于指定要更新或删除的用户的筛选器。 与 *object_id*、*attribute_name* 和 *user_principal_name* 互斥。
on_premises_extension_attributes 别名：extension_attributes 字典	包含用户的 extensionAttributes1-15。 这些扩展属性也称为 Exchange 自定义属性 1-15。 对于启用了 onPremisesSyncEnabled 的用户，此属性集的权威来源是本地，并且是只读的。 对于仅云用户（其中 onPremisesSyncEnabled 为 false），可以在创建或更新用户对象期间设置这些属性。 对于以前从本地 Active Directory 同步的仅云用户，这些属性在 Microsoft Graph 中是只读的，但可以通过 Exchange 管理中心或 PowerShell 中的 Exchange Online V2 模块完全管理。
on_premises_immutable_id 别名：immutable_id 字符串	用户的 on_premises_immutable_id。 在创建或更新用户帐户时使用。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
password_force_change 布尔值	用户是否必须在下次登录时更改密码。 如果未指定，Azure 默认情况下会为新用户将其设置为 true。 在创建或更新用户帐户时使用。 选项 false true
password_force_change_mfa 布尔值	与 password_force_change 的行为相同，只是必须先执行多因素身份验证 (MFA) 才能更改密码。 在创建或更新用户帐户时使用。 选项 false true
password_profile 字符串	用户的密码。 在创建或更新用户帐户时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
state 字符串	AD 用户的状态。使用 present 创建或更新 AD 用户，使用 absent 删除 AD 用户。 选项 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
surname 字符串	用户的姓氏。 在创建或更新用户帐户时使用。
tenant 字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
thumbprint 字符串 azure.azcollection 1.14.0 版本中添加	在 *x509_certificate_path* 中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则为必需。
usage_location 字符串	两位字母的国家/地区代码，ISO 标准 3166。 对于将被分配许可证的用户来说是必需的，因为法律要求检查各国服务的可用性。 在创建或更新用户帐户时使用。
user_principal_name 字符串	用户的主体名称。 创建、更新或删除拥有此主体名称的用户。 与 *object_id*、*attribute_name* 和 *odata_filter* 互斥。
user_type 字符串	可用于对目录中用户类型进行分类的字符串值，例如成员和访客。 在创建或更新用户帐户时使用。
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: Create user
  azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "present"
    account_enabled: "True"
    display_name: "Test_{{ user_principal_name }}_Display_Name"
    password_profile: "password"
    mail_nickname: "Test_{{ user_principal_name }}_mail_nickname"
    on_premises_immutable_id: "{{ object_id }}"
    given_name: "First"
    surname: "Last"
    user_type: "Member"
    usage_location: "US"
    mail: "{{ user_principal_name }}@contoso.com"
    mobile_phone: "+1234567890123"
    company_name: 'Test Company'
    on_premises_extension_attributes:
      extension_attribute1: "test_extension_attribute1"
      extension_attribute2: "test_extension_attribute2"
      extension_attribute11: "test_extension_attribute11"

- name: Update user with new value for account_enabled
  azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "present"
    account_enabled: "False"

- name: Delete user
  azure_rm_aduser:
    user_principal_name: "{{ user_id }}"
    state: "absent"

返回值

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

键	描述
account_enabled 布尔值	帐户是否已启用。 返回值：始终 示例：false
company_name 字符串	用户关联的公司的名称。 返回值：始终 示例："Test Company"
display_name 字符串	用户的显示名称。 返回值：始终 示例："John Smith"
mail 字符串	用户的首要电子邮件地址。 返回值：始终 示例："[email protected]"
mail_nickname 字符串	用户的邮件别名。 返回值：始终 示例："jsmith"
mobile_phone 字符串	用户的手机号码。 返回值：始终 示例："+1234567890123"
object_id 字符串	用户的 object_id。 返回值：始终 示例："xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
on_premises_extension_attributes 字典	包含用户的 extensionAttributes1-15。 这些扩展属性也称为 Exchange 自定义属性 1-15。 对于启用了 onPremisesSyncEnabled 的用户，此属性集的权威来源是本地，并且是只读的。 对于仅云用户（其中 onPremisesSyncEnabled 为 false），可以在创建或更新用户对象期间设置这些属性。 对于以前从本地 Active Directory 同步的仅云用户，这些属性在 Microsoft Graph 中是只读的，但可以通过 Exchange 管理中心或 PowerShell 中的 Exchange Online V2 模块完全管理。 返回值：始终 示例：{}
user_principal_name 字符串	用户的主体名称。 返回值：始终 示例："[email protected]"
user_type 字符串	可用于对目录中用户类型进行分类的字符串值。 返回值：始终 示例："Member"

作者

• Cole Neubauer(@coleneubauer)

收藏链接

• 问题追踪器
• 主页
• 仓库（源代码）