azure.azcollection.azure_rm_virtualmachinescalesetextension 模块 – 管理 Azure 虚拟机规模集 (VMSS) 扩展

注意

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

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

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

要在剧本中使用它，请指定：azure.azcollection.azure_rm_virtualmachinescalesetextension。

azure.azcollection 0.1.2 中的新增功能

概要 

创建、更新和删除 Azure 虚拟机规模集 (VMSS) 扩展。

要求 

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

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"`
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"`
auto_upgrade_minor_version 布尔值	扩展处理程序是否应自动跨次要版本升级。选项 `false` `true`
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`
位置字符串	有效的 Azure 位置。默认为资源组的位置。
日志模式字符串	父参数。
日志路径字符串	父参数。
名称字符串 / 必填	VMSS 扩展的名称。
密码字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
受保护的设置字典	包含受保护的扩展设置的字典。设置取决于扩展类型。有关更多信息，请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview。
发布者字符串	扩展处理程序发布者的名称。
资源组字符串 / 必填	存在或将创建 VMSS 扩展的资源组的名称。
密钥字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
设置字典	包含扩展设置的字典。设置取决于扩展类型。有关更多信息，请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview。
状态字符串	声明扩展的状态。使用 `present` 创建或更新扩展，使用 `absent` 删除扩展。选项 `"不存在"` `"present"` ← (默认)
订阅 ID 字符串	您的 Azure 订阅 ID。
租户字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
指纹字符串添加到 azure.azcollection 1.14.0 中	在 x509_certificate_path 中指定的私钥的指纹。使用服务主体进行身份验证时使用。如果定义了 x509_certificate_path，则为必填。
类型字符串	扩展处理程序的类型。
类型处理程序版本字符串	扩展处理程序的类型版本。
VMSS 名称字符串 / 必填	应在其中创建或更新扩展的虚拟机的名称。
x509 证书路径路径添加到 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 和 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: Install VMSS Extension
  azure_rm_virtualmachinescalesetextension:
    name: myvmssextension
    location: eastus
    resource_group: myResourceGroup
    vmss_name: myvm
    publisher: Microsoft.Azure.Extensions
    type: CustomScript
    type_handler_version: 2.0
    settings: '{"commandToExecute": "hostname"}'
    auto_upgrade_minor_version: true

- name: Remove VMSS Extension
  azure_rm_virtualmachinescalesetextension:
    name: myvmssextension
    location: eastus
    resource_group: myResourceGroup
    vmss_name: myvm
    state: absent

返回值 

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

键	描述
ID 字符串	VMSS 扩展资源 ID。返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext"`

作者

Zim Kalinowski (@zikalino)