community.azure.azure_rm_manageddisk_info – Get managed disk facts
community.azure.azure_rm_manageddisk_info – Get managed disk facts
Note
This plugin is part of the community.azure collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_manageddisk_info
.
Synopsis
- Get facts for a specific managed disk or all managed disks.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
ad_user string |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url string added in 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
append_tags boolean |
|
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 string added in 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
name string |
Limit results to a specific managed disk. | |
password string |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile string |
Security profile found in ~/.azure/credentials file. | |
resource_group string |
Limit results to a specific resource group. | |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id string |
Your Azure subscription Id. | |
tags list / elements=string |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. |
Notes
Note
- This module was called community.azure.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
Examples
- name: Get facts for one managed disk
community.azure.azure_rm_manageddisk_info:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all managed disks
community.azure.azure_rm_manageddisk_info:
- name: Get facts by tags
community.azure.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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_manageddisk_info_module.html