exec.azurerm.resource.group

Azure Resource Manager (ARM) Resource Group Execution Module

New in version 1.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

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
idem_azurerm.exec.azurerm.resource.group.check_existence(hub, ctx, name, **kwargs)

New in version 1.0.0.

Check for the existence of a named resource group in the current subscription.

Parameters:name – The resource group name to check.

CLI Example:

azurerm.resource.group.check_existence testgroup
idem_azurerm.exec.azurerm.resource.group.create_or_update(hub, ctx, name, location, **kwargs)

New in version 1.0.0.

Create or update a resource group in a given location.

Parameters:
  • name – The name of the resource group to create or update.
  • location – The location of the resource group. This value is not able to be updated once the resource group is created.

CLI Example:

azurerm.resource.group.create_or_update testgroup "westus"
idem_azurerm.exec.azurerm.resource.group.delete(hub, ctx, name, **kwargs)

New in version 1.0.0.

Delete a resource group from the subscription.

Parameters:name – The resource group name to delete.

CLI Example:

azurerm.resource.group.delete testgroup
idem_azurerm.exec.azurerm.resource.group.get(hub, ctx, name, **kwargs)

New in version 1.0.0.

Get a dictionary representing a resource group’s properties.

Parameters:name – The resource group name to get.

CLI Example:

azurerm.resource.group.get testgroup
idem_azurerm.exec.azurerm.resource.group.list_(hub, ctx, **kwargs)

New in version 1.0.0.

List all resource groups within a subscription.

CLI Example:

azurerm.resource.group.list