azure.azcollection.azure_rm_managementgroup 模块 – 管理 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。

azure.azcollection 0.1.1 中的新增功能

概要 

创建、更新和删除 Azure 管理组实例。

要求 

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

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"`
append_tags 布尔值	用于控制标签字段是规范的还是只是附加到现有标签。当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。选项 `false` `true` ← (默认)
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"`
disable_instance_discovery 布尔值 azure.azcollection 2.3.0 版本新增	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从https://login.microsoft.com/检索权限元数据以验证权限。将其设置为True将禁用权限验证。因此，务必确保已配置的权限主机有效且值得信赖。通过凭据文件配置文件或`AZURE_DISABLE_INSTANCE_DISCOVERY`环境变量设置。选项 `false` ← (默认) `true`
group_id 字符串 / 必需	管理组 ID。
id 字符串	管理组的完全限定 ID。例如 /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串	管理组的名称。例如 00000000-0000-0000-0000-000000000000。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
properties 字典	管理组的属性。
display_name 字符串	管理组的友好名称。
parent_id 字符串	管理组的父级。
tenant_id 字符串	与管理组关联的 AAD 租户 ID。例如 00000000-0000-0000-0000-000000000000。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
state 字符串	声明 ManagementGroup 的状态。使用`present`创建或更新 ManagementGroup，使用`absent`删除它。选项 `"absent"` `"present"` ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串:字符串对的字典。对象上的元数据标签将使用任何提供的数值进行更新。要移除标签，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 每个资源只支持 15 个标签。
tenant 字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
thumbprint 字符串 azure.azcollection 1.14.0 版本新增	在x509_certificate_path中指定的私钥的指纹。在使用服务主体进行身份验证时使用。如果定义了x509_certificate_path，则为必需。
type 字符串	资源的类型。例如 /providers/Microsoft.Management/managementGroups。
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 new management group
  azure_rm_managementgroup:
    group_id: test
    type: /providers/Microsoft.Management/managementGroups/
    name: test

- name: create management group
  azure_rm_managementgroup:
    group_id: ChildGroup
    type: /providers/Microsoft.Management/managementGroups/
    name: ChildGroup
    properties:
      tenant_id: 20000000-0000-0000-0000-000000000000
      display_name: ChildGroup
      parent_id: /providers/Microsoft.Management/managementGroups/RootGroup

- name: delete management group
  azure_rm_managementgroup:
    group_id: ChildGroup
    state: absent

返回值 

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

键	描述
id 字符串	管理组的完全限定 ID。例如 /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000。返回值：始终
name 字符串	管理组的名称。例如 00000000-0000-0000-0000-000000000000。返回值：始终
properties 复杂	管理组的属性。返回值：始终
details 复杂	管理组的详细信息。返回值：始终
children 复杂	子项列表。返回值：始终
display_name 字符串	子资源的友好名称。返回值：始终
id 字符串	子资源（管理组或订阅）的完全限定 ID。例如 /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000。返回值：始终
name 字符串	子实体的名称。返回值：始终
type 字符串	包含提供程序命名空间的完全限定资源类型。例如 /providers/Microsoft.Management/managementGroups。返回值：始终
parent 复杂	管理组的父级。返回值：始终
display_name 字符串	父管理组的友好名称。返回值：始终
id 字符串	父管理组的完全限定 ID。例如 /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000。返回值：始终
name 字符串	父管理组的名称返回值：始终
updated_by 字符串	更新对象的委托人或进程的身份。返回值：始终
updated_time 字符串	上次更新此对象的时间和日期。返回值：始终
version 字符串	对象的版本号。返回值：始终
display_name 字符串	管理组的友好名称。返回值：始终
roles 字符串	与管理组关联的角色定义。返回值：始终
tenant_id 字符串	与管理组关联的 AAD 租户 ID。例如 00000000-0000-0000-0000-000000000000。返回值：始终
type 字符串	资源的类型。例如 /providers/Microsoft.Management/managementGroups。返回值：始终

作者

Zim Kalinowski (@zikalino)