azure.azcollection.azure_rm_manageddisk module – Manage Azure Manage Disks

Note

This module is part of the azure.azcollection collection (version 1.14.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-azure.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

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

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:

  • false

  • true ← (default)

attach_caching

string

Disk caching policy controlled by VM. Will be used when attached to the VM defined by managed_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:

  • ""

  • "read_only"

  • "read_write"

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

create_option

string

import from a VHD file in source_uri and copy from previous managed disk source_uri.

Choices:

  • "empty"

  • "import"

  • "copy"

disk_size_gb

string

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.

location

string

Valid Azure location. Defaults to location of the resource group.

log_mode

string

Parent argument.

log_path

string

Parent argument.

lun

integer

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.

managed_by

string

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.

managed_by_extended

list / elements=dictionary

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.

name

string

The name of the attache VM.

resource_group

string

The resource group of the attache VM.

max_shares

integer

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

string / required

Name of the managed disk.

os_type

string

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:

  • "linux"

  • "windows"

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

Name of a resource group where the managed disk exists or will be created.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

source_uri

aliases: source_resource_uri

string

URI to a valid VHD file to be used or the resource ID of the managed disk to copy.

state

string

Assert the state of the managed disk. Use present to create or update a managed disk and absent to delete a managed disk.

Choices:

  • "absent"

  • "present" ← (default)

storage_account_id

string

The full path to the storage account the image is to be imported from.

Required when create_option=import.

storage_account_type

string

Type of storage for the managed disk.

If not specified, the disk is created as Standard_LRS.

Standard_LRS is for Standard HDD.

StandardSSD_LRS (added in 2.8) is for Standard SSD.

StandardSSD_ZRS is for Standard SSD Zone-redundant.

Premium_LRS is for Premium SSD.

Premium_ZRS is for Premium SSD Zone-redundant.

UltraSSD_LRS (added in 2.8) is for Ultra SSD, which is only available on select instance types.

See https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types for more information about disk types.

Choices:

  • "Standard_LRS"

  • "StandardSSD_LRS"

  • "StandardSSD_ZRS"

  • "Premium_LRS"

  • "Premium_ZRS"

  • "UltraSSD_LRS"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

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.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

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.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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.

zone

string

The Azure managed disk’s zone.

Allowed values are 1, 2, 3 and ' '.

Choices:

  • 1

  • 2

  • 3

  • ""

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 login command.

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

changed

boolean

Whether or not the resource has changed.

Returned: always

state

complex

Current state of the managed disk.

Returned: always

create_option

string

Create option of the disk.

Returned: success

Sample: "copy"

disk_size_gb

string

Size in GB of the managed disk to be created.

Returned: success

id

string

Resource id.

Returned: success

location

string

Valid Azure location.

Returned: success

managed_by

string

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

managed_by_extended

list / elements=string

List ID of an existing virtual machine with which the disk is or will be associated.

Returned: success

Sample: ["/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM"]

max_shares

integer

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: 3

name

string

Name of the managed disk.

Returned: success

os_type

string

Type of Operating System.

Returned: success

Sample: "linux"

source_uri

string

URI to a valid VHD file to be used or the resource ID of the managed disk to copy.

Returned: success

storage_account_id

string

The full path to the storage account the image is to be imported from

Returned: success

Sample: "/subscriptions/<uuid>/resourceGroups/<resource group name>/providers/Microsoft.Storage/storageAccounts/<storage account name>"

storage_account_type

string

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: "Standard_LRS"

tags

dictionary

Tags to assign to the managed disk.

Returned: success

Sample: {"tag": "value"}

Authors

  • Bruno Medina (@brusMX)