az iot dps

Manage Azure IoT Hub Device Provisioning Service.

Commands

az iot dps access-policy

Manage Azure IoT Hub Device Provisioning Service access policies.

az iot dps access-policy create

Create a new shared access policy in an Azure IoT Hub device provisioning service.

az iot dps access-policy delete

Delete a shared access policies in an Azure IoT Hub device provisioning service.

az iot dps access-policy list

List all shared access policies in an Azure IoT Hub device provisioning service.

az iot dps access-policy show

Show details of a shared access policies in an Azure IoT Hub device provisioning service.

az iot dps access-policy update

Update a shared access policy in an Azure IoT Hub device provisioning service.

az iot dps certificate

Manage Azure IoT Hub Device Provisioning Service certificates.

az iot dps certificate create

Create/upload an Azure IoT Hub Device Provisioning Service certificate.

az iot dps certificate delete

Delete an Azure IoT Hub Device Provisioning Service certificate.

az iot dps certificate generate-verification-code

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

az iot dps certificate list

List all certificates contained within an Azure IoT Hub device provisioning service.

az iot dps certificate show

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

az iot dps certificate update

Update an Azure IoT Hub Device Provisioning Service certificate.

az iot dps certificate verify

Verify an Azure IoT Hub Device Provisioning Service certificate.

az iot dps create

Create an Azure IoT Hub device provisioning service.

az iot dps delete

Delete an Azure IoT Hub device provisioning service.

az iot dps linked-hub

Manage Azure IoT Hub Device Provisioning Service linked IoT hubs.

az iot dps linked-hub create

Create a linked IoT hub in an Azure IoT Hub device provisioning service.

az iot dps linked-hub delete

Update a linked IoT hub in an Azure IoT Hub device provisioning service.

az iot dps linked-hub list

List all linked IoT hubs in an Azure IoT Hub device provisioning service.

az iot dps linked-hub show

Show details of a linked IoT hub in an Azure IoT Hub device provisioning service.

az iot dps linked-hub update

Update a linked IoT hub in an Azure IoT Hub device provisioning service.

az iot dps list

List Azure IoT Hub device provisioning services.

az iot dps show

Get the details of an Azure IoT Hub device provisioning service.

az iot dps update

Update an Azure IoT Hub device provisioning service.

az iot dps create

Create an Azure IoT Hub device provisioning service.

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
                  [--location]
                  [--sku {S1}]
                  [--subscription]
                  [--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

Required Parameters

--name -n

IoT Provisioning Service name.

--resource-group -g

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

Optional Parameters

--location -l

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

--sku

Pricing tier for the IoT provisioning service.

accepted values: S1
default value: S1
--subscription

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

--unit

Units in your IoT Provisioning Service.

default value: 1

az iot dps delete

Delete an Azure IoT Hub device provisioning service.

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

az iot dps list

List Azure IoT Hub device provisioning services.

az iot dps list [--query-examples]
                [--resource-group]
                [--subscription]

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az iot dps show

Get the details of an Azure IoT Hub device provisioning service.

az iot dps show [--ids]
                [--name]
                [--query-examples]
                [--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 Provisioning Service name.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az iot dps update

Update an Azure IoT Hub device provisioning service.

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

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

--force-string

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

--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 Provisioning Service name.

--remove

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

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

--subscription

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