azure_rm_manageddisk_info – Get managed disk facts¶
New in version 2.9.
Synopsis¶
- Get facts for a specific managed disk or all managed disks.
Aliases: azure_rm_managed_disk_facts,azure_rm_manageddisk_facts
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 logincommand.
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 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
                                       | always | List of managed disk dicts. | |
| create_option 
                  string
                                       | Create option of the disk. Sample: copy | ||
| disk_size_gb 
                  string
                                       | Size in GB of the managed disk to be created. | ||
| id 
                  string
                                       | Resource id. | ||
| location 
                  string
                                       | Valid Azure location. | ||
| managed_by 
                  string
                                       | 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
                                       | Name of the managed disk. | ||
| os_type 
                  string
                                       | Type of Operating System. | ||
| source_uri 
                  string
                                       | URI to a valid VHD file to be used or the resource ID of the managed disk to copy. | ||
| storage_account_type 
                  string
                                       | 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
                                       | Tags to assign to the managed disk. Sample: {'tag': 'value'} | ||
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Bruno Medina (@brusMX)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
