edu_enrollments

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

Overview

Name	edu_enrollments
Type	Resource
Id	azure_extras.program_enrollment.edu_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.
domains	array	The domain groups associated with this enrollment. Required.
failureReason	object	Failure detail when provisioningState is Failed. Omitted otherwise.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
domains	array	The domain groups associated with this enrollment. Required.
failureReason	object	Failure detail when provisioningState is Failed. Omitted otherwise.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
domains	array	The domain groups associated with this enrollment. Required.
failureReason	object	Failure detail when provisioningState is Failed. Omitted otherwise.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, enrollment_name, subscription_id		Gets the specified edu enrollment.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the edu enrollments in a resource group.
list_by_subscription	select	subscription_id		Lists the edu enrollments in a subscription.
create_or_update	insert	resource_group_name, enrollment_name, subscription_id, location		Creates or updates the specified edu enrollment.
update	update	resource_group_name, enrollment_name, subscription_id		Updates the specified edu enrollment.
create_or_update	replace	resource_group_name, enrollment_name, subscription_id, location		Creates or updates the specified edu enrollment.
delete	delete	resource_group_name, enrollment_name, subscription_id		Deletes the specified edu 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 edu enrollment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified edu enrollment.

SELECT
id,
name,
domains,
failureReason,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.program_enrollment.edu_enrollments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND enrollment_name = '{{ enrollment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the edu enrollments in a resource group.

SELECT
id,
name,
domains,
failureReason,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.program_enrollment.edu_enrollments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists the edu enrollments in a subscription.

SELECT
id,
name,
domains,
failureReason,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.program_enrollment.edu_enrollments
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified edu enrollment.

INSERT INTO azure_extras.program_enrollment.edu_enrollments (
tags,
location,
properties,
resource_group_name,
enrollment_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ enrollment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: edu_enrollments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the edu_enrollments resource.
  - name: enrollment_name
    value: "{{ enrollment_name }}"
    description: Required parameter for the edu_enrollments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the edu_enrollments resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      domains:
        - domainNames: "{{ domainNames }}"
          tenantId: "{{ tenantId }}"
          state: "{{ state }}"
          failureReason:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
      failureReason:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"

UPDATE examples

update

Updates the specified edu enrollment.

UPDATE azure_extras.program_enrollment.edu_enrollments
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND enrollment_name = '{{ enrollment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates the specified edu enrollment.

REPLACE azure_extras.program_enrollment.edu_enrollments
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND enrollment_name = '{{ enrollment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified edu enrollment.

DELETE FROM azure_extras.program_enrollment.edu_enrollments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND enrollment_name = '{{ enrollment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;