instances

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

Overview

Name	instances
Type	Resource
Id	azure.iot_data_processor.instances

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

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

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
instanceName	string	Name of instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Instance

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_data_processor.instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
;

list_by_resource_group

List Instance resources by resource group

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

list_by_subscription

List Instance resources by subscription ID

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

INSERT examples

create_or_update

Create a Instance

INSERT INTO azure.iot_data_processor.instances (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
instanceName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ instanceName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the instances resource.
    - name: instanceName
      value: string
      description: Required parameter for the instances resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Edge location of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a Instance

UPDATE azure.iot_data_processor.instances
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete a Instance

DELETE FROM azure.iot_data_processor.instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
;