instances

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

Overview

Name	instances
Type	Resource
Id	azure.iot_data_processor.instances

Fields

vw_instances

Name	Datatype	Description
description	text	field from the properties object
extended_location	text	field from the properties object
instanceName	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

instances

Name	Datatype	Description
extendedLocation	object	Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.
location	string	The geo-location where the resource lives
properties	object	The properties of a Instance resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instanceName, resourceGroupName, subscriptionId	Get a Instance
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List Instance resources by resource group
list_by_subscription	SELECT	subscriptionId	List Instance resources by subscription ID
create_or_update	INSERT	instanceName, resourceGroupName, subscriptionId, data__extendedLocation	Create a Instance
delete	DELETE	instanceName, resourceGroupName, subscriptionId	Delete a Instance
update	UPDATE	instanceName, resourceGroupName, subscriptionId	Update a Instance

SELECT examples

List Instance resources by subscription ID

vw_instances

SELECT
description,
extended_location,
instanceName,
location,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.iot_data_processor.vw_instances
WHERE subscriptionId = '{{ subscriptionId }}';

instances

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_data_processor.instances
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.iot_data_processor.instances (
instanceName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
properties,
extendedLocation,
tags,
location
)
SELECT 
'{{ instanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: description
          value: string
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a instances resource.

/*+ update */
UPDATE azure.iot_data_processor.instances
SET 
tags = '{{ tags }}'
WHERE 
instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM azure.iot_data_processor.instances
WHERE instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';