iot_dps_resource_keys_for_key_names

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

Overview

Name	iot_dps_resource_keys_for_key_names
Type	Resource
Id	azure.iot_hub_device_provisioning.iot_dps_resource_keys_for_key_names

Fields

The following fields are returned by SELECT queries:

list

This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more 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, keyName, subscriptionId, resourceGroupName	api-version	List primary and secondary keys for a specific key name

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
keyName	string	Logical key name to get key-values for.
provisioningServiceName	string	Name of the provisioning service.
resourceGroupName	string	The name of the resource group that contains the provisioning service.
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

list

List primary and secondary keys for a specific key name

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