resource_groups#

State module for managing Resource Group.

async idem_azure.states.azure.resource_management.resource_groups.present(hub, ctx, name: str, resource_group_name: str, location: str, subscription_id: str = None, tags: Dict = None, resource_id: str = None) → dict[source]#

Create or update Resource Groups.

Parameters:

name (str) – The identifier for this state.
resource_group_name (str) – The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.Regex pattern: ^[-w._()]+$.
location (str) – Resource location.
subscription_id (str, Optional) – Subscription Unique id.
tags (dict, Optional) – Resource tags.
resource_id (str, Optional) – Resource Group id on Azure.

Returns:

dict

Examples

resource_is_present:
  azure.resource_management.resource_groups.present:
    - name: value
    - resource_group_name: value
    - subscription_id: value

async idem_azure.states.azure.resource_management.resource_groups.absent(hub, ctx, name: str, resource_id: str = None, resource_group_name: str = None, subscription_id: str = None) → dict[source]#

Delete Resource Groups.

Parameters:

name (str) – The identifier for this state.
resource_id (str, Optional) – Resource Group resource id in Azure.
resource_group_name (str, Optional) – The name of the resource group to delete. The name is case insensitive.Regex pattern: ^[-w._()]+$.
subscription_id (str, Optional) – Subscription Unique id.

Returns:

Dict

Examples

resource_is_absent:
  azure.resource_management.resource_groups.absent:
    - name: value
    - resource_group_name: value
    - subscription_id: value

async idem_azure.states.azure.resource_management.resource_groups.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Lists all Resource Groups under the same subscription.

Returns:: Dict[str, Any]

Examples

$ idem describe azure.resource_management.resource_groups

idem_azure.states.azure.resource_management.resource_groups.is_pending(hub, ret: dict, state: str = None, **pending_kwargs) → bool[source]#: Default implemented for each module.