az iot dps certificate

  • Reference

Manage Azure IoT Hub Device Provisioning Service certificates.

Commands

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 certificate create

Edit

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

az iot dps certificate create --certificate-name
                              --dps-name
                              --path
                              --resource-group
                              [--subscription]

Examples

Upload a CA certificate PEM file to an Azure IoT Hub device provisioning service.

az iot dps certificate create --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --path /certificates/Certificate.pem

Upload a CA certificate CER file to an Azure IoT Hub device provisioning service.

az iot dps certificate create --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --path /certificates/Certificate.cer

Required Parameters

--certificate-name --name -n

A friendly name for the certificate.

--dps-name

IoT Provisioning Service name.

--path -p

The path to the file containing the certificate.

--resource-group -g

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

Optional Parameters

--subscription

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

az iot dps certificate delete

Edit

Delete an Azure IoT Hub Device Provisioning Service certificate.

az iot dps certificate delete --certificate-name
                              --dps-name
                              --etag
                              --resource-group
                              [--subscription]

Examples

Delete MyCertificate in an Azure IoT Hub device provisioning service

az iot dps certificate delete --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --etag AAAAAAAAAAA=

Required Parameters

--certificate-name --name -n

A friendly name for the certificate.

--dps-name

IoT Provisioning Service name.

--etag -e

Entity Tag (etag) of the object.

--resource-group -g

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

Optional Parameters

--subscription

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

az iot dps certificate generate-verification-code

Edit

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

This verification code is used to complete the proof of possession step for a certificate. Use this verification code as the CN of a new certificate signed with the root certificates private key.

az iot dps certificate generate-verification-code --certificate-name
                                                  --dps-name
                                                  --etag
                                                  --resource-group
                                                  [--subscription]

Examples

Generate a verification code for MyCertificate

az iot dps certificate generate-verification-code --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --etag AAAAAAAAAAA=

Required Parameters

--certificate-name --name -n

A friendly name for the certificate.

--dps-name

IoT Provisioning Service name.

--etag -e

Entity Tag (etag) of the object.

--resource-group -g

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

Optional Parameters

--subscription

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

az iot dps certificate list

Edit

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

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

Examples

List all certificates in MyDps

az iot dps certificate list --dps-name MyDps --resource-group MyResourceGroup

Required Parameters

--dps-name

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

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

--subscription

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

az iot dps certificate show

Edit

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

az iot dps certificate show --certificate-name
                            --dps-name
                            --resource-group
                            [--query-examples]
                            [--subscription]

Examples

Show details about MyCertificate in an Azure IoT Hub device provisioning service

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

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

az iot dps certificate show --certificate-name MyCertificate --dps-name MyDps --resource-group MyResourceGroup --subscription MySubscription

Required Parameters

--certificate-name --name -n

A friendly name for the certificate.

--dps-name

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

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

--subscription

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

az iot dps certificate update

Edit

Update an Azure IoT Hub Device Provisioning Service certificate.

Upload a new certificate to replace the existing certificate with the same name.

az iot dps certificate update --certificate-name
                              --dps-name
                              --etag
                              --path
                              --resource-group
                              [--subscription]

Examples

Update a CA certificate in an Azure IoT Hub device provisioning service by uploading a new PEM file.

az iot dps certificate update --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=

Update a CA certificate in an Azure IoT Hub device provisioning service by uploading a new CER file.

az iot dps certificate update --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --path /certificates/NewCertificate.cer --etag AAAAAAAAAAA=

Required Parameters

--certificate-name --name -n

A friendly name for the certificate.

--dps-name

IoT Provisioning Service name.

--etag -e

Entity Tag (etag) of the object.

--path -p

The path to the file containing the certificate.

--resource-group -g

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

Optional Parameters

--subscription

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

az iot dps certificate verify

Edit

Verify an Azure IoT Hub Device Provisioning Service certificate.

Verify a certificate by uploading a verification certificate containing the verification code obtained by calling generate-verification-code. This is the last step in the proof of possession process.

az iot dps certificate verify --certificate-name
                              --dps-name
                              --etag
                              --path
                              --resource-group
                              [--subscription]

Examples

Verify ownership of the MyCertificate private key.

az iot dps certificate verify --dps-name MyDps --resource-group MyResourceGroup --name MyCertificate --path /certificates/Verification.pem --etag AAAAAAAAAAA=

Required Parameters

--certificate-name --name -n

A friendly name for the certificate.

--dps-name

IoT Provisioning Service name.

--etag -e

Entity Tag (etag) of the object.

--path -p

The path to the file containing the certificate.

--resource-group -g

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

Optional Parameters

--subscription

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