Instance - List By Subscription

Service:: IoT Operations

API Version:: 2026-03-01

List InstanceResource resources by subscription ID

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTOperations/instances?api-version=2026-03-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	InstanceResourceListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Instance_ListBySubscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/providers/Microsoft.IoTOperations/instances?api-version=2026-03-01

Sample response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "version": "1.2.0",
        "schemaRegistryRef": {
          "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123"
        },
        "description": "empgqmbhvklcqlyahmdsjemlep"
      },
      "extendedLocation": {
        "name": "/subscriptions/F8C729F9-DF9C-4743-848F-96EE433D8E53/resourceGroups/rgiotoperations/providers/Microsoft.ExtendedLocation/customLocations/resource-123",
        "type": "CustomLocation"
      },
      "identity": {
        "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327",
        "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec",
        "type": "None",
        "userAssignedIdentities": {}
      },
      "tags": {},
      "location": "eastus2",
      "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123",
      "name": "llptmlifnqqwairx",
      "type": "Microsoft.IoTOperations/instances",
      "systemData": {
        "createdBy": "contosouser",
        "createdByType": "User",
        "createdAt": "2024-08-09T18:13:29.389Z",
        "lastModifiedBy": "contosouser",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-08-09T18:13:29.389Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definitions

Name	Description
AzureDeviceRegistryNamespaceRef	Azure Device Registry Namespace reference.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	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.
ExtendedLocationType	The enum defining type of ExtendedLocation accepted.
InstanceFeature	The features of the AIO Instance.
InstanceFeatureMode	The enum defining mode of a feature.
InstanceProperties	The properties of the Instance resource.
InstanceResource	A Instance resource is a logical container for a set of child resources.
InstanceResourceListResult	The response of a InstanceResource list operation.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
ProvisioningState	The enum defining status of resource.
ResourceHealthState	The health state of the resource.
SchemaRegistryRef	The reference to the Schema Registry for this AIO Instance.
SecretProviderClassRef	The reference to the AIO Secret provider class.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

AzureDeviceRegistryNamespaceRef

Object

Azure Device Registry Namespace reference.

Name	Type	Description
resourceId	string (arm-id)	The resource ID of the Azure Device Registry Namespace.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationType	Type of ExtendedLocation.

ExtendedLocationType

Enumeration

The enum defining type of ExtendedLocation accepted.

Value	Description
CustomLocation	CustomLocation type

InstanceFeature

Object

The features of the AIO Instance.

Name	Type	Description
mode	InstanceFeatureMode	The state of the feature.
settings	object	The settings of the feature.

InstanceFeatureMode

Enumeration

The enum defining mode of a feature.

Value	Description
Stable	Opt in to enable a stable feature
Preview	Opt in to enable a preview feature
Disabled	Opt out of a feature

InstanceProperties

Object

The properties of the Instance resource.

Name	Type	Default value	Description
adrNamespaceRef	AzureDeviceRegistryNamespaceRef		The Azure Device Registry Namespace used by Assets, Discovered Assets and devices
defaultSecretProviderClassRef	SecretProviderClassRef		The reference to the AIO Secret provider class.
description	string		Detailed description of the Instance.
features	<string, InstanceFeature>		The features of the AIO Instance.
healthState	ResourceHealthState	Unknown	The health state of the resource.
provisioningState	ProvisioningState		The status of the last operation.
schemaRegistryRef	SchemaRegistryRef		The reference to the Schema Registry for this AIO Instance.
version	string		The Azure IoT Operations version.

InstanceResource

Object

A Instance resource is a logical container for a set of child resources.

Name	Type	Description
extendedLocation	ExtendedLocation	Edge location of the resource.
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	InstanceProperties	The resource-specific properties for this resource.
systemData	systemData	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"

InstanceResourceListResult

Object

The response of a InstanceResource list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	InstanceResource[]	The InstanceResource items on this page

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities 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.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Enumeration

The enum defining status of resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Provisioning	Resource is getting provisioned.
Updating	Resource is Updating.
Deleting	Resource is Deleting.
Accepted	Resource has been Accepted.

ResourceHealthState

Enumeration

The health state of the resource.

Value	Description
Available	Resource is Available and functioning as expected.
Degraded	Resource health is degraded.
Unavailable	Resource is not functioning as expected.
Unknown	Resource state is unknown.

SchemaRegistryRef

Object

The reference to the Schema Registry for this AIO Instance.

Name	Type	Description
resourceId	string (arm-id)	The resource ID of the Schema Registry.

SecretProviderClassRef

Object

The reference to the AIO Secret provider class.

Name	Type	Description
resourceId	string (arm-id)	The resource ID of the AIO Secret provider class.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Share via

Instance - List By Subscription

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Instance_ListBySubscription

Sample request

Sample response

Definitions

AzureDeviceRegistryNamespaceRef

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

InstanceFeature

InstanceFeatureMode

InstanceProperties

InstanceResource

InstanceResourceListResult

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

ResourceHealthState

SchemaRegistryRef

SecretProviderClassRef

systemData

UserAssignedIdentity