azure_rm_resourcegroup_facts – Get resource group facts

New in version 2.1.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

Synopsis

Get facts for a specific resource group or all resource groups.

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.
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.
list_resources - added in 2.8		List all resources under the resource group. Note this will cost network overhead for each resource group. Suggest use this when `name` set.
name -		Limit results to a specific resource group.
password -		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.
secret string		Azure client secret. Use when authenticating with a Service Principal.
subscription_id string		Your Azure subscription Id.
tags -		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

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.

Examples

- name: Get facts for one resource group
  azure_rm_resourcegroup_facts:
    name: myResourceGroup

- name: Get facts for all resource groups
  azure_rm_resourcegroup_facts:

- name: Get facts by tags
  azure_rm_resourcegroup_facts:
    tags:
      - testing
      - foo:bar

- name: Get facts for one resource group including resources it contains
  azure_rm_resourcegroup_facts:
      name: myResourceGroup
      list_resources: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
azure_resourcegroups list			always	List of resource group dicts.
	id string			Resource id. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup
	name string			Resource group name. Sample: foo
	resources list			List of resources under the resource group. Only shows when `list_resources` set to `True`.
		id string		Resource id. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMa chines/myVirtualMachine
		location string		Resource region. Sample: eastus
		name string		Resource name. Sample: myVirtualMachine
		tags dictionary		Tags to assign to the managed disk. Sample: {'tag': 'value'}
		type string		Resource type. Sample: Microsoft.Compute/virtualMachines
	tags dictionary			Tags assigned to resource group. 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

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_resourcegroup_facts_module.html