azure_rm_manageddisk – Manage Azure Manage Disks

From Get docs
Ansible/docs/2.8/modules/azure rm manageddisk module


azure_rm_manageddisk – Manage Azure Manage Disks

New in version 2.4.


Synopsis

  • Create, update and delete an Azure Managed Disk

Aliases: azure_rm_managed_disk

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults 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 2.6

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

api_profile

string

added in 2.5

Default:

"latest"

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.

append_tags

boolean

  • no
  • yes

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.

attach_caching

-

added in 2.8

  • read_only
  • read_write

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 from the VM and attached with current caching option again.

Allowed values: , read_only, read_write.

auth_source

string

added in 2.5

  • auto
  • cli
  • credential_file
  • env
  • msi

Controls the source of the credentials to use for authentication.

If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.

auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.

When set to cli, the credentials will be sources from the default Azure CLI profile.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

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.

cert_validation_mode

string

added in 2.5

  • ignore
  • validate

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.

client_id

string

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

cloud_environment

string

added in 2.4

Default:

"AzureCloud"

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.

create_option

-

  • empty
  • import
  • copy

Allowed values: empty, import, copy. - import from a VHD file in source_uri and copy from previous managed disk source_uri.

disk_size_gb

-

Size in GB of the managed disk to be created.

If create_option is copy then the value must be greater than or equal to the source's size.

location

-

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

managed_by

-

added in 2.5

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.

name

- / required

Name of the managed disk.

os_type

-

  • linux
  • windows

Type of Operating System: linux or windows.

Used when create_option is either copy or 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.

password

-

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

- / 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

-

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


aliases: source_resource_uri

state

-

  • absent
  • present

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

storage_account_type

-

  • Standard_LRS
  • StandardSSD_LRS
  • Premium_LRS
  • UltraSSD_LRS

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.

Premium_LRS is for Premium SSD.

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

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Tags to assign to the managed disk.

tenant

string

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

zone

-

added in 2.8

  • 1
  • 2
  • 3

Allowed values: 1, 2, 3, .



Notes

Note

  • This module was called 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
    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: Unmount the managed disk to VM
  azure_rm_manageddisk:
    name: mymanageddisk
    location: eastus
    resource_group: myResourceGroup
    disk_size_gb: 4

- name: Delete managed disk
  azure_rm_manage_disk:
    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 Returned Description

changed

boolean

always

Whether or not the resource has changed


id

dictionary

always

The managed disk resource ID.


state

dictionary

always

Current state of the managed disk





Status

Authors

  • Bruno Medina (@brusMX)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_manageddisk_module.html