azure.azcollection.azure_rm_manageddisk module – Manage Azure Manage Disks
Note
This module is part of the azure.azcollection collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_manageddisk.
New in azure.azcollection 0.1.2
Synopsis
Create, update and delete an Azure Managed Disk.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object’s metadata. Choices:
|
|
Disk caching policy controlled by VM. Will be used when attached to the VM defined by If this option is different from the current caching policy, the managed disk will be deattached and attached with current caching option again. Choices:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Choices:
|
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. |
|
The number of IOPS allowed for this disk. Only settable for storage_account_type=UltraSSD_LRS disks. One operation can transfer between 4k and 256k bytes. |
|
The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. |
|
The bandwidth allowed for this disk. Only settable for storage_account_type=UltraSSD_LRS disks. One operation can transfer between 4k and 256k bytes. |
|
Size in GB of the managed disk to be created. If create_option=copy then the value must be greater than or equal to the source’s size. |
|
Valid Azure location. Defaults to location of the resource group. |
|
Parent argument. |
|
Parent argument. |
|
The logical unit number for data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. |
|
Name of an existing virtual machine with which the disk is or will be associated, this VM should be in the same resource group. To detach a disk from a vm, explicitly set to ‘’. If this option is unset, the value will not be changed. |
|
List of name and resource group of the VMs that have the disk attached. max_shares should be set to a value greater than one for disks to allow attaching them to multiple VMs. |
|
The name of the attache VM. |
|
The resource group of the attache VM. |
|
The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. |
|
Name of the managed disk. |
|
Type of Operating System. Used when create_option=copy or create_option=import and the source is an OS disk. If omitted during creation, no value is set. If omitted during an update, no change is made. Once set, this value cannot be cleared. Choices:
|
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of a resource group where the managed disk exists or will be created. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
URI to a valid VHD file to be used or the resource ID of the managed disk to copy. |
|
Assert the state of the managed disk. Use Choices:
|
|
The full path to the storage account the image is to be imported from. Required when create_option=import. |
|
Type of storage for the managed disk. If not specified, the disk is created as
See https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types for more information about disk types. Choices:
|
|
Your Azure subscription Id. |
|
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag. Azure Front Door doesn’t support the use of Azure Automation and Azure CDN only support 15 tags on resources. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal. |
|
The Azure managed disk’s zone. Allowed values are Choices:
|
Notes
Note
This module was called azure.azcollection.azure_rm_managed_disk before Ansible 2.8. The usage did not change.
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Whether or not the resource has changed. Returned: always |
|
Current state of the managed disk. Returned: always |
|
Create option of the disk. Returned: success Sample: |
|
The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. Returned: always Sample: |
|
The number of IOPS allowed for this disk. Only settable for storage_account_type=UltraSSD_LRS disks. One operation can transfer between 4k and 256k bytes. Returned: always Sample: |
|
The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. Returned: always Sample: |
|
The bandwidth allowed for this disk. Only settable for storage_account_type=UltraSSD_LRS disks. One operation can transfer between 4k and 256k bytes. Returned: always Sample: |
|
Size in GB of the managed disk to be created. Returned: success |
|
Resource id. Returned: success |
|
Valid Azure location. Returned: success |
|
Name of an existing virtual machine with which the disk is or will be associated, this VM should be in the same resource group. Returned: success |
|
List ID of an existing virtual machine with which the disk is or will be associated. Returned: success Sample: |
|
The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. Returned: success Sample: |
|
Name of the managed disk. Returned: success |
|
Type of Operating System. Returned: success Sample: |
|
URI to a valid VHD file to be used or the resource ID of the managed disk to copy. Returned: success |
|
The full path to the storage account the image is to be imported from Returned: success Sample: |
|
Type of storage for the managed disk. See https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types for more information about this type. Returned: success Sample: |
|
Tags to assign to the managed disk. Returned: success Sample: |