azure.azcollection.azure_rm_multiplemanageddisks 模块 – 管理多个 Azure 托管磁盘

注意

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

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

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

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

azure.azcollection 1.14.0 中的新增功能

概要

  • 创建、更新和删除一个或多个 Azure 托管磁盘。

  • 此模块也可用于将磁盘附加到一个或多个虚拟机或从中分离磁盘。

要求

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

  • 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

布尔值

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

如果规范，则标签参数中找不到的任何标签都将从对象的元数据中删除。

选项

  • 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

字符串

父参数。

managed_by_extended

列表 / 元素=字典

要管理其磁盘的 VM 的名称和资源组列表。

当state=present时，磁盘将附加到指定的 VM 列表。

当state=present时，使用[]从所有 VM 中分离磁盘。

当state=absent且此参数已定义时，磁盘将从 VM 列表中分离。

当state=absent且此参数未定义时，磁盘将被删除。

name

字符串

附加的 VM 的名称。

resource_group

字符串

附加的 VM 的资源组。

managed_disks

列表 / 元素=字典

要创建、更新或删除的托管磁盘列表。

attach_caching

字符串

由 VM 控制的磁盘缓存策略。在附加到由managed_by定义的 VM 时将使用。

如果此选项与当前缓存策略不同，则托管磁盘将被分离并再次使用当前缓存选项附加。

选项

  • ""

  • "read_only"

  • "read_write"

create_option

字符串

从source_uri中的 VHD 文件import导入，并从之前的托管磁盘source_uricopy复制。

选项

  • "empty"

  • "import"

  • "copy"

disk_size_gb

整数

要创建的托管磁盘的大小（以 GB 为单位）。

当create_option=empty时必填。

如果create_option=copy，则该值必须大于或等于源的大小。

location

字符串

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

lun

整数

数据磁盘的逻辑单元号。

此值用于标识 VM 中的数据磁盘，因此必须为附加到 VM 的每个数据磁盘唯一。

max_shares

整数

可以同时附加到磁盘的 VM 的最大数量。

大于 1 的值表示可以同时安装在多个 VM 上的磁盘。

name

字符串 / 必填

托管磁盘的名称。

os_type

字符串

操作系统的类型。

当create_option=copy或create_option=import且源是操作系统磁盘时使用。

创建时如果省略，则不设置任何值。

更新时如果省略，则不进行任何更改。

设置后，此值无法清除。

选项

  • "linux"

  • "windows"

resource_group

字符串 / 必填

托管磁盘存在或将要创建的资源组的名称。

source_uri

别名：source_resource_uri

字符串

要使用的有效 VHD 文件的 URI 或要复制的托管磁盘的资源 ID。

当create_option=import或create_option=copy时必填。

storage_account_id

字符串

要从中导入映像的存储帐户的完整路径。

当create_option=import时必填。

storage_account_type

字符串

托管磁盘的存储类型。

如果未指定，则磁盘将创建为Standard_LRS。

Standard_LRS适用于标准 HDD。

StandardSSD_LRS（在 2.8 中添加）适用于标准 SSD。

StandardSSD_ZRS适用于标准 SSD 区域冗余。

Premium_LRS适用于高级 SSD。

Premium_ZRS适用于高级 SSD 区域冗余。

UltraSSD_LRS（在 2.8 中添加）适用于 Ultra SSD，仅在某些实例类型上可用。

有关磁盘类型的更多信息，请参阅https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types。

选项

  • "Standard_LRS"

  • "StandardSSD_LRS"

  • "StandardSSD_ZRS"

  • "Premium_LRS"

  • "Premium_ZRS"

  • "UltraSSD_LRS"

zone

字符串

Azure 托管磁盘的区域。

允许的值为1，2，3和''。

选项

  • "1"

  • "2"

  • "3"

  • ""

password

字符串

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

profile

字符串

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

secret

字符串

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

state

字符串

