azure.azcollection.azure_rm_resource 模块 – 创建任何 Azure 资源

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

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

azure.azcollection 0.1.2 中的新增功能

概要

• 使用 Azure REST API 创建、更新或删除任何 Azure 资源。

• 此模块提供对 Ansible 模块不支持的资源的访问。

• 有关特定资源 REST API 的详细信息，请参阅 https://docs.microsoft.com/en-us/rest/api/。

要求

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

• python >= 2.7

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

• 必须通过 pip 在执行来自 azure.azcollection 模块的主机上安装集合的 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"
api_version 字符串	要使用的特定 API 版本。
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"
body 任意	发送到 Web 服务的 HTTP 请求/响应的正文。
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
幂等性 布尔值	如果启用，将首先使用 method=GET 进行幂等性检查，然后与 body 进行比较。 选择 false ← (默认) true
log_mode 字符串	父参数。
log_path 字符串	父参数。
method 字符串	请求或响应的 HTTP 方法。必须为大写。 选择 "GET" "PUT" ← (默认) "POST" "HEAD" "PATCH" "DELETE" "MERGE"
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
polling_interval 整数	如果启用，将首先使用 method=GET 进行幂等性检查，然后与 body 进行比较。 默认值: 60
polling_timeout 整数	如果启用，将首先使用 method=GET 进行幂等性检查，然后与 body 进行比较。 默认值: 0
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
provider 字符串	提供程序类型。 如果未指定 URL，则为必填项。
resource_group 字符串	要使用的资源组。 如果未指定 URL，则为必填项。
resource_name 字符串	资源名称。 如果未指定 URL，则为必填项。
resource_type 字符串	资源类型。 如果未指定 URL，则为必填项。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	断言资源的状态。使用 present 创建或更新资源，或使用 absent 删除资源。 选择 "absent" "present" ← (默认)
status_code 列表 / 元素=整数	一个有效的、数字的 HTTP 状态代码，表示请求成功。也可以是逗号分隔的状态代码列表。 默认值: [200, 201, 202]
subresource 列表 / 元素=字典	子资源列表。 默认值: []
name 字符串	子资源名称。
namespace 字符串	子资源命名空间。
type 字符串	子资源类型。
subscription_id 字符串	您的 Azure 订阅 ID。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必填项。
url 字符串	Azure RM 资源 URL。
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 中。这是一个 ini 文件，包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant，或者 subscription_id、ad_user 和 password。还可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Update scaleset info using azure_rm_resource
  azure_rm_resource:
    resource_group: myResourceGroup
    provider: compute
    resource_type: virtualmachinescalesets
    resource_name: myVmss
    api_version: "2017-12-01"
    body: { body }

返回值

通用返回值记录在 此处，以下是此模块特有的字段

键	描述
response 复杂类型	特定于资源类型的响应。 返回: 总是
id 字符串	资源 ID。 返回: 总是 示例: "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Storage/storageAccounts/staccb57dc95183"
kind 字符串	存储的种类。 返回: 总是 示例: "Storage"
location 字符串	资源位置，默认为资源组的位置。 返回: 总是 示例: "eastus"
name 字符串	存储帐户名称。 返回: 总是 示例: "staccb57dc95183"
properties 字典	存储帐户的相关属性。 返回: 总是 示例: {"creationTime": "2019-06-13T06:34:33.0996676Z", "encryption": {"keySource": "Microsoft.Storage", "services": {"blob": {"enabled": true, "lastEnabledTime": "2019-06-13T06:34:33.1934074Z"}, "file": {"enabled": true, "lastEnabledTime": "2019-06-13T06:34:33.1934074Z"}}}, "networkAcls": {"bypass": "AzureServices", "defaultAction": "Allow", "ipRules": [], "virtualNetworkRules": []}, "primaryEndpoints": {"blob": "https://staccb57dc95183.blob.core.windows.net/", "file": "https://staccb57dc95183.file.core.windows.net/", "queue": "https://staccb57dc95183.queue.core.windows.net/", "table": "https://staccb57dc95183.table.core.windows.net/"}, "primaryLocation": "eastus", "provisioningState": "Succeeded", "secondaryLocation": "westus", "statusOfPrimary": "available", "statusOfSecondary": "available", "supportsHttpsTrafficOnly": false}
sku 字典	存储帐户 SKU。 返回: 总是 示例: {"name": "Standard_GRS", "tier": "Standard"}
tags 字典	资源标签。 返回: 总是 示例: {"key1": "value1"}
type 字符串	资源类型。 返回: 总是 示例: "Microsoft.Storage/storageAccounts"

作者

• Zim Kalinowski (@zikalino)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)