az iot dps enrollment-group registration
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.46.0 or higher). The extension will automatically install the first time you run an az iot dps enrollment-group registration command. Learn more about extensions.
Manage service-side device registrations for an enrollment group in an Azure IoT Hub Device Provisioning Service.
Use az iot device registration create to simulate device registration.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot dps enrollment-group registration delete |
Delete a device registration for an enrollment group in an Azure IoT Hub Device Provisioning Service. |
Extension | GA |
| az iot dps enrollment-group registration list |
List device registrations for an enrollment group in an Azure IoT Hub Device Provisioning Service. |
Extension | GA |
| az iot dps enrollment-group registration show |
Get a device registration for an enrollment group in an Azure IoT Hub Device Provisioning Service. |
Extension | GA |
az iot dps enrollment-group registration delete
Delete a device registration for an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group registration delete --registration-id
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]Required Parameters
ID of device registration.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iotdps-data-auth-type={auth-type-value}.
Name or hostname of the Azure IoT Hub Device Provisioning Service. Required if --login is not provided.
Etag or entity tag corresponding to the last state of the resource. If no etag is provided the value '*' is used.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --dps-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot dps enrollment-group registration list
List device registrations for an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group registration list --eid
[--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]Required Parameters
Enrollment group ID.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iotdps-data-auth-type={auth-type-value}.
Name or hostname of the Azure IoT Hub Device Provisioning Service. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --dps-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Maximum number of elements to return. Use -1 for unlimited.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot dps enrollment-group registration show
Get a device registration for an enrollment group in an Azure IoT Hub Device Provisioning Service.
az iot dps enrollment-group registration show --registration-id
[--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]Required Parameters
ID of device registration.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iotdps-data-auth-type={auth-type-value}.
Name or hostname of the Azure IoT Hub Device Provisioning Service. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --dps-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI