enrollment

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

Overview

Name	enrollment
Type	Resource
Id	azure.iot_device_provisioning.enrollment

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 record. Create or update a device enrollment record.
create_or_update	replace	id, endpoint	If-Match	Create or update a device enrollment record. Create or update a device enrollment record.
delete	delete	id, endpoint	If-Match	Delete a device enrollment record. Delete a device enrollment record.
get_raw	exec	id, endpoint		Get a device enrollment record. Get a device enrollment record.
get_attestation_mechanism	exec	id, endpoint		Get the attestation mechanism in the device enrollment record. Get the attestation mechanism in the device enrollment record.
run_bulk_operation	exec	endpoint		Bulk device enrollment operation with maximum of 10 enrollments. Bulk device enrollment operation with maximum of 10 enrollments.

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	This id is used to uniquely identify a device registration of an enrollment. A case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end. Required.
If-Match	string	The ETag of the enrollment record. Default value is None.

INSERT examples

create_or_update

Create or update a device enrollment record. Create or update a device enrollment record.

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

Manifest

# Description fields are for documentation purposes
- name: enrollment
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the enrollment resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the enrollment 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 record. Create or update a device enrollment record.

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

DELETE examples

delete

Delete a device enrollment record. Delete a device enrollment record.

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

Lifecycle Methods

get_raw

Get a device enrollment record. Get a device enrollment record.

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

get_attestation_mechanism

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

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

run_bulk_operation

Bulk device enrollment operation with maximum of 10 enrollments. Bulk device enrollment operation with maximum of 10 enrollments.

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