Documentation

azure_rm_resourcegroup_facts - Get resource group facts.

New in version 2.1.

Synopsis

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

Requirements (on host that executes module)

  • python >= 2.7
  • azure == 2.0.0rc5

Options

parameter required default choices comments
ad_user
no
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
client_id
no
Azure client ID. Use when authenticating with a Service Principal.
name
no
Limit results to a specific resource group.
password
no
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
no
Security profile found in ~/.azure/credentials file.
secret
no
Azure client secret. Use when authenticating with a Service Principal.
subscription_id
no
Your Azure subscription Id.
tags
no
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant
no
Azure tenant ID. Use when authenticating with a Service Principal.

Examples

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

- name: Get facts for all resource groups
  azure_rm_securitygroup_facts:

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

Return Values

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

name description returned type sample
azure_resourcegroups List of resource group dicts. always list


Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal pass subscription_id, client_id, secret and tenant or set set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
  • To Authentication 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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is supported mainly by the community and is curated by core committers.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.