iot_dps_resources

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

Overview

Name	iot_dps_resources
Type	Resource
Id	azure.iot_hub_device_provisioning.iot_dps_resources

Fields

The following fields are returned by SELECT queries:

get

Provisioning service description with no keys is included in the response.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
etag	string	The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
identity	object	The managed identities for a provisioning service.
properties	object	Service specific properties for a provisioning service
sku	object	Sku info for a provisioning Service.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

List of provisioning services in the resource group.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
etag	string	The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
identity	object	The managed identities for a provisioning service.
properties	object	Service specific properties for a provisioning service
sku	object	Sku info for a provisioning Service.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
etag	string	The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
identity	object	The managed identities for a provisioning service.
properties	object	Service specific properties for a provisioning service
sku	object	Sku info for a provisioning Service.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	provisioningServiceName, subscriptionId, resourceGroupName	api-version	Get the metadata of the provisioning service without SAS keys.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Get a list of all provisioning services in the given resource group.
list_by_subscription	select	subscriptionId	api-version	List all the provisioning services for a given subscription id.
create_or_update	insert	subscriptionId, resourceGroupName, provisioningServiceName, data__sku, data__properties	api-version	Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.
update	update	subscriptionId, resourceGroupName, provisioningServiceName	api-version	Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
delete	delete	provisioningServiceName, subscriptionId, resourceGroupName	api-version	Deletes the Provisioning Service.
check_provisioning_service_name_availability	exec	subscriptionId, name	api-version	Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable

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	Name of provisioning service to delete.
resourceGroupName	string	Resource group identifier.
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

get

Get the metadata of the provisioning service without SAS keys.

SELECT
id,
name,
etag,
identity,
properties,
sku,
systemData,
type
FROM azure.iot_hub_device_provisioning.iot_dps_resources
WHERE provisioningServiceName = '{{ provisioningServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Get a list of all provisioning services in the given resource group.

SELECT
id,
name,
etag,
identity,
properties,
sku,
systemData,
type
FROM azure.iot_hub_device_provisioning.iot_dps_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_subscription

List all the provisioning services for a given subscription id.

SELECT
id,
name,
etag,
identity,
properties,
sku,
systemData,
type
FROM azure.iot_hub_device_provisioning.iot_dps_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.

INSERT INTO azure.iot_hub_device_provisioning.iot_dps_resources (
data__etag,
data__properties,
data__sku,
data__identity,
subscriptionId,
resourceGroupName,
provisioningServiceName,
api-version
)
SELECT 
'{{ etag }}',
'{{ properties }}' /* required */,
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ provisioningServiceName }}',
'{{ api-version }}'
RETURNING
id,
name,
etag,
identity,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: iot_dps_resources
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the iot_dps_resources resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the iot_dps_resources resource.
    - name: provisioningServiceName
      value: string
      description: Required parameter for the iot_dps_resources resource.
    - name: etag
      value: string
      description: |
        The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
    - name: properties
      value: object
      description: |
        Service specific properties for a provisioning service
    - name: sku
      value: object
      description: |
        Sku info for a provisioning Service.
    - name: identity
      value: object
      description: |
        The managed identities for a provisioning service.
    - name: api-version
      value: string
      description: The version of the API.

UPDATE examples

update

Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method

UPDATE azure.iot_hub_device_provisioning.iot_dps_resources
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND provisioningServiceName = '{{ provisioningServiceName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
etag,
identity,
properties,
sku,
systemData,
type;

DELETE examples

delete

Deletes the Provisioning Service.

DELETE FROM azure.iot_hub_device_provisioning.iot_dps_resources
WHERE provisioningServiceName = '{{ provisioningServiceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

check_provisioning_service_name_availability

Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable

EXEC azure.iot_hub_device_provisioning.iot_dps_resources.check_provisioning_service_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"name": "{{ name }}"
}'
;