New in version 2.4.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| ad_user |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
|
|
|
adfs_authority_url
(added in 2.6) |
Default: null
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
|
api_profile
(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
bool |
|
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.
|
|
auth_source
(added in 2.5) |
|
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
(added in 2.5) |
|
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 |
Azure client ID. Use when authenticating with a Service Principal.
|
|
|
cloud_environment
(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 |
|
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 |
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, keep undefined.
|
|
|
name
required |
Name of the managed disk.
|
|
| os_type |
|
Type of Operating System:
linux or windows. Used when create_option is either copy or import and the source is an OS disk. |
| password |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
|
| profile |
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 |
Azure client secret. Use when authenticating with a Service Principal.
|
|
| source_resource_uri |
The resource ID of the managed disk to copy when create_option is
copy. |
|
| source_uri |
URI to a valid VHD file to be used when create_option is
import. |
|
| state |
|
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 |
|
Type of storage for the managed disk:
Standard_LRS or Premium_LRS. If not specified the disk is created Standard_LRS. |
| subscription_id |
Your Azure subscription Id.
|
|
| tags |
Tags to assign to the managed disk.
|
|
| tenant |
Azure tenant ID. Use when authenticating with a Service Principal.
|
Note
- name: Create managed disk
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
disk_size_gb: 4
- name: Mount the managed disk to VM
azure_rm_managed_disk:
name: mymanageddisk
location: eastus
resource_group: Testing
disk_size_gb: 4
managed_by: testvm001
- name: Unmount the managed disk to VM
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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
changed
bool
|
always |
Whether or not the resource has changed
|
|
id
dict
|
always |
The managed disk resource ID.
|
|
state
dict
|
always |
Current state of the managed disk
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.