azure_rm_resource_info – Generic facts of Azure resources — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_resource_info – Generic facts of Azure resources

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## 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.

Aliases: azure_rm_resource_facts

## 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 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5 | Default: "latest" | Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
api_version - |  | Specific API version to be used.
auth_source string added in 2.5 | Choices: auto cli credential_file env msi | Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `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 `msi` was added in Ansible 2.6.
cert_validation_mode string added in 2.5 | Choices: ignore validate | 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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string |  | Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4 | Default: "AzureCloud" | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
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.
provider - |  | Provider type, should be specified in no URL is given.
resource_group - |  | Resource group to be used. Required if URL is not specified.
resource_name - |  | Resource name.
resource_type - |  | Resource type.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.
subresource - |  | List of subresources.
| name - |  | Subresource name.
| namespace - |  | Subresource namespace.
| type - |  | Subresource type.
subscription_id string |  | Your Azure subscription Id.
tenant string |  | Azure tenant ID. Use when authenticating with a Service Principal.
url - |  | 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 | Returned | Description
--- | --- | ---
response complex | always | Response specific to resource type.
| id string | always | Id of the Azure resource. Sample: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM
| location string | always | Resource location. Sample: eastus
| name string | always | Resource name. Sample: myVM
| properties complex | always | Specifies the virtual machine's property.
|  | diagnosticsProfile complex | always | Specifies the boot diagnostic settings state.
|  |  | bootDiagnostics dictionary | always | A debugging feature, which to view Console Output and Screenshot to diagnose VM status. Sample: {'enabled': True, 'storageUri': 'https://vxisurgdiag.blob.core.windows.net/'}
|  | hardwareProfile dictionary | always | Specifies the hardware settings for the virtual machine. Sample: {'vmSize': 'Standard_D2s_v3'}
|  | networkProfile complex | always | Specifies the network interfaces of the virtual machine.
|  |  | networkInterfaces list | always | Describes a network interface reference. Sample: [{'id': '/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/networkInterfaces/myvm441'}]
|  | osProfile complex | always | Specifies the operating system settings for the virtual machine.
|  |  | adminUsername string | always | Specifies the name of the administrator account. Sample: azureuser
|  |  | allowExtensionOperations boolean | always | 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. Sample: True
|  |  | computerName string | always | Specifies the host OS name of the virtual machine. Sample: myVM
|  |  | linuxConfiguration dictionary | when OS type is Linux | Specifies the Linux operating system settings on the virtual machine. Sample: {'disablePasswordAuthentication': False, 'provisionVMAgent': True}
|  |  | requireGuestProvisionSignale boolean | always | Specifies the host require guest provision signal or not. Sample: True
|  |  | secrets list | always | Specifies set of certificates that should be installed onto the virtual machine.
|  | provisioningState string | always | The provisioning state. Sample: Succeeded
|  | storageProfile complex | always | Specifies the storage account type for the managed disk.
|  |  | dataDisks list | always | Specifies the parameters that are used to add a data disk to virtual machine. 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'}]
|  |  | imageReference dictionary | always | Specifies information about the image to use. Sample: {'offer': 'UbuntuServer', 'publisher': 'Canonical', 'sku': '18.04-LTS', 'version': 'latest'}
|  |  | osDisk dictionary | always | Specifies information about the operating system disk used by the virtual machine. 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'}
|  | vmID string | always | 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. Sample: eb86d9bb-6725-4787-a487-2e497d5b340c
| type string | always | The type of identity used for the virtual machine. Sample: Microsoft.Compute/virtualMachines

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.