instance

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

Overview

Name	instance
Type	Resource
Id	azure.iot_operations.instance

Fields

The following fields are returned by SELECT queries:

get

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.
adrNamespaceRef	object	The Azure Device Registry Namespace used by Assets, Discovered Assets and devices.
defaultSecretProviderClassRef	object	The reference to the AIO Secret provider class.
description	string	Detailed description of the Instance.
extendedLocation	object	Edge location of the resource. Required.
features	object	The features of the AIO Instance.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
schemaRegistryRef	object	The reference to the Schema Registry for this AIO Instance. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The Azure IoT Operations version.

list_by_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.
adrNamespaceRef	object	The Azure Device Registry Namespace used by Assets, Discovered Assets and devices.
defaultSecretProviderClassRef	object	The reference to the AIO Secret provider class.
description	string	Detailed description of the Instance.
extendedLocation	object	Edge location of the resource. Required.
features	object	The features of the AIO Instance.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
schemaRegistryRef	object	The reference to the Schema Registry for this AIO Instance. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The Azure IoT Operations version.

list_by_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.
adrNamespaceRef	object	The Azure Device Registry Namespace used by Assets, Discovered Assets and devices.
defaultSecretProviderClassRef	object	The reference to the AIO Secret provider class.
description	string	Detailed description of the Instance.
extendedLocation	object	Edge location of the resource. Required.
features	object	The features of the AIO Instance.
healthState	string	The health state of the resource. Known values are: "Available", "Degraded", "Unavailable", and "Unknown". (Available, Degraded, Unavailable, Unknown)
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
schemaRegistryRef	object	The reference to the Schema Registry for this AIO Instance. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The Azure IoT Operations version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, instance_name, subscription_id		Get a InstanceResource.
list_by_resource_group	select	resource_group_name, subscription_id		List InstanceResource resources by resource group.
list_by_subscription	select	subscription_id		List InstanceResource resources by subscription ID.
create_or_update	insert	resource_group_name, instance_name, subscription_id, location, extendedLocation		Create a InstanceResource.
update	update	resource_group_name, instance_name, subscription_id		Update a InstanceResource.
create_or_update	replace	resource_group_name, instance_name, subscription_id, location, extendedLocation		Create a InstanceResource.
delete	delete	resource_group_name, instance_name, subscription_id		Delete a InstanceResource.

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
instance_name	string	Name of instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a InstanceResource.

SELECT
id,
name,
adrNamespaceRef,
defaultSecretProviderClassRef,
description,
extendedLocation,
features,
healthState,
identity,
location,
provisioningState,
schemaRegistryRef,
systemData,
tags,
type,
version
FROM azure.iot_operations.instance
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_name = '{{ instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List InstanceResource resources by resource group.

SELECT
id,
name,
adrNamespaceRef,
defaultSecretProviderClassRef,
description,
extendedLocation,
features,
healthState,
identity,
location,
provisioningState,
schemaRegistryRef,
systemData,
tags,
type,
version
FROM azure.iot_operations.instance
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List InstanceResource resources by subscription ID.

SELECT
id,
name,
adrNamespaceRef,
defaultSecretProviderClassRef,
description,
extendedLocation,
features,
healthState,
identity,
location,
provisioningState,
schemaRegistryRef,
systemData,
tags,
type,
version
FROM azure.iot_operations.instance
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a InstanceResource.

INSERT INTO azure.iot_operations.instance (
tags,
location,
properties,
extendedLocation,
identity,
resource_group_name,
instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: instance
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the instance resource.
  - name: instance_name
    value: "{{ instance_name }}"
    description: Required parameter for the instance resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the instance resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"
      version: "{{ version }}"
      schemaRegistryRef:
        resourceId: "{{ resourceId }}"
      defaultSecretProviderClassRef:
        resourceId: "{{ resourceId }}"
      features: "{{ features }}"
      adrNamespaceRef:
        resourceId: "{{ resourceId }}"
      healthState: "{{ healthState }}"
  - name: extendedLocation
    description: |
      Edge location of the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a InstanceResource.

UPDATE azure.iot_operations.instance
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a InstanceResource.

REPLACE azure.iot_operations.instance
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
extendedLocation,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a InstanceResource.

DELETE FROM azure.iot_operations.instance
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_name = '{{ instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;