attach_subscriptions#

State module for managing Attach Subscription.

async idem_azure.states.azure.subscription.attach_subscriptions.present(hub, ctx, name: str, management_group_id: str, subscription_id: str, resource_id: str = None) → Dict[source]#

Create or update attached subscription to management group.

Parameters:

name (str) – The identifier for this state.
management_group_id (str) – management group id to which subscription needs to be associated.
subscription_id (str) – subscription unique id
resource_id (str, Optional) – resource unique id

Returns:

Dict

Examples

attach_subscription_to_mg_present:
  azure.subscription.attach_subscriptions.present:
    - name: value
    - management_group_id: value
    - subscription_id: value

async idem_azure.states.azure.subscription.attach_subscriptions.absent(hub, ctx, name: str, management_group_id: str, subscription_id: str) → Dict[source]#

De-Associate subscription from management group.

Parameters:

name (str) – The identifier for this state.
management_group_id (str) – management group unique id.
subscription_id (str) – subscription unique id.

Returns:

Dict

Examples

detach_subscription_from_mg_absent:
  azure.subscription.attach_subscriptions.absent:
    - name: value
    - management_group_id: value
    - subscription_id: value

async idem_azure.states.azure.subscription.attach_subscriptions.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 subscriptions with respective alias details.

Returns:: Dict[str, Any]

Examples

$ idem describe azure.subscription.attach_subscriptions