azure.azcollection.azure_rm_managementgroup_info 模块 – 获取 Azure 管理组信息

注意

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

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

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

要在剧本中使用它，请指定：azure.azcollection.azure_rm_managementgroup_info。

azure.azcollection 1.5.0 中的新增功能

概要

  • 获取特定管理组或所有管理组的信息。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。

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"

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"

children

布尔值

如果为 False，则仅获取 *name* 或 *id* 组，或仅获取根组列表。

如果为 True，则还将返回子组。

选项

  • false ← (默认)

  • true

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

flatten

布尔值

如果为 True，则子管理组和订阅将分别复制到管理组和订阅返回列表的根目录。

默认情况下（False），子元素将仅出现在嵌套的复杂结构中。

仅当children 为 c(True) 时，option 参数才有效，否则将静默忽略。

选项

  • false ← (默认)

  • true

id

字符串

按 ID 限制结果到特定的管理组。

与name 参数互斥。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

别名：management_group_name

字符串

按名称限制结果到特定的管理组。

与id 参数互斥。

password

字符串

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

profile

字符串

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

recurse

布尔值

默认情况下，c(False)，如果children 为 c(True)，则只返回直接子项。

如果 c(True)，则返回层次结构的所有后代。

仅当children 为 c(True) 时，option 参数才有效，否则将静默忽略。

选项

  • 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

path

新增于 azure.azcollection 1.14.0

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

证书必须附加到私钥。

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

备注

注意

  • azure_rm_managementgroup_info - 执行 playbook 的主体的分配角色将决定哪个是根管理组。您也可能能够请求父管理组的详细信息，但无法获取该组。强烈建议如果设置children 为 c(True)，则应请求特定的管理组，因为所有组的列表将需要为每个返回的组进行额外的 Azure API 调用。

  • 对于 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_rm_subscription_info

用于查找有关订阅的更深入信息的模块；例如标签。

azure_rm_roleassignment_info

用于查找 RBAC 角色分配的模块，可以使用管理组 ID 作为范围。

使用 Azure CLI 登录

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

示例

- name: Get facts for all root management groups for authenticated principal
  azure_rm_managementgroup_info:

- name: Get facts for one management group by id with direct children
  azure_rm_managementgroup_info:
    id: /providers/Microsoft.Management/managementGroups/contoso-group
    children: true

- name: Get facts for one management group by name with all children, flattened into top list
  azure_rm_managementgroup_info:
    name: "contoso-group"
    children: true
    recurse: true
    flatten: true

返回值

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

键

描述

management_groups

列表 / 元素=字符串

管理组字典列表。

返回：始终

children

列表 / 元素=字符串

子管理组或订阅。

返回：如果children 为 c(True)

示例： ["嵌套的子项列表，与顶级组相同，但缺少tenant_id。"]

display_name

字符串

管理组显示名称。

返回：始终

示例： "我的管理组"

id

字符串

管理组完全限定 ID。

返回：始终

示例： "/providers/Microsoft.Management/managementGroups/group-name"

name

字符串

管理组显示名称。

返回：始终

示例： "group-name"

tenant_id

字符串

管理组租户 ID

返回：始终

示例： "00000000-0000-0000-0000-000000000000"

type

字符串

管理组类型

返回：始终

示例： "/providers/Microsoft.Management/managementGroups"

subscriptions

列表 / 元素=字符串

订阅对象列表。

返回：如果children 和flatten 都为 c(True)

display_name

字符串

订阅显示名称。

返回：始终

示例： "some-subscription-name"

id

字符串

订阅完全限定 ID。

返回：始终

示例： "/subscriptions/00000000-0000-0000-0000-feedc0ffee000000"

subscription_id

字符串

订阅 GUID。

返回：始终

示例： "00000000-0000-0000-0000-feedc0ffee000000"

type

字符串

管理组类型

返回：始终

示例： "/subscriptions"

作者

  • Paul Aiton (@paultaiton)