enrollment_group

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

Overview

Name	enrollment_group
Type	Resource
Id	azure.iot_device_provisioning.enrollment_group

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	id, endpoint	If-Match	Create or update a device enrollment group. Create or update a device enrollment group.
create_or_update	replace	id, endpoint	If-Match	Create or update a device enrollment group. Create or update a device enrollment group.
delete	delete	id, endpoint	If-Match	Delete a device enrollment group. Delete a device enrollment group.
get_raw	exec	id, endpoint		Get a device enrollment group. Get a device enrollment group.
get_attestation_mechanism	exec	id, endpoint		Get the attestation mechanism in the device enrollment group record. Get the attestation mechanism in the device enrollment group record.
run_bulk_operation	exec	endpoint		Bulk device enrollment group operation with maximum of 10 groups. Bulk device enrollment group operation with maximum of 10 groups.

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
endpoint	string	The service endpoint host (no scheme). (default: )
id	string	Enrollment group ID. Required.
If-Match	string	The ETag of the enrollment group record. Default value is None.

INSERT examples

create_or_update

Create or update a device enrollment group. Create or update a device enrollment group.

INSERT INTO azure.iot_device_provisioning.enrollment_group (
id,
endpoint,
If-Match
)
SELECT 
'{{ id }}',
'{{ endpoint }}',
'{{ If-Match }}'
;

Manifest

# Description fields are for documentation purposes
- name: enrollment_group
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the enrollment_group resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the enrollment_group resource.
  - name: If-Match
    value: "{{ If-Match }}"
    description: The ETag of the enrollment record. Default value is None.
    description: The ETag of the enrollment record. Default value is None.

REPLACE examples

create_or_update

Create or update a device enrollment group. Create or update a device enrollment group.

REPLACE azure.iot_device_provisioning.enrollment_group
SET 
-- No updatable properties
WHERE 
id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND If-Match = '{{ If-Match}}';

DELETE examples

delete

Delete a device enrollment group. Delete a device enrollment group.

DELETE FROM azure.iot_device_provisioning.enrollment_group
WHERE id = '{{ id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

get_raw

Get a device enrollment group. Get a device enrollment group.

EXEC azure.iot_device_provisioning.enrollment_group.get_raw 
@id='{{ id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_attestation_mechanism

Get the attestation mechanism in the device enrollment group record. Get the attestation mechanism in the device enrollment group record.

EXEC azure.iot_device_provisioning.enrollment_group.get_attestation_mechanism 
@id='{{ id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

run_bulk_operation

Bulk device enrollment group operation with maximum of 10 groups. Bulk device enrollment group operation with maximum of 10 groups.

EXEC azure.iot_device_provisioning.enrollment_group.run_bulk_operation 
@endpoint='{{ endpoint }}' --required
;