azure.azcollection.azure_rm_manageddisk 模块 – 管理 Azure 托管磁盘
注意
此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_manageddisk。
azure.azcollection 0.1.2 中的新增功能
概要
创建、更新和删除 Azure 托管磁盘。
要求
执行此模块的主机需要以下要求。
python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
集合的 requirements.txt 中列出的所有 python 包必须通过 pip 安装在执行 azure.azcollection 集合中模块的主机上
完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。使用此用户名而不是服务主体进行身份验证。 |
|
Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时使用的 API 配置文件。 默认值： |
|
用于控制标签字段是规范的还是仅追加到现有标签。 如果为规范，则参数中找不到的任何标签都将从对象的元数据中删除。 选项
|
|
由 VM 控制的磁盘缓存策略。将在附加到由 如果此选项与当前缓存策略不同，则托管磁盘将被分离并再次使用当前缓存选项附加。 选项
|
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为 Ansible 2.6 中添加了 选项
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。使用服务主体或托管身份 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 默认值： |
|
从 *source_uri* 中的 VHD 文件 选项
|
|
确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索权限元数据以验证权限。将其设置为 **True** 将禁用权限的验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 选项
|
|
所有以只读方式挂载共享磁盘的 VM 允许的总吞吐量 (MBps)。 一次操作可以传输 4k 到 256k 字节。 |
|
此磁盘允许的 IOPS 数。 仅可为 *storage_account_type=UltraSSD_LRS* 磁盘设置。 一次操作可以传输 4k 到 256k 字节。 |
|
所有以只读方式挂载共享磁盘的 VM 允许的总吞吐量 (MBps)。 MBps 表示每秒百万字节 - 此处的 MB 使用 ISO 表示法，即 10 的幂。 |
|
此磁盘允许的带宽。 仅可为 *storage_account_type=UltraSSD_LRS* 磁盘设置。 一次操作可以传输 4k 到 256k 字节。 |
|
要创建的托管磁盘的大小（以 GB 为单位）。 如果 *create_option=copy*，则该值必须大于或等于源的大小。 |
|
有效的 Azure 位置。默认为资源组的位置。 |
|
父参数。 |
|
父参数。 |
|
数据磁盘的逻辑单元号。 此值用于标识 VM 中的数据磁盘，因此必须对附加到 VM 的每个数据磁盘唯一。 |
|
与磁盘关联或将要关联的现有虚拟机的名称，此 VM 应位于同一资源组中。 要将磁盘从 VM 分离，请显式设置为 ‘’。 如果未设置此选项，则该值将不会更改。 |
|
已附加磁盘的 VM 的名称和资源组列表。 对于允许将磁盘附加到多个 VM 的磁盘，应将 *max_shares* 设置为大于 1 的值。 |
|
附加 VM 的名称。 |
|
附加 VM 的资源组。 |
|
可以同时附加到磁盘的 VM 的最大数量。 大于 1 的值表示可以同时安装在多个 VM 上的磁盘。 |
|
托管磁盘的名称。 |
|
操作系统的类型。 当 *create_option=copy* 或 *create_option=import* 且源是操作系统磁盘时使用。 创建时如果省略，则不设置任何值。 更新时如果省略，则不进行任何更改。 设置后，此值无法清除。 选项
|
|
Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
托管磁盘存在或将要创建的资源组的名称。 |
|
Azure 客户端密钥。使用服务主体进行身份验证时使用。 |
|
要使用的有效 VHD 文件的 URI 或要复制的托管磁盘的资源 ID。 |
|
断言托管磁盘的状态。使用 选项
|
|
要从中导入映像的存储帐户的完整路径。 *create_option=import* 时必需。 |
|
托管磁盘的存储类型。 如果未指定，则磁盘将创建为
有关磁盘类型的更多信息，请参阅 https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types。 选项
|
|
您的 Azure 订阅 ID。 |
|
要作为元数据分配给对象的字符串：字符串对的字典。 对象的元数据标签将使用任何提供的数值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。 |
|
Azure 租户 ID。使用服务主体进行身份验证时使用。 |
|
*x509_certificate_path* 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则必需。 |
|
用于创建 PEM 格式的服务主体的 X509 证书的路径。 证书必须附加到私钥。 使用服务主体进行身份验证时使用。 |
|
Azure 托管磁盘的区域。 允许的值为 选项
|
备注
注意
在 Ansible 2.8 之前，此模块称为 azure.azcollection.azure_rm_managed_disk。用法没有改变。
对于使用 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 disk
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
- name: Create managed operating system disk from page blob
azure_rm_manageddisk:
name: mymanageddisk
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: Mount the managed disk to VM
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
disk_size_gb: 4
managed_by: testvm001
attach_caching: read_only
- name: Mount the managed disk to multiple VMs
azure_rm_manageddisk:
resource_group: myResourceGroup
name: freddisk04
max_shares: 4
disk_size_gb: 1024
storage_account_type: Premium_LRS
managed_by_extended:
- resource_group: myResourceGroup01
name: testVM01
- resource_group: myResourceGroup02
name: testVM02
zone: 1
- name: Unmount the managed disk to VM
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
managed_by: ''
disk_size_gb: 4
- name: Delete managed disk
azure_rm_manageddisk:
name: mymanageddisk
location: eastus
resource_group: myResourceGroup
state: absent
返回值
常用返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源是否已更改。 返回：始终 |
|
托管磁盘的当前状态。 返回：始终 |
|
磁盘的创建选项。 返回：成功 示例： |
|
所有以只读方式挂载共享磁盘的 VM 允许的总吞吐量 (MBps)。 一次操作可以传输 4k 到 256k 字节。 返回：始终 示例： |
|
此磁盘允许的 IOPS 数。 仅可为 *storage_account_type=UltraSSD_LRS* 磁盘设置。 一次操作可以传输 4k 到 256k 字节。 返回：始终 示例： |
|
所有以只读方式挂载共享磁盘的 VM 允许的总吞吐量 (MBps)。 MBps 表示每秒百万字节 - 此处的 MB 使用 ISO 表示法，即 10 的幂。 返回：始终 示例： |
|
此磁盘允许的带宽。 仅可为 *storage_account_type=UltraSSD_LRS* 磁盘设置。 一次操作可以传输 4k 到 256k 字节。 返回：始终 示例： |
|
要创建的托管磁盘的大小（以 GB 为单位）。 返回：成功 |
|
资源 ID。 返回：成功 |
|
有效的 Azure 位置。 返回：成功 |
|
与磁盘关联或将要关联的现有虚拟机的名称，此 VM 应位于同一资源组中。 返回：成功 |
|
与磁盘关联或将要关联的现有虚拟机的列表 ID。 返回：成功 示例： |
|
可以同时附加到磁盘的 VM 的最大数量。 大于 1 的值表示可以同时安装在多个 VM 上的磁盘。 返回：成功 示例： |
|
托管磁盘的名称。 返回：成功 |
|
操作系统的类型。 返回：成功 示例： |
|
要使用的有效 VHD 文件的 URI 或要复制的托管磁盘的资源 ID。 返回：成功 |
|
要从中导入映像的存储帐户的完整路径 返回：成功 示例： |
|
托管磁盘的存储类型。 更多信息，请参见 https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types。 返回：成功 示例： |
|
分配给托管磁盘的标签。 返回：成功 示例： |