iot_dps_resources

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

Overview

Name	iot_dps_resources
Type	Resource
Id	azure.iot_hub_device_provisioning.iot_dps_resources

Fields

vw_iot_dps_resources

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
allocation_policy	text	field from the properties object
authorization_policies	text	field from the properties object
device_provisioning_host_name	text	field from the properties object
enable_data_residency	text	field from the properties object
etag	text	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.
id_scope	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
iot_hubs	text	field from the properties object
ip_filter_rules	text	field from the properties object
portal_operations_host_name	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioningServiceName	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
service_operations_host_name	text	field from the properties object
sku	text	List of possible provisioning service SKUs.
state	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

iot_dps_resources

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	Managed service identity (system assigned and/or user assigned identities)
properties	object	the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope
sku	object	List of possible provisioning service SKUs.
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

Name	Accessible by	Required Params	Description
get	SELECT	provisioningServiceName, resourceGroupName, subscriptionId	Get the metadata of the provisioning service without SAS keys.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get a list of all provisioning services in the given resource group.
list_by_subscription	SELECT	subscriptionId	List all the provisioning services for a given subscription id.
create_or_update	INSERT	provisioningServiceName, resourceGroupName, subscriptionId, data__properties, data__sku	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.
delete	DELETE	provisioningServiceName, resourceGroupName, subscriptionId	Deletes the Provisioning Service.
update	UPDATE	provisioningServiceName, resourceGroupName, subscriptionId	Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method
check_provisioning_service_name_availability	EXEC	subscriptionId, data__name	Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable

SELECT examples

List all the provisioning services for a given subscription id.

vw_iot_dps_resources

SELECT
id,
name,
allocation_policy,
authorization_policies,
device_provisioning_host_name,
enable_data_residency,
etag,
id_scope,
identity,
iot_hubs,
ip_filter_rules,
portal_operations_host_name,
private_endpoint_connections,
provisioningServiceName,
provisioning_state,
public_network_access,
resourceGroupName,
service_operations_host_name,
sku,
state,
subscriptionId,
system_data,
type
FROM azure.iot_hub_device_provisioning.vw_iot_dps_resources
WHERE subscriptionId = '{{ subscriptionId }}';

iot_dps_resources

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

INSERT example

Use the following StackQL query and manifest file to create a new iot_dps_resources resource.

All Properties

/*+ create */
INSERT INTO azure.iot_hub_device_provisioning.iot_dps_resources (
provisioningServiceName,
resourceGroupName,
subscriptionId,
data__properties,
data__sku,
etag,
properties,
sku,
identity
)
SELECT 
'{{ provisioningServiceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ data__sku }}',
'{{ etag }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: etag
      value: string
    - name: properties
      value:
        - name: state
          value: string
        - name: publicNetworkAccess
          value: string
        - name: ipFilterRules
          value:
            - - name: filterName
                value: string
              - name: action
                value: string
              - name: ipMask
                value: string
              - name: target
                value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
        - name: provisioningState
          value: string
        - name: iotHubs
          value:
            - - name: applyAllocationPolicy
                value: boolean
              - name: allocationWeight
                value: integer
              - name: name
                value: string
              - name: connectionString
                value: string
              - name: location
                value: string
        - name: allocationPolicy
          value: string
        - name: serviceOperationsHostName
          value: string
        - name: deviceProvisioningHostName
          value: string
        - name: idScope
          value: string
        - name: authorizationPolicies
          value:
            - - name: keyName
                value: string
              - name: primaryKey
                value: string
              - name: secondaryKey
                value: string
              - name: rights
                value: string
        - name: enableDataResidency
          value: boolean
        - name: portalOperationsHostName
          value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

UPDATE example

Updates a iot_dps_resources resource.

/*+ update */
UPDATE azure.iot_hub_device_provisioning.iot_dps_resources
SET 
tags = '{{ tags }}'
WHERE 
provisioningServiceName = '{{ provisioningServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified iot_dps_resources resource.

/*+ delete */
DELETE FROM azure.iot_hub_device_provisioning.iot_dps_resources
WHERE provisioningServiceName = '{{ provisioningServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';