management_groups

State module for managing Management Group.

async idem_azure.states.azure.management_groups.management_groups.present(hub, ctx, name: str, management_group_name: str, resource_id: str = None, display_name: str = None, parent_id: str = None) → Dict

Create or update Management Groups.

Parameters:

• name (str) – The identifier for this state.

• management_group_name (str) – The name of the management 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._()]+$.

• display_name (str, Optional) – The management group name to be displayed

• parent_id (str, Optional) – creates management group under this id

• resource_id (str, Optional) – Management group resource id on Azure

Returns:

Dict

Examples

my-management-group:
  azure.management_groups.management_groups.present:
    - name: my-management-group
    - management_group_name: my-management-group-1
    - display_name: my-management-group-1
    - parent_id: /providers/Microsoft.Management/managementGroups/parent-management-group

async idem_azure.states.azure.management_groups.management_groups.absent(hub, ctx, name: str, management_group_name: str) → Dict

Delete Management Groups.

Parameters:

• name (str) – The identifier for this state.

• management_group_name (str) – The name of the resource group to delete. The name is case insensitive.Regex pattern: ^[-w._()]+$.

Returns:

Dict

Examples

resource_is_absent:
  azure.management_groups.management_groups.absent:
    - name: value
    - management_group_name: value

async idem_azure.states.azure.management_groups.management_groups.describe(hub, ctx) → Dict[str, Dict[str, Any]]

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

Lists all Management Groups.

Returns:

Dict[str, Any]

Examples

$ idem describe azure.management_groups.management_groups