azure.azcollection.azure_rm_manageddisk_info – Get managed disk facts¶
Note
This plugin is part of the azure.azcollection collection (version 1.5.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_manageddisk_info
.
New in version 0.1.2: of azure.azcollection
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
azure >= 2.0.0
Parameters¶
Notes¶
Note
This module was called azure_rm_managed_disk_facts 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: Get facts for one managed disk
azure_rm_manageddisk_info:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all managed disks
azure_rm_manageddisk_info:
- name: Get facts for all managed disks managed by a specific vm
azure_rm_manageddisk_info:
managed_by: '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/Microsoft.Compute/virtualMachines/vmName'
- name: Get facts by tags
azure_rm_manageddisk_info:
tags:
- testing
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
azure_managed_disk
list
/ elements=string
|
always |
List of managed disk dicts.
|
|
create_option
string
|
success |
Create option of the disk.
Sample:
copy
|
|
disk_size_gb
string
|
success |
Size in GB of the managed disk to be created.
|
|
id
string
|
success |
Resource id.
|
|
location
string
|
success |
Valid Azure location.
|
|
managed_by
string
|
success |
Name of an existing virtual machine with which the disk is or will be associated, this VM should be in the same resource group.
|
|
name
string
|
success |
Name of the managed disk.
|
|
os_type
string
|
success |
Type of Operating System.
|
|
source_uri
string
|
success |
URI to a valid VHD file to be used or the resource ID of the managed disk to copy.
|
|
storage_account_type
string
|
success |
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.
Sample:
Standard_LRS
|
|
tags
dictionary
|
success |
Tags to assign to the managed disk.
Sample:
{'tag': 'value'}
|
Authors¶
Bruno Medina (@brusMX)
Paul Aiton (@paultaiton)