az iot dps

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure IoT Hub Device Provisioning Service.

Commands

Name Description Type Status
az iot dps certificate

Manage certificates for an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate create

Create/upload a certficate to an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate delete

Delete a certificate in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate generate-verification-code

Generate a verification code for a certificate in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate list

List all certificates contained within an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate show

Show information about a particular certificate in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate update

Update a certificate in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps certificate verify

Verify a certificate in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps compute-device-key

Generate a derived device SAS key.

 Extension Deprecated
az iot dps connection-string

Manage connection strings for an Azure IoT Hub Device Provisioning Service instance.

 Extension GA
az iot dps connection-string show

Show the connection strings for the specified Device Provisioning Services using the given policy name and key.

 Extension GA
az iot dps create

Create an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps delete

Delete an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps enrollment

Manage individual device enrollments in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group

Manage enrollment groups in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group compute-device-key

Generate a derived device SAS key for an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group create

Create an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group delete

Delete an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group list

List enrollments groups in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group registration

Manage service-side device registrations 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.

 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 show

Get an enrollment group's details in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment-group update

Update an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment create

Create an individual device enrollment in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment delete

Delete an individual device enrollment in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment list

List individual device enrollments in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment registration

Manage service-side device registrations for an individual enrollment in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment registration delete

Delete a device registration for an individual enrollment in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment registration show

Get a device registration for an individual enrollment in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment show

Get individual device enrollment details in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps enrollment update

Update an individual device enrollment in an Azure IoT Hub Device Provisioning Service.

 Extension GA
az iot dps linked-hub

Manage linked IoT Hubs in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps linked-hub create

Create a linked IoT hub in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps linked-hub delete

Update a linked IoT hub in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps linked-hub list

List all linked IoT hubs in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps linked-hub show

Show details of a linked IoT hub in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps linked-hub update

Update a linked IoT hub in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps list

List Azure IoT Hub Device Provisioning Service instances.

 Core GA
az iot dps policy

Manage shared access policies for an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps policy create

Create a new shared access policy in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps policy delete

Delete a shared access policies in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps policy list

List all shared access policies in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps policy show

Show details of a shared access policies in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps policy update

Update a shared access policy in an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps registration

Manage device registrations for an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension Deprecated
az iot dps registration delete

Delete a device registration in an Azure IoT Hub Device Provisioning Service.

 Extension Deprecated
az iot dps registration list

List device registrations for an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension Deprecated
az iot dps registration show

Get a device registration for an enrollment group in an Azure IoT Hub Device Provisioning Service.

 Extension Deprecated
az iot dps show

Get the details of an Azure IoT Hub Device Provisioning Service instance.

 Core GA
az iot dps update

Update an Azure IoT Hub Device Provisioning Service instance.

 Core GA

az iot dps compute-device-key

Deprecated

This command has been deprecated and will be removed in a future release. Use 'iot dps enrollment-group compute-device-key' instead.

Generate a derived device SAS key.

Generate a derived device key for a DPS enrollment group.

az iot dps compute-device-key --registration-id
                              [--auth-type {key, login}]
                              [--dps-name]
                              [--eid]
                              [--key]
                              [--login]
                              [--resource-group]

Examples

Compute the device key with the given symmetric key.

az iot dps compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}

Compute the device key with the given enrollment group.

az iot dps compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}

Required Parameters

--registration-id

ID of device registration.

Optional Parameters

--auth-type

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>.

accepted values: key, login
default value: key
--dps-name -n

Name or hostname of the Azure IoT Hub Device Provisioning Service. Required if --login is not provided.

--eid --enrollment-id --gid --group-id

Enrollment group ID.

--key --symmetric-key

The symmetric shared access key for the enrollment group. This bypasses the Device Provisioning Service registry and generates the SAS token directly from the supplied symmetric key without further validation. All other command parameters aside from registration ID will be ignored.

--login -l

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.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot dps create

Edit

Create an Azure IoT Hub Device Provisioning Service instance.

For an introduction to Azure IoT Hub Device Provisioning Service, see https://docs.microsoft.com/azure/iot-dps/about-iot-dps.

az iot dps create --name
                  --resource-group
                  [--edr {false, true}]
                  [--location]
                  [--sku {S1}]
                  [--tags]
                  [--unit]

Examples

Create an Azure IoT Hub Device Provisioning Service with the standard pricing tier S1, in the region of the resource group.

az iot dps create --name MyDps --resource-group MyResourceGroup

Create an Azure IoT Hub Device Provisioning Service with the standard pricing tier S1, in the 'eastus' region.

az iot dps create --name MyDps --resource-group MyResourceGroup --location eastus

Create an Azure IoT Hub Device Provisioning Service with data residency enforced. This will disable cross-region disaster recovery.

az iot dps create --name MyDps --resource-group MyResourceGroup --edr

Required Parameters

--name -n

IoT Hub Device Provisioning Service name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--edr --enforce-data-residency

Enforce data residency for this IoT Hub Device Provisioning Service by disabling cross geo-pair disaster recovery. This property is immutable once set on the resource. Only available in select regions. Learn more at https://aka.ms/dpsdr.

accepted values: false, true
--location -l

Location of your IoT Hub Device Provisioning Service. Default is the location of target resource group.

--sku

Pricing tier for the IoT Hub Device Provisioning Service.

accepted values: S1
default value: S1
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--unit

Units in your IoT Hub Device Provisioning Service.

default value: 1
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot dps delete

Edit

Delete an Azure IoT Hub Device Provisioning Service instance.

az iot dps delete [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Examples

Delete an Azure IoT Hub Device Provisioning Service 'MyDps'

az iot dps delete --name MyDps --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

IoT Hub Device Provisioning Service name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot dps list

Edit

List Azure IoT Hub Device Provisioning Service instances.

az iot dps list [--resource-group]

Examples

List all Azure IoT Hub Device Provisioning Services in a subscription.

az iot dps list

List all Azure IoT Hub Device Provisioning Services in the resource group 'MyResourceGroup'

az iot dps list --resource-group MyResourceGroup

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot dps show

Edit

Get the details of an Azure IoT Hub Device Provisioning Service instance.

az iot dps show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

Examples

Show details of an Azure IoT Hub Device Provisioning Service 'MyDps'

az iot dps show --name MyDps --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

IoT Hub Device Provisioning Service name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot dps update

Edit

Update an Azure IoT Hub Device Provisioning Service instance.

az iot dps update [--add]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]
                  [--tags]

Examples

Update Allocation Policy to 'GeoLatency' of an Azure IoT Hub Device Provisioning Service 'MyDps'

az iot dps update --name MyDps --resource-group MyResourceGroup --set properties.allocationPolicy="GeoLatency"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

IoT Hub Device Provisioning Service name.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.