azure.azcollection.azure_rm_resource_info – Generic facts of Azure resources
Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_resource_info
.
New in version 0.1.2: of azure.azcollection
Synopsis
Obtain facts of any resource using Azure REST API.
This module gives access to resources that are not supported via Ansible modules.
Refer to https://docs.microsoft.com/en-us/rest/api/ regarding details related to specific resource REST API.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Specific API version to be used. |
|
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 Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Provider type, should be specified in no URL is given. |
|
Resource group to be used. Required if URL is not specified. |
|
Resource name. |
|
Resource type. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
List of subresources. |
|
Subresource name. |
|
Subresource namespace. |
|
Subresource type. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
Azure RM Resource URL. |
Notes
Note
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 scaleset info
azure_rm_resource_info:
resource_group: myResourceGroup
provider: compute
resource_type: virtualmachinescalesets
resource_name: myVmss
api_version: "2017-12-01"
- name: Query all the resources in the resource group
azure_rm_resource_info:
resource_group: "{{ resource_group }}"
resource_type: resources
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response specific to resource type. Returned: always |
|
Id of the Azure resource. Returned: always Sample: “/subscriptions/xxxx…xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM” |
|
Resource location. Returned: always Sample: “eastus” |
|
Resource name. Returned: always Sample: “myVM” |
|
Specifies the virtual machine’s property. Returned: always |
|
Specifies the boot diagnostic settings state. Returned: always |
|
A debugging feature, which to view Console Output and Screenshot to diagnose VM status. Returned: always Sample: {“enabled”: true, “storageUri”: “https://vxisurgdiag.blob.core.windows.net/”} |
|
Specifies the hardware settings for the virtual machine. Returned: always Sample: {“vmSize”: “Standard_D2s_v3”} |
|
Specifies the network interfaces of the virtual machine. Returned: always |
|
Describes a network interface reference. Returned: always Sample: [{“id”: “/subscriptions/xxxx…xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/networkInterfaces/myvm441”}] |
|
Specifies the operating system settings for the virtual machine. Returned: always |
|
Specifies the name of the administrator account. Returned: always Sample: “azureuser” |
|
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. Returned: always Sample: true |
|
Specifies the host OS name of the virtual machine. Returned: always Sample: “myVM” |
|
Specifies the Linux operating system settings on the virtual machine. Returned: when OS type is Linux Sample: {“disablePasswordAuthentication”: false, “provisionVMAgent”: true} |
|
Specifies the host require guest provision signal or not. Returned: always Sample: true |
|
Specifies set of certificates that should be installed onto the virtual machine. Returned: always Sample: [] |
|
The provisioning state. Returned: always Sample: “Succeeded” |
|
Specifies the storage account type for the managed disk. Returned: always |
|
Specifies the parameters that are used to add a data disk to virtual machine. Returned: always Sample: [{“caching”: “None”, “createOption”: “Attach”, “diskSizeGB”: 1023, “lun”: 2, “managedDisk”: {“id”: “/subscriptions/xxxx….xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk2”, “storageAccountType”: “StandardSSD_LRS”}, “name”: “testdisk2”}, {“caching”: “None”, “createOption”: “Attach”, “diskSizeGB”: 1023, “lun”: 1, “managedDisk”: {“id”: “/subscriptions/xxxx…xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk3”, “storageAccountType”: “StandardSSD_LRS”}, “name”: “testdisk3”}] |
|
Specifies information about the image to use. Returned: always Sample: {“offer”: “UbuntuServer”, “publisher”: “Canonical”, “sku”: “18.04-LTS”, “version”: “latest”} |
|
Specifies information about the operating system disk used by the virtual machine. Returned: always Sample: {“caching”: “ReadWrite”, “createOption”: “FromImage”, “diskSizeGB”: 30, “managedDisk”: {“id”: “/subscriptions/xxx…xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/disks/myVM_disk1_xxx”, “storageAccountType”: “Premium_LRS”}, “name”: “myVM_disk1_xxx”, “osType”: “Linux”} |
|
Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure laaS VMs SMBIOS. It can be read using platform BIOS commands. Returned: always Sample: “eb86d9bb-6725-4787-a487-2e497d5b340c” |
|
The type of identity used for the virtual machine. Returned: always Sample: “Microsoft.Compute/virtualMachines” |
Authors
Zim Kalinowski (@zikalino)