states.azurerm.resource.group

Azure Resource Manager (ARM) Resource Group State Module

New in version 1.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed via acct. Note that the authentication parameters are case sensitive.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD

Example configuration for Azure Resource Manager authentication:

azurerm:
    default:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        tenant: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        client_id: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        secret: XXXXXXXXXXXXXXXXXXXXXXXX
        cloud_environment: AZURE_PUBLIC_CLOUD
    user_pass_auth:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        username: fletch
        password: 123pass

The authentication parameters can also be passed as a dictionary of keyword arguments to the connection_auth parameter of each state, but this is not preferred and could be deprecated in the future.
idem_azurerm.states.azurerm.resource.group.absent(hub, ctx, name, connection_auth=None, **kwargs)

New in version 1.0.0.

Ensure a resource group does not exist in the current subscription.

Parameters:
  • name – Name of the resource group.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure resource group absent:
    azurerm.resource.group.absent:
      - name: test_group
idem_azurerm.states.azurerm.resource.group.present(hub, ctx, name, location, managed_by=None, tags=None, connection_auth=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

Ensure a resource group exists.

Parameters:
  • name – Name of the resource group.
  • location – The Azure location in which to create the resource group. This value cannot be updated once the resource group is created.
  • managed_by – The ID of the resource that manages this resource group. This value cannot be updated once the resource group is created.
  • tags – A dictionary of strings can be passed as tag metadata to the resource group object.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure resource group exists:
    azurerm.resource.group.present:
        - name: group1
        - location: eastus
        - tags:
            contact_name: Elmer Fudd Gantry