device_registration_state

Creates, updates, deletes, gets or lists a device_registration_state resource.

Overview

Name	device_registration_state
Type	Resource
Id	azure.iot_device_provisioning.device_registration_state

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
delete	delete	id, endpoint	If-Match	Deletes the device registration. Deletes the device registration.
get_raw	exec	id, endpoint		Gets the device registration state. Gets the device registration state.
query	exec	id, endpoint	x-ms-max-item-count, x-ms-continuation	Gets the registration state of devices in this enrollmentGroup. Gets the registration state of devices in this enrollmentGroup.

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 registration status record. Default value is None.
x-ms-continuation	string	continuation token. Default value is None.
x-ms-max-item-count	integer	pageSize. Default value is None.

DELETE examples

delete

Deletes the device registration. Deletes the device registration.

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

Lifecycle Methods

get_raw

Gets the device registration state. Gets the device registration state.

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

query

Gets the registration state of devices in this enrollmentGroup. Gets the registration state of devices in this enrollmentGroup.

EXEC azure.iot_device_provisioning.device_registration_state.query 
@id='{{ id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@x-ms-max-item-count='{{ x-ms-max-item-count }}', 
@x-ms-continuation='{{ x-ms-continuation }}'
;