instances

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

Overview

Name	instances
Type	Resource
Id	azure.iotoperations.instances

Fields

vw_instances

Name	Datatype	Description
description	text	field from the properties object
components	text	field from the properties object
extended_location	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
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
schema_registry_namespace	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
version	text	field from the properties object

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.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	The properties of the Instance resource.
tags	object	Resource tags.

Methods

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

SELECT examples

List InstanceResource resources by subscription ID

vw_instances

SELECT
description,
components,
extended_location,
identity,
instanceName,
location,
provisioning_state,
resourceGroupName,
schema_registry_namespace,
subscriptionId,
tags,
version
FROM azure.iotoperations.vw_instances
WHERE subscriptionId = '{{ subscriptionId }}';

instances

SELECT
extendedLocation,
identity,
location,
properties,
tags
FROM azure.iotoperations.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.iotoperations.instances (
instanceName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
properties,
extendedLocation,
identity,
tags,
location
)
SELECT 
'{{ instanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: description
          value: string
        - name: provisioningState
          value: []
        - name: version
          value: string
        - name: schemaRegistryNamespace
          value: string
        - name: components
          value:
            - name: adr
              value:
                - name: state
                  value: []
            - name: akri
              value: []
            - name: connectors
              value: []
            - name: dataflows
              value: []
            - name: schemaRegistry
              value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a instances resource.

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

DELETE example

Deletes the specified instances resource.

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