Share via

Microsoft.IoTOperations instances

  • Article

Bicep resource definition

The instances resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.IoTOperations/instances resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.IoTOperations/instances@2024-11-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    schemaRegistryRef: {
      resourceId: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ExtendedLocation

Name Description Value
name The name of the extended location. string (required)
type Type of ExtendedLocation. 'CustomLocation' (required)

InstanceProperties

Name Description Value
description Detailed description of the Instance. string
schemaRegistryRef The reference to the Schema Registry for this AIO Instance. SchemaRegistryRef (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

Microsoft.IoTOperations/instances

Name Description Value
extendedLocation Edge location of the resource. ExtendedLocation (required)
identity The managed service identities assigned to this resource. ManagedServiceIdentity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required)
properties The resource-specific properties for this resource. InstanceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

SchemaRegistryRef

Name Description Value
resourceId The resource ID of the Schema Registry. string (required)

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

ARM template resource definition

The instances resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.IoTOperations/instances resource, add the following JSON to your template.

{
  "type": "Microsoft.IoTOperations/instances",
  "apiVersion": "2024-11-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "description": "string",
    "schemaRegistryRef": {
      "resourceId": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ExtendedLocation

Name Description Value
name The name of the extended location. string (required)
type Type of ExtendedLocation. 'CustomLocation' (required)

InstanceProperties

Name Description Value
description Detailed description of the Instance. string
schemaRegistryRef The reference to the Schema Registry for this AIO Instance. SchemaRegistryRef (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

Microsoft.IoTOperations/instances

Name Description Value
apiVersion The api version '2024-11-01'
extendedLocation Edge location of the resource. ExtendedLocation (required)
identity The managed service identities assigned to this resource. ManagedServiceIdentity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required)
properties The resource-specific properties for this resource. InstanceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.IoTOperations/instances'

SchemaRegistryRef

Name Description Value
resourceId The resource ID of the Schema Registry. string (required)

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

Terraform (AzAPI provider) resource definition

The instances resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.IoTOperations/instances resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.IoTOperations/instances@2024-11-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      description = "string"
      schemaRegistryRef = {
        resourceId = "string"
      }
    }
  })
}

Property values

ExtendedLocation

Name Description Value
name The name of the extended location. string (required)
type Type of ExtendedLocation. 'CustomLocation' (required)

InstanceProperties

Name Description Value
description Detailed description of the Instance. string
schemaRegistryRef The reference to the Schema Registry for this AIO Instance. SchemaRegistryRef (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

Microsoft.IoTOperations/instances

Name Description Value
extendedLocation Edge location of the resource. ExtendedLocation (required)
identity The managed service identities assigned to this resource. ManagedServiceIdentity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required)
properties The resource-specific properties for this resource. InstanceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.IoTOperations/instances@2024-11-01"

SchemaRegistryRef

Name Description Value
resourceId The resource ID of the Schema Registry. string (required)

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value