Microsoft.IoTOperations instances 2024-08-15-preview
Bicep resource definition
The instances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-08-15-preview' = {
extendedLocation: {
name: 'string'
type: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
components: {
adr: {
state: 'string'
}
akri: {
state: 'string'
}
connectors: {
state: 'string'
}
dataflows: {
state: 'string'
}
schemaRegistry: {
state: 'string'
}
}
description: 'string'
schemaRegistryNamespace: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
AdrProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the ADR service is enabled. | 'Disabled' 'Enabled' (required) |
AkriInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the AKRI service is enabled. | 'Disabled' 'Enabled' (required) |
Components
| Name | Description | Value |
|---|---|---|
| adr | The properties of the ADR instance. | AdrProperties |
| akri | The properties of the AKRI instance. | AkriInstanceProperties |
| connectors | The properties of the connectors instance. | ConnectorInstanceProperties |
| dataflows | The properties of the dataflows instance. | DataflowInstanceProperties |
| schemaRegistry | The properties of the device provisioning instance. | SchemaRegistryInstanceProperties |
ConnectorInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Connector service is enabled. | 'Disabled' 'Enabled' (required) |
DataflowInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Dataflow service is enabled. | 'Disabled' 'Enabled' (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | Type of ExtendedLocation. | 'CustomLocation' (required) |
InstanceProperties
| Name | Description | Value |
|---|---|---|
| components | The configuration for components of the AIO Instance. | Components |
| description | Detailed description of the Instance. | string |
| schemaRegistryNamespace | The reference to the Schema Registry for this AIO Instance. | string Constraints: Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (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 |
SchemaRegistryInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Schema Registry service is enabled. | 'Disabled' 'Enabled' (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:
- Resource groups - See resource group deployment commands
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-08-15-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"components": {
"adr": {
"state": "string"
},
"akri": {
"state": "string"
},
"connectors": {
"state": "string"
},
"dataflows": {
"state": "string"
},
"schemaRegistry": {
"state": "string"
}
},
"description": "string",
"schemaRegistryNamespace": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
AdrProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the ADR service is enabled. | 'Disabled' 'Enabled' (required) |
AkriInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the AKRI service is enabled. | 'Disabled' 'Enabled' (required) |
Components
| Name | Description | Value |
|---|---|---|
| adr | The properties of the ADR instance. | AdrProperties |
| akri | The properties of the AKRI instance. | AkriInstanceProperties |
| connectors | The properties of the connectors instance. | ConnectorInstanceProperties |
| dataflows | The properties of the dataflows instance. | DataflowInstanceProperties |
| schemaRegistry | The properties of the device provisioning instance. | SchemaRegistryInstanceProperties |
ConnectorInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Connector service is enabled. | 'Disabled' 'Enabled' (required) |
DataflowInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Dataflow service is enabled. | 'Disabled' 'Enabled' (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | Type of ExtendedLocation. | 'CustomLocation' (required) |
InstanceProperties
| Name | Description | Value |
|---|---|---|
| components | The configuration for components of the AIO Instance. | Components |
| description | Detailed description of the Instance. | string |
| schemaRegistryNamespace | The reference to the Schema Registry for this AIO Instance. | string Constraints: Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (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-08-15-preview' |
| 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' |
SchemaRegistryInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Schema Registry service is enabled. | 'Disabled' 'Enabled' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
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-08-15-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
extendedLocation = {
name = "string"
type = "string"
}
properties = {
components = {
adr = {
state = "string"
}
akri = {
state = "string"
}
connectors = {
state = "string"
}
dataflows = {
state = "string"
}
schemaRegistry = {
state = "string"
}
}
description = "string"
schemaRegistryNamespace = "string"
}
})
}
Property Values
AdrProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the ADR service is enabled. | 'Disabled' 'Enabled' (required) |
AkriInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the AKRI service is enabled. | 'Disabled' 'Enabled' (required) |
Components
| Name | Description | Value |
|---|---|---|
| adr | The properties of the ADR instance. | AdrProperties |
| akri | The properties of the AKRI instance. | AkriInstanceProperties |
| connectors | The properties of the connectors instance. | ConnectorInstanceProperties |
| dataflows | The properties of the dataflows instance. | DataflowInstanceProperties |
| schemaRegistry | The properties of the device provisioning instance. | SchemaRegistryInstanceProperties |
ConnectorInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Connector service is enabled. | 'Disabled' 'Enabled' (required) |
DataflowInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Dataflow service is enabled. | 'Disabled' 'Enabled' (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | Type of ExtendedLocation. | 'CustomLocation' (required) |
InstanceProperties
| Name | Description | Value |
|---|---|---|
| components | The configuration for components of the AIO Instance. | Components |
| description | Detailed description of the Instance. | string |
| schemaRegistryNamespace | The reference to the Schema Registry for this AIO Instance. | string Constraints: Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (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-08-15-preview" |
SchemaRegistryInstanceProperties
| Name | Description | Value |
|---|---|---|
| state | This determines if the Schema Registry service is enabled. | 'Disabled' 'Enabled' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|