azure.azcollection.azure_rm_registrationdefinition 模块 – 管理 Azure RegistrationDefinition 实例

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要更多要求才能使用此模块，请参阅 要求 了解详情。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_registrationdefinition。

azure.azcollection 1.3.0 中的新增功能

概要

  • 创建、更新和删除 Azure RegistrationDefinition 的实例。

要求

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

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

append_tags

布尔值

用于控制 tags 字段是规范的还是只是附加到现有 tags。

当为规范时，在 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，否则将选择第一个订阅。

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

字符串

父参数。

password

字符串

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

plan

dictionary

托管服务的计划详情。

name

string / required

计划名称。

product

string / required

产品代码。

publisher

string / required

发布者 ID。

version

string / required

计划的版本。

profile

字符串

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

properties

dictionary

注册定义的属性。

authorizations

list / elements=dictionary / required

授权元组，包含用户/安全组或服务主体的委托人 ID 以及内置角色的 ID。

principal_id

string / required

将被分配对投影订阅的权限的安全组/服务主体/用户的委托人 ID。

role_definition_id

string / required

角色定义标识符。

此角色将定义安全组/服务主体/用户必须在投影订阅上拥有的所有权限。

此角色不能是所有者角色。

description

字符串

注册定义的描述。

managed_by_tenant_id

string / required

managedBy 租户的 ID。

registration_definition_name

字符串

注册定义的名称。

registration_definition_id

字符串

注册定义的 ID。

如果未指定，将为其生成 UUID。

scope

字符串

订阅 ID 定义将在其中创建注册定义的订阅。

如果未指定，将使用从 AzureRMAuth 派生的订阅。

secret

字符串

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

state

字符串

断言 RegistrationDefinition 的状态。

使用 present 创建或更新 RegistrationDefinition，并使用 absent 删除它。

选项

  • "absent"

  • "present" ←（默认）

subscription_id

字符串

您的 Azure 订阅 ID。

tags

dictionary

要分配为对象元数据的字符串：字符串对的字典。

对象上的元数据标记将使用任何提供的值进行更新。

要删除标记，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。

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 运行任务或 playbook 之前登录。

  • 也可以使用服务主体或 Active Directory 用户进行身份验证。

  • 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

  • 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和密码，或在环境中设置 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: Create Registration Definition without scope
  azure_rm_registrationdefinition:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      description: test
      authorizations:
        - principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      registration_definition_name: def4

- name: Create Registration Definition with scope
  azure_rm_registrationdefinition:
    scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      description: test
      authorizations:
        - principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      registration_definition_name: def5

- name: Delete Registration Definition
  azure_rm_registrationdefinition:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    state: absent

返回值

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

Key

描述

state

complex

注册分配的状态信息。

返回： 始终

id

字符串

注册定义的完全限定路径。

返回： 始终

name

字符串

注册定义的名称。

返回： 始终

示例： "/subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

plan

complex

托管服务的计划详情。

返回： 始终

name

字符串

计划名称。

返回： 始终

product

字符串

产品代码。

返回： 始终

publisher

字符串

发布者 ID。

返回： 始终

version

字符串

计划的版本。

返回： 始终

properties

complex

注册定义的属性。

返回： 始终

authorizations

complex

授权元组，包含用户/安全组或服务主体的委托人 ID 以及内置角色的 ID。

返回： 始终

principal_id

字符串

将被分配对投影订阅的权限的安全组/服务主体/用户的委托人 ID

返回： 始终

示例： "99e3227f-8701-4099-869f-bc3efc7f1e64"

role_definition_id

字符串

角色定义标识符。

此角色将定义安全组/服务主体/用户必须在订阅上拥有的所有权限。

此角色不能是所有者角色。

返回： 始终

示例： "b24988ac-6180-42a0-ab88-20f7382dd24c"

description

字符串

注册定义的描述。

返回： 始终

示例： "test"

managed_by_tenant_id

字符串

managedBy 租户的 ID。

返回： 始终

registration_definition_name

字符串

注册定义的名称。

返回： 始终

type

字符串

资源的类型。

返回： 始终

示例： "Microsoft.ManagedServices/registrationDefinitions"

作者

  • Fred-Sun (@Fred-Sun)