Documentation

azure_rm_managed_disk - Manage Azure Manage Disks

New in version 2.4.

Synopsis

  • Create, update and delete an Azure Managed Disk

Requirements (on host that executes module)

  • python >= 2.7
  • azure >= 2.0.0

Options

parameter required default choices comments
ad_user
no
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
append_tags
no True
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.
client_id
no
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
no 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
no
  • empty
  • import
  • copy
Allowed values: empty, import, copy. 'import' from a VHD file in 'source_uri' and 'copy' from previous managed disk 'source_resource_uri'.
disk_size_gb
yes
-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
no resource_group location
Valid Azure location. Defaults to location of the resource group.
name
yes
Name of the managed disk
os_type
no
  • 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.
password
no
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
no
Security profile found in ~/.azure/credentials file.
resource_group
yes
Name of a resource group where the managed disk exists or will be created.
secret
no
Azure client secret. Use when authenticating with a Service Principal.
source_resource_uri
no
The resource ID of the managed disk to copy when 'create_option' is 'copy'.
source_uri
no
URI to a valid VHD file to be used when 'create_option' is 'import'.
state
no present
  • 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
no
  • Standard_LRS
  • Premium_LRS
Type of storage for the managed disk: 'Standard_LRS' or 'Premium_LRS'. If not specified the disk is created 'Standard_LRS'
subscription_id
no
Your Azure subscription Id.
tags
no
Tags to assign to the managed disk.
tenant
no
Azure tenant ID. Use when authenticating with a Service Principal.

Examples

- name: Create managed disk
  azure_rm_managed_disk:
    name: mymanageddisk
    location: eastus
    resource_group: Testing
    disk_size_gb: 4

- name: Delete managed disk
  azure_rm_manage_disk:
    name: mymanageddisk
    location: eastus
    resource_group: Testing
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
state
Current state of the managed disk
always dict
changed
Whether or not the resource has changed
always bool
id
The managed disk resource ID.
always dict


Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.