azure.azcollection.azure_rm_manageddisk_info 模块 – 获取托管磁盘信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取特定托管磁盘或所有托管磁盘的信息。

要求

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

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

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

字符串

将结果限制为由给定 VM fqid 管理的磁盘。

name

字符串

将结果限制为特定的托管磁盘。

password

字符串

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

profile

字符串

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

resource_group

字符串

将结果限制为特定的资源组。

如果设置了*name*，则为必需。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tags

列表 / 元素=字符串

通过提供标签列表来限制结果。

将标签格式化为“键”或“键：值”。

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 证书的路径。

证书必须附加到私钥。

在使用服务主体进行身份验证时使用。

备注

注意

  • 在 Ansible 2.8 之前，此模块称为azure.azcollection.azure_rm_managed_disk_facts。用法没有改变。

  • 对于 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: Get facts for one managed disk
  azure_rm_manageddisk_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all managed disks
  azure_rm_manageddisk_info:

- name: Get facts for all managed disks managed by a specific vm
  azure_rm_manageddisk_info:
    managed_by: '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/Microsoft.Compute/virtualMachines/vmName'

- name: Get facts by tags
  azure_rm_manageddisk_info:
    tags:
      - testing

返回值

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

键

描述

azure_managed_disk

列表 / 元素=字符串

托管磁盘字典列表。

返回：始终

create_option

字符串

磁盘的创建选项。

返回：成功

示例："copy"

disk_iops_read_only

整数

所有将共享磁盘作为只读方式挂载的 VM 允许的总吞吐量 (MBps)。

一次操作可以传输 4k 到 256k 字节。

返回：始终

示例：200

disk_iops_read_write

整数

此磁盘允许的 IOPS 数量。

仅适用于storage_account_type=UltraSSD_LRS 磁盘。

一次操作可以传输 4k 到 256k 字节。

返回：始终

示例：200

disk_m_bps_read_only

整数

所有将共享磁盘作为只读方式挂载的 VM 允许的总吞吐量 (MBps)。

MBps 表示每秒百万字节 - 此处的 MB 使用 ISO 表示法，即 10 的幂。

返回：始终

示例：30

disk_m_bps_read_write

整数

此磁盘允许的带宽。

仅适用于storage_account_type=UltraSSD_LRS 磁盘。

一次操作可以传输 4k 到 256k 字节。

返回：始终

示例：30

disk_size_gb

字符串

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

返回：成功

id

字符串

资源 ID。

返回：成功

location

字符串

有效的 Azure 位置。

返回：成功

managed_by

字符串

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

返回：成功

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

managed_by_extended

列表 / 元素=字符串

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

返回：成功

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

max_shares

整数

可以同时连接到磁盘的 VM 的最大数量。

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

返回：成功

示例：3

name

字符串

托管磁盘的名称。

返回：成功

os_type

字符串

操作系统的类型。

返回：成功

只能返回

  • "linux"

  • "windows"

source_uri

字符串

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

返回：成功

storage_account_type

字符串

托管磁盘的存储类型。

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

返回：成功

示例："Standard_LRS"

tags

字典

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

返回：成功

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

time_created

字符串

创建磁盘的时间。

返回：成功

示例："2018-01-01T11:08:15.338648900:00"

作者

  • Bruno Medina (@brusMX)

  • Paul Aiton (@paultaiton)