enrollments

Creates, updates, deletes, gets or lists an enrollments resource.

Overview

Name	enrollments
Type	Resource
Id	azure.resilience_management.enrollments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
errorDetails	object	Details of any errors encountered during Enrollment create or update.
provisioningState	string	Provisioning state of the enrollment. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
serviceGroupId	string	ARM resource identifier of the service group associated with this usage plan. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
errorDetails	object	Details of any errors encountered during Enrollment create or update.
provisioningState	string	Provisioning state of the enrollment. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
serviceGroupId	string	ARM resource identifier of the service group associated with this usage plan. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, usage_plan_name, enrollment_name, subscription_id		Get an Enrollment.
list	select	resource_group_name, usage_plan_name, subscription_id		List Enrollments by Usage Plan.
create_or_update	insert	resource_group_name, usage_plan_name, enrollment_name, subscription_id		Create or update an Enrollment.
create_or_update	replace	resource_group_name, usage_plan_name, enrollment_name, subscription_id		Create or update an Enrollment.
delete	delete	resource_group_name, usage_plan_name, enrollment_name, subscription_id		Delete an Enrollment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
enrollment_name	string	The name of the enrollment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
usage_plan_name	string	The name of the usage plan. Required.

SELECT examples

get

Get an Enrollment.

SELECT
id,
name,
errorDetails,
provisioningState,
serviceGroupId,
systemData,
type
FROM azure.resilience_management.enrollments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND usage_plan_name = '{{ usage_plan_name }}' -- required
AND enrollment_name = '{{ enrollment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Enrollments by Usage Plan.

SELECT
id,
name,
errorDetails,
provisioningState,
serviceGroupId,
systemData,
type
FROM azure.resilience_management.enrollments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND usage_plan_name = '{{ usage_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an Enrollment.

INSERT INTO azure.resilience_management.enrollments (
properties,
resource_group_name,
usage_plan_name,
enrollment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ usage_plan_name }}',
'{{ enrollment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: enrollments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the enrollments resource.
  - name: usage_plan_name
    value: "{{ usage_plan_name }}"
    description: Required parameter for the enrollments resource.
  - name: enrollment_name
    value: "{{ enrollment_name }}"
    description: Required parameter for the enrollments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the enrollments resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      serviceGroupId: "{{ serviceGroupId }}"
      provisioningState: "{{ provisioningState }}"
      errorDetails:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"

REPLACE examples

create_or_update

Create or update an Enrollment.

REPLACE azure.resilience_management.enrollments
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND usage_plan_name = '{{ usage_plan_name }}' --required
AND enrollment_name = '{{ enrollment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an Enrollment.

DELETE FROM azure.resilience_management.enrollments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND usage_plan_name = '{{ usage_plan_name }}' --required
AND enrollment_name = '{{ enrollment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;