声明托管磁盘的状态。

使用present创建或更新托管磁盘和/或根据managed_by_extended中指定的值将托管磁盘附加/分离到 VM 列表。

使用absent根据managed_by_extended中指定的值分离/删除托管磁盘。

选项

  • "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，则必填。

x509_certificate_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 和 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 managed operating system disks from page blob and attach them to a list of VMs
  azure_rm_multiplemanageddisks:
    managed_disks:
      - name: mymanageddisk1
        location: eastus2
        resource_group: myResourceGroup
        create_option: import
        source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
        storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
        os_type: windows
        storage_account_type: Premium_LRS
      - name: mymanageddisk2
        location: eastus2
        resource_group: myResourceGroup
        create_option: import
        source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
        storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
        os_type: windows
        storage_account_type: Premium_LRS
    managed_by_extended:
      - resource_group: myResourceGroupTest
        name: TestVM

- name: Detach disks from the VMs specified in the list
  azure_rm_multiplemanageddisks:
    state: absent
    managed_disks:
      - name: mymanageddisk1
        location: eastus2
        resource_group: myResourceGroup
        create_option: import
        source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
        storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
        os_type: windows
        storage_account_type: Premium_LRS
      - name: mymanageddisk2
        location: eastus2
        resource_group: myResourceGroup
        create_option: import
        source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
        storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
        os_type: windows
        storage_account_type: Premium_LRS
    managed_by_extended:
      - resource_group: myResourceGroupTest
        name: TestVM1
      - resource_group: myResourceGroupTest
        name: TestVM2

- name: Detach managed disks from all VMs without deletion
  azure_rm_multiplemanageddisks:
    state: present
    managed_disks:
      - name: mymanageddisk1
        location: eastus2
        resource_group: myResourceGroup
      - name: mymanageddisk2
        location: eastus2
        resource_group: myResourceGroup
    managed_by_extended: []

- name: Detach managed disks from all VMs and delete them
  azure_rm_multiplemanageddisks:
    state: absent
    managed_disks:
      - name: mymanageddisk1
        location: eastus2
        resource_group: myResourceGroup
      - name: mymanageddisk2
        location: eastus2
        resource_group: myResourceGroup

返回值

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

Key

描述

state

复杂类型

托管磁盘的当前状态。

返回：始终

create_option

字符串

磁盘的创建选项。

返回：成功

示例："copy"

disk_size_gb

字符串

要创建的托管磁盘的大小（以 GB 为单位）。

返回：成功

id

字符串

资源 ID。

返回：成功

location

字符串

有效的 Azure 位置。

返回：成功

managed_by

字符串

与磁盘关联或将要关联的现有虚拟机的名称，此 VM 应位于同一资源组中。

返回：成功

managed_by_extended

列表 / 元素=字符串

与磁盘关联或将要关联的现有虚拟机的列表 ID。

返回：成功

示例：["/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM"]

max_shares

整数

可以同时附加到磁盘的 VM 的最大数量。

大于 1 的值表示可以同时安装在多个 VM 上的磁盘。

返回：成功

示例：3

name

字符串

托管磁盘的名称。

返回：成功

os_type

字符串

操作系统的类型。

返回：成功

示例："linux"

source_uri

字符串

要使用的有效 VHD 文件的 URI 或要复制的托管磁盘的资源 ID。

返回：成功

storage_account_id

字符串

要从中导入映像的存储帐户的完整路径

返回：成功

示例："/subscriptions/<uuid>/resourceGroups/<resource group name>/providers/Microsoft.Storage/storageAccounts/<storage account name>"

storage_account_type

字符串

托管磁盘的存储类型。

有关此类型的更多信息，请参阅https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types。

返回：成功

示例："Standard_LRS"

tags

字典

要分配给托管磁盘的标签。

返回：成功

示例：{"tag": "value"}

作者

  • Aubin Bikouo (@abikouo)