azure.azcollection.azure_rm_availabilityset 模块 – 管理 Azure 可用性集

注意

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

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

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

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

azure.azcollection 0.1.2 中新增

概要

  • 创建、更新和删除 Azure 可用性集。

  • 无法更新可用性集，您必须重新创建一个。

  • 唯一的更新操作是针对标签。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

string

Active Directory 用户名。 在使用 Active Directory 用户而非服务主体进行身份验证时使用。

adfs_authority_url

string

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。 在使用用户名/密码进行身份验证并且您有自己的 ADFS 授权时使用。

api_profile

string

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时要使用的 API 配置文件。 latest 的默认值适用于公共云； 将来的值允许与 Azure Stack 一起使用。

默认： "latest"

append_tags

boolean

用于控制 tags 字段是规范还是仅附加到现有标签。

当为规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。

选项

  • false

  • true ←（默认）

auth_source

string

在 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

string

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都会验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量进行设置。

选项

  • "ignore"

  • "validate"

client_id

string

Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量进行设置。

cloud_environment

string

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，使用环境名称（由 Azure Python SDK 定义，例如， AzureChinaCloud， AzureUSGovernment），或者元数据发现端点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量进行设置。

默认值: "AzureCloud"

disable_instance_discovery

boolean

在 azure.azcollection 2.3.0 中添加

确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此项设置为 **True**，将禁用授权验证。因此，务必确保配置的授权主机有效且可信。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量进行设置。

选项

  • false ← (默认)

  • true

location

string

有效的 Azure 位置。默认为资源组的位置。

log_mode

string

父参数。

log_path

string

父参数。

name

string / 必需

可用性集的名称。

password

string

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

platform_fault_domain_count

integer

容错域定义了共享通用电源和网络交换机的虚拟机组。

应介于 1 和 3 之间。

默认值: 3

platform_update_domain_count

integer

更新域指示可以同时重新启动的虚拟机和底层物理硬件组。

默认值: 5

profile

string

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

proximity_placement_group

string

应分配可用性集的邻近放置组。

resource_group

string / 必需

可用性集存在或将被创建的资源组的名称。

secret

string

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

sku

string

定义可用性集是否支持托管磁盘。

选项

  • "Classic" ← (默认)

  • "Aligned"

state

string

断言可用性集的状态。

使用 present 创建或更新可用性集，使用 absent 删除可用性集。

选项

  • "absent"

  • "present" ← (默认)

subscription_id

string

您的 Azure 订阅 ID。

tags

dictionary

要作为元数据分配给对象的字符串:字符串对的字典。

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

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

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

Azure Front Door 不支持使用

Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。

tenant

string

Azure 租户 ID。当使用服务主体进行身份验证时使用。

thumbprint

string

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

  • 也可以使用服务主体或 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 an availability set with default options
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup

- name: Create an availability set with advanced options
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup
    platform_update_domain_count: 5
    platform_fault_domain_count: 3
    proximity_placement_group: myProximityPlacementGroup
    sku: Aligned

- name: Delete an availability set
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup
    state: absent

返回值

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

键

描述

changed

boolean

资源是否已更改

返回值： 总是

示例： true

state

complex

可用性集的当前状态。

返回值： 总是

id

string

资源 ID。

返回值： 成功

示例： "/subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/availabilitySets/myavailabilityset2"

location

string

资源所在的位置。

返回值： 成功

示例： "eastus"

name

string

资源名称。

返回值： 成功

示例： "myavailabilityset2"

platform_fault_domain_count

integer

容错域值。

返回值： 成功

示例： 2

platform_update_domain_count

integer

更新域值。

返回值： 成功

示例： 5

proximity_placement_group

string

可用性分配到的邻近放置组。

返回值： 成功

示例： "myProximityPlacementGroup"

sku

string

可用性集支持托管磁盘。

返回值： 成功

示例： "Aligned"

tags

dictionary

资源标签。

返回值： 成功

示例： {"env": "sandbox"}

作者

  • Julien Stroheker (@julienstroheker)