azure.azcollection.azure_rm_aduser_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_aduser_info。

azure.azcollection 1.4.0 中的新增功能

概要

  • 获取 Azure Active Directory 用户信息。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可以在 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，将不返回任何用户。

建议您改为识别用户子集并使用筛选器。

与 *object_id*、*attribute_name*、*odata_filter* 和 *user_principal_name* 互斥。

选择

  • 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* 中的用户。

与 *object_id*、*user_principal_name*、*odata_filter* 和 *all* 互斥。

与 *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，否则将选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选择

  • "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"

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

字符串

用户的对象 ID。

返回具有此对象 ID 的用户。

与 *user_principal_name*、*attribute_name*、*odata_filter* 和 *all* 互斥。

odata_filter

字符串

根据传递给此参数的 OData 过滤器返回用户。

与 *object_id*、*attribute_name*、*user_principal_name* 和 *all* 互斥。

password

字符串

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

profile

字符串

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

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

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

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

如果定义了 *x509_certificate_path*，则为必需。

user_principal_name

字符串

用户的 User Principal Name。

返回具有此 User Principal Name 的用户。

与 *object_id*、*attribute_name*、*odata_filter* 和 *all* 互斥。

x509_certificate_path

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 中。这是一个 ini 文件，其中包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Using user_principal_name
  azure.azcollection.azure_rm_aduser_info:
    user_principal_name: [email protected]

- name: Using object_id
  azure.azcollection.azure_rm_aduser_info:
    object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Using attribute mailNickname - not a collection
  azure.azcollection.azure_rm_aduser_info:
    attribute_name: mailNickname
    attribute_value: users_mailNickname

- name: Using attribute proxyAddresses - a collection
  azure.azcollection.azure_rm_aduser_info:
    attribute_name: proxyAddresses
    attribute_value: SMTP:[email protected]

- name: Using Filter mailNickname
  azure.azcollection.azure_rm_aduser_info:
    odata_filter: mailNickname eq '[email protected]'

- name: Using Filter proxyAddresses
  azure.azcollection.azure_rm_aduser_info:
    odata_filter: proxyAddresses/any(c:c eq 'SMTP:[email protected]')

返回值

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

键

描述

account_enabled

布尔值

帐户是否已启用。

返回值： 总是返回

示例： false

company_name

字符串

用户关联的公司的名称。

返回值： 总是返回

示例： "测试公司"

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

字符串

用户的 User Principal Name。

返回值： 总是返回

示例： "[email protected]"

user_type

字符串

一个字符串值，可用于对目录中的用户类型进行分类。

返回值： 总是返回

示例： "成员"

作者

  • Cole Neubauer(@coleneubauer)