az iot dps enrollment-group
Manage Azure IoT Hub Device Provisioning Service.
Commands
az iot dps enrollment-group create |
Create an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group delete |
Delete an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group list |
List enrollments groups in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group show |
Get the details of an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group update |
Update an enrollment group in an Azure IoT Hub Device Provisioning Service. |
az iot dps enrollment-group create
Create an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group create --dps-name
--enrollment-id
--resource-group
[--allocation-policy {custom, geolatency, hashed, static}]
[--api-version]
[--ca-name]
[--certificate-path]
[--edge-enabled {false, true}]
[--hn]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Examples
Create an enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name} using an intermediate certificate as primary certificate'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem
Create an enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name} using a CA certificate {certificate_name} as secondary certificate'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Create an enrollment group '{enrollment_id}' in the Azure IoT provisioning service 'MyDps' in the resource group '{resource_group_name}' with provisioning status 'enabled', target IoT Hub '{iothub_host_name}' and initial twin tags '{"location":{"region":"US"}} using an intermediate certificate as primary certificate'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem --provisioning-status enabled --iot-hub-host-name {iothub_host_name} --initial-twin-tags "{'location':{'region':'US'}}"
Create an enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name} with attestation type 'symmetrickey'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {primary_key} --secondary-key {secondary_key}
Create an enrollment group '{enrollment_id}' with custom allocation policy,
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Required Parameters
Name of the Azure IoT Hub device provisioning service.
ID of enrollment group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Type of allocation for device assigned to the Hub.
The API version of the provisioning service types sent in the custom allocation request. Minimum supported version: 2018-09-01-preview.
The name of the primary root CA certificate. If attestation with a root CA certificate is desired then a root ca name must be provided.
The path to the file containing the primary certificate. If attestation with an intermediate certificate is desired then a certificate path must be provided.
Flag indicating edge enablement.
Host name of target IoT Hub.
Host name of target IoT Hub. Use space-separated list for multiple IoT Hubs.
Initial twin properties.
Initial twin tags.
The primary symmetric shared access key stored in base64 format.
Enable or disable enrollment entry.
Device data to be handled on re-provision to different Iot Hub.
The name of the secondary root CA certificate. If attestation with a root CA certificate is desired then a root ca name must be provided.
The path to the file containing the secondary certificate. If attestation with an intermediate certificate is desired then a certificate path must be provided.
The secondary symmetric shared access key stored in base64 format.
The webhook URL used for custom allocation requests.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az iot dps enrollment-group delete
Delete an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group delete --dps-name
--enrollment-id
--resource-group
Required Parameters
Name of the Azure IoT Hub device provisioning service.
ID of enrollment group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az iot dps enrollment-group list
List enrollments groups in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group list --dps-name
--resource-group
[--top]
Required Parameters
Name of the Azure IoT Hub device provisioning service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Maximum number of elements to return. Use -1 for unlimited.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az iot dps enrollment-group show
Get the details of an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group show --dps-name
--enrollment-id
--resource-group
[--keys {false, true}]
Examples
Basic usage
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Include full attestation information in results for a symmetric key enrollment-group
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Required Parameters
Name of the Azure IoT Hub device provisioning service.
ID of enrollment group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Include attestation keys and information in enrollment group results.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az iot dps enrollment-group update
Update an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group update --dps-name
--enrollment-id
--resource-group
[--allocation-policy {custom, geolatency, hashed, static}]
[--api-version]
[--ca-name]
[--certificate-path]
[--edge-enabled {false, true}]
[--etag]
[--hn]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Examples
Update enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name}' with new initial twin tags.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-tags "{'location':{'region':'US2'}}" --etag AAAAAAAAAAA=
Update enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name}' with new primary intermediate certificate and remove existing secondary intermediate certificate.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --remove-secondary-certificate --etag AAAAAAAAAAA=
Update enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name}' with new secondary CA certificate '{certificate_name}' and remove existing primary CA certificate.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name} --remove-certificate --etag AAAAAAAAAAA=
Update enrollment group '{enrollment_id}' in the Azure IoT provisioning service '{dps_name}' in the resource group '{resource_group_name}' with new primary key.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Required Parameters
Name of the Azure IoT Hub device provisioning service.
ID of enrollment group.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Type of allocation for device assigned to the Hub.
The API version of the provisioning service types sent in the custom allocation request. Minimum supported version: 2018-09-01-preview.
The name of the primary root CA certificate. If attestation with a root CA certificate is desired then a root ca name must be provided.
The path to the file containing the primary certificate. If attestation with an intermediate certificate is desired then a certificate path must be provided.
Flag indicating edge enablement.
Entity tag value.
Host name of target IoT Hub.
Host name of target IoT Hub. Use space-separated list for multiple IoT Hubs.
Initial twin properties.
Initial twin tags.
The primary symmetric shared access key stored in base64 format.
Enable or disable enrollment entry.
Remove current primary certificate.
Remove current secondary certificate.
Device data to be handled on re-provision to different Iot Hub.
The name of the secondary root CA certificate. If attestation with a root CA certificate is desired then a root ca name must be provided.
The path to the file containing the secondary certificate. If attestation with an intermediate certificate is desired then a certificate path must be provided.
The secondary symmetric shared access key stored in base64 format.
The webhook URL used for custom allocation requests.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.