iot_dps_resource_keys

Creates, updates, deletes, gets or lists an iot_dps_resource_keys resource.

Overview

Name	iot_dps_resource_keys
Type	Resource
Id	azure.iot_hub_device_provisioning.iot_dps_resource_keys

Fields

The following fields are returned by SELECT queries:

list

This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the provisioning service endpoints.

Name	Datatype	Description
keyName	string	Name of the key.
primaryKey	string	Primary SAS key value.
rights	string	Rights that this key has.
secondaryKey	string	Secondary SAS key value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	provisioningServiceName, subscriptionId, resourceGroupName	api-version	List the primary and secondary keys for a provisioning service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
provisioningServiceName	string	The provisioning service name to get the shared access keys for.
resourceGroupName	string	resource group name
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

list

List the primary and secondary keys for a provisioning service.

SELECT
keyName,
primaryKey,
rights,
secondaryKey
FROM azure.iot_hub_device_provisioning.iot_dps_resource_keys
WHERE provisioningServiceName = '{{ provisioningServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;