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。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

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

azure.azcollection 1.5.0 中的新增功能

概要

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

要求

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

  • python >= 2.7

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

  • 通过 pip 在执行 azure.azcollection 模块的主机上安装 collection 的 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 授权时使用。

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（如果存在多个订阅 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"

children

布尔值

如果为 c(False)，则仅获取 name 或 id 组，或者仅获取根组的列表。

如果为 c(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

布尔值

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

默认情况下为 c(False)，子元素仅会出现在嵌套复合中。

仅当 children 为 c(True) 时此选项才起作用，否则将被静默忽略。

选择

  • 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) 时此选项才起作用，否则将被静默忽略。

选择

  • 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 中的配置文件，或者在使用 az login 命令运行任务或 playbook 之前登录。

  • 也可以使用服务主体或 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_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)