azure.azcollection.azure_rm_adapplication_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_adapplication_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 授权时使用。

api_profile

字符串

azure.azcollection 0.0.1 中新增

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

默认值： "latest"

app_diff

列表 / 元素=字典

应用程序列表

应用程序名称或应用程序 ID 是必需的

还可以提供应用程序的所有字段（从 JSON 或 YAML 解析）。

使用此选项，您可以使用应用程序列表将您自定义的应用程序与当前状态进行比较。仅存在于当前状态但不在您的列表中的应用程序将作为包含所有字段的列表返回，并将接收额外的 ABSENT 状态。这允许您首先使用 azure_rm_adapplication 添加应用程序，然后使用 azure_rm_adapplication_info（diff 选项）来识别不应该出现在当前状态中的应用程序，并随后使用 azure_rm_adapplication 删除它们。

app_display_name

字符串

应用程序名称。

app_id

字符串

应用程序 ID。

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

identifier_uri

字符串

identifier_uri 的对象 ID。

log_mode

字符串

父参数。

log_path

字符串

父参数。

object_id

字符串

应用程序的对象 ID。

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，则需要此参数。

x509_certificate_path

path

azure.azcollection 1.14.0 中添加

PEM 格式下用于创建服务主体的 X509 证书的路径。

证书必须附加到私钥。

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

备注

注意

  • 对于使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用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: get ad app info by App ID
  azure_rm_adapplication_info:
    app_id: "{{ app_id }}"

- name: get ad app info ---- by object ID
  azure_rm_adapplication_info:
    object_id: "{{ object_id }}"

- name: get ad app info ---- by identifier uri
  azure_rm_adapplication_info:
    identifier_uri: "{{ identifier_uri }}"

- name: get ad app info ---- by display name
  azure_rm_adapplication_info:
    app_display_name: "{{ display_name }}"

- name: get ad app diff ---- by display name
  azure_rm_adapplication_info:
    app_diff:
      - app_display_name: "{{ display_name }}"
      - app_id: "{{ app_id }}"

返回值

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

键

描述

app_diff

complex

AD 应用程序的信息。

返回：始终

app_display_name

字符串

对象的显示名称或其前缀。

返回：始终

示例："app"

app_id

字符串

应用程序 ID。

返回：始终

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

identifier_uris

列表 / 元素=字符串

应用程序的 identifier_uri 列表。

返回：始终

示例：["http://ansible-atodorov"]

object_id

字符串

这是应用程序的对象 ID。

返回：始终

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

optional_claims

complex

声明应用程序的可选声明。

返回：始终

access_token_claims

列表 / 元素=字符串

JWT 访问令牌中返回的可选声明

返回：始终

示例：[{"name": "aud"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

id_token_claims

列表 / 元素=字符串

JWT ID 令牌中返回的可选声明

返回：始终

示例：[{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

saml2_token_claims

列表 / 元素=字符串

SAML 令牌中返回的可选声明

返回：始终

示例：[{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

public_client_reply_urls

列表 / 元素=字符串

公共客户端重定向 URL。

Azure AD 将响应 OAuth 2.0 请求而重定向到的空格分隔的 URI。

返回：始终

示例：[]

sign_in_audience

字符串

该应用程序可用于任何 Azure AD 租户

返回：始终

示例："AzureADandPersonalMicrosoftAccount"

spa_reply_urls

列表 / 元素=字符串

SPA 重定向 URL。

Azure AD 将响应 OAuth 2.0 请求而重定向到的空格分隔的 URI。

返回：始终

示例：[]

state

字符串

absent -> 应用程序不在 app_diff 中。

返回：始终

示例："absent"

web_reply_urls

列表 / 元素=字符串

Web 重定向 URL。

Azure AD 将响应 OAuth 2.0 请求而重定向到的空格分隔的 URI。

返回：始终

示例：[]

applications

complex

AD 应用程序的信息。

返回：始终

app_display_name

字符串

对象的显示名称或其前缀。

返回：始终

示例："app"

app_id

字符串

应用程序 ID。

返回：始终

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

identifier_uris

列表 / 元素=字符串

应用程序的 identifier_uri 列表。

返回：始终

示例：["http://ansible-atodorov"]

object_id

字符串

这是应用程序的对象 ID。

返回：始终

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

optional_claims

complex

声明应用程序的可选声明。

返回：始终

access_token_claims

列表 / 元素=字符串

JWT 访问令牌中返回的可选声明

返回：始终

示例：[{"name": "aud"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

id_token_claims

列表 / 元素=字符串

JWT ID 令牌中返回的可选声明

返回：始终

示例：[{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

saml2_token_claims

列表 / 元素=字符串

SAML 令牌中返回的可选声明

返回：始终

示例：[{"name": "acct"}, {"source": null}, {"essential": false}, {"additional_properties": []}]

public_client_reply_urls

列表 / 元素=字符串

公共客户端重定向 URL。

Azure AD 将响应 OAuth 2.0 请求而重定向到的空格分隔的 URI。

返回：始终

示例：[]

sign_in_audience

字符串

该应用程序可用于任何 Azure AD 租户

返回：始终

示例："AzureADandPersonalMicrosoftAccount"

spa_reply_urls

列表 / 元素=字符串

SPA 重定向 URL。

Azure AD 将响应 OAuth 2.0 请求而重定向到的空格分隔的 URI。

返回：始终

示例：[]

web_reply_urls

列表 / 元素=字符串

Web 重定向 URL。

Azure AD 将响应 OAuth 2.0 请求而重定向到的空格分隔的 URI。

返回：始终

示例：[]

作者

  • haiyuan_zhang (@haiyuazhang) Fred-sun (@Fred-sun) guopeng_lin (@guopenglin) Xu Zhang (@xuzhang)