Try SpotterManage Multiple Azure Manage Disks
| "added in version" 1.14.0 of azure.azcollection"
Authors: Aubin Bikouo (@abikouo)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete one or more Azure Managed Disk.
This module can be used also to attach/detach disks to/from one or more virtual machines.
- name: Create managed operating system disks from page blob and attach them to a list of VMs
azure_rm_multiplemanageddisks:
managed_disks:
- name: mymanageddisk1
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: mymanageddisk2
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
managed_by_extended:
- resource_group: myResourceGroupTest
name: TestVM
- name: Detach disks from the VMs specified in the list
azure_rm_multiplemanageddisks:
state: absent
managed_disks:
- name: mymanageddisk1
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: mymanageddisk2
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
managed_by_extended:
- resource_group: myResourceGroupTest
name: TestVM1
- resource_group: myResourceGroupTest
name: TestVM2
- name: Detach managed disks from all VMs without deletion
azure_rm_multiplemanageddisks:
state: present
managed_disks:
- name: mymanageddisk1
location: eastus2
resource_group: myResourceGroup
- name: mymanageddisk2
location: eastus2
resource_group: myResourceGroup
managed_by_extended: []
- name: Detach managed disks from all VMs and delete them
azure_rm_multiplemanageddisks:
state: absent
managed_disks:
- name: mymanageddisk1
location: eastus2
resource_group: myResourceGroup
- name: mymanageddisk2
location: eastus2
resource_group: myResourceGroup
tags:
description:
- 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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the managed disks.
- Use C(present) to create or update managed disks and/or attach/detach managed disks
to a list of VMs depending on the value specified in I(managed_by_extended).
- Use C(absent) to detach/delete managed disks depending on the value specified in
I(managed_by_extended).
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- 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.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
managed_disks:
description:
- List of managed disks to create, update, or delete.
elements: dict
suboptions:
attach_caching:
choices:
- ''
- read_only
- read_write
description:
- Disk caching policy controlled by VM. Will be used when attached to the VM defined
by C(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.
type: str
create_option:
choices:
- empty
- import
- copy
description:
- C(import) from a VHD file in I(source_uri) and C(copy) from previous managed
disk I(source_uri).
type: str
disk_size_gb:
description:
- Size in GB of the managed disk to be created.
- Required when I(create_option=empty).
- If I(create_option=copy) then the value must be greater than or equal to the
source's size.
type: int
location:
description:
- Valid Azure location. Defaults to location of the resource group.
type: str
lun:
description:
- 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.
type: int
max_shares:
description:
- 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.
type: int
name:
description:
- Name of the managed disk.
required: true
type: str
os_type:
choices:
- linux
- windows
description:
- Type of Operating System.
- Used when I(create_option=copy) or I(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.
type: str
resource_group:
description:
- Name of a resource group where the managed disk exists or will be created.
required: true
type: str
source_uri:
aliases:
- source_resource_uri
description:
- URI to a valid VHD file to be used or the resource ID of the managed disk to
copy.
- Required when I(create_option=import) or I(create_option=copy).
type: str
storage_account_id:
description:
- The full path to the storage account the image is to be imported from.
- Required when I(create_option=import).
type: str
storage_account_type:
choices:
- Standard_LRS
- StandardSSD_LRS
- StandardSSD_ZRS
- Premium_LRS
- Premium_ZRS
- UltraSSD_LRS
description:
- Type of storage for the managed disk.
- If not specified, the disk is created as C(Standard_LRS).
- C(Standard_LRS) is for Standard HDD.
- C(StandardSSD_LRS) (added in 2.8) is for Standard SSD.
- C(StandardSSD_ZRS) is for Standard SSD Zone-redundant.
- C(Premium_LRS) is for Premium SSD.
- C(Premium_ZRS) is for Premium SSD Zone-redundant.
- C(UltraSSD_LRS) (added in 2.8) is for Ultra SSD, which is only available on
select instance types.
- See U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types)
for more information about disk types.
type: str
zone:
choices:
- '1'
- '2'
- '3'
- ''
description:
- The Azure managed disk's zone.
- Allowed values are C(1), C(2), C(3) and C('').
type: str
type: list
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
managed_by_extended:
description:
- List of name and resource group of the VMs to managed disks.
- When I(state=present), the disks will be attached to the list of VMs specified.
- When I(state=present), use I([]) to detach disks from all the VMs.
- When I(state=absent) and this parameter is defined, the disks will be detached from
the list of VMs.
- When I(state=absent) and this parameter is not defined, the disks will be deleted.
elements: dict
suboptions:
name:
description:
- The name of the attache VM.
type: str
resource_group:
description:
- The resource group of the attache VM.
type: str
type: list
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
disable_instance_discovery:
default: false
description:
- 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
state:
contains:
create_option:
description:
- Create option of the disk.
sample: copy
type: str
disk_size_gb:
description:
- Size in GB of the managed disk to be created.
type: str
id:
description:
- Resource id.
type: str
location:
description:
- Valid Azure location.
type: str
managed_by:
description:
- Name of an existing virtual machine with which the disk is or will be associated,
this VM should be in the same resource group.
type: str
managed_by_extended:
description:
- List ID of an existing virtual machine with which the disk is or will be associated.
sample:
- /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM
type: list
max_shares:
description:
- 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.
sample: 3
type: int
name:
description:
- Name of the managed disk.
type: str
os_type:
description:
- Type of Operating System.
sample: linux
type: str
source_uri:
description:
- URI to a valid VHD file to be used or the resource ID of the managed disk
to copy.
type: str
storage_account_id:
description:
- The full path to the storage account the image is to be imported from
sample: /subscriptions/<uuid>/resourceGroups/<resource group name>/providers/Microsoft.Storage/storageAccounts/<storage
account name>
type: str
storage_account_type:
description:
- Type of storage for the managed disk.
- See U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types)
for more information about this type.
sample: Standard_LRS
type: str
tags:
description:
- Tags to assign to the managed disk.
sample:
tag: value
type: dict
description:
- Current state of the managed disks.
returned: always
type: complex