Поделиться через


Instance - List By Subscription

Перечисление ресурсов InstanceResource по идентификатору подписки

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

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

InstanceResourceListResult

Операция Azure успешно завершена.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Instance_ListBySubscription

Образец запроса

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

Пример ответа

{
  "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"
}

Определения

Имя Описание
AzureDeviceRegistryNamespaceRef

Справочник по пространству имен Реестра устройств Azure.

createdByType

Тип удостоверения, создавшего ресурс.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

ExtendedLocation

Расширенное расположение — это расширение расположений Azure. Они позволяют использовать кластеры Kubernetes с поддержкой Azure ARC в качестве целевых расположений для развертывания экземпляров служб Azure.

ExtendedLocationType

Тип перечисления, определяющий ExtendedLocation, принимается.

InstanceFeature

Функции экземпляра AIO.

InstanceFeatureMode

Режим перечисления, определяющий функцию.

InstanceProperties

Свойства ресурса Instance.

InstanceResource

Ресурс экземпляра — это логический контейнер для набора дочерних ресурсов.

InstanceResourceListResult

Ответ операции со списком InstanceResource.

ManagedServiceIdentity

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

ProvisioningState

Перечисление, определяющее состояние ресурса.

ResourceHealthState

Состояние работоспособности ресурса.

SchemaRegistryRef

Ссылка на реестр схем для этого экземпляра AIO.

SecretProviderClassRef

Ссылка на класс провайдера AIO Secret.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

AzureDeviceRegistryNamespaceRef

Справочник по пространству имен Реестра устройств Azure.

Имя Тип Описание
resourceId

string (arm-id)

Идентификатор ресурса пространства имен реестра устройств Azure.

createdByType

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительная информация.

type

string

Тип дополнительной информации.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Ошибка дополнительная информация.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Цель ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ExtendedLocation

Расширенное расположение — это расширение расположений Azure. Они позволяют использовать кластеры Kubernetes с поддержкой Azure ARC в качестве целевых расположений для развертывания экземпляров служб Azure.

Имя Тип Описание
name

string

Имя расширенного расположения.

type

ExtendedLocationType

Тип ExtendedLocation.

ExtendedLocationType

Тип перечисления, определяющий ExtendedLocation, принимается.

Значение Описание
CustomLocation

Тип CustomLocation

InstanceFeature

Функции экземпляра AIO.

Имя Тип Описание
mode

InstanceFeatureMode

Состояние функции.

settings

object

Параметры функции.

InstanceFeatureMode

Режим перечисления, определяющий функцию.

Значение Описание
Stable

Дайте согласие на включение стабильной функции

Preview

Согласитесь, чтобы включить функцию предварительного просмотра

Disabled

Как отказаться от функции

InstanceProperties

Свойства ресурса Instance.

Имя Тип Default value Описание
adrNamespaceRef

AzureDeviceRegistryNamespaceRef

Пространство имен реестра устройств Azure, используемое активами, обнаруженными активами и устройствами

defaultSecretProviderClassRef

SecretProviderClassRef

Ссылка на класс провайдера AIO Secret.

description

string

Подробное описание экземпляра.

features

<string,  InstanceFeature>

Функции экземпляра AIO.

healthState

ResourceHealthState

Unknown

Состояние работоспособности ресурса.

provisioningState

ProvisioningState

Состояние последней операции.

schemaRegistryRef

SchemaRegistryRef

Ссылка на реестр схем для этого экземпляра AIO.

version

string

Версия Azure IoT Operations.

InstanceResource

Ресурс экземпляра — это логический контейнер для набора дочерних ресурсов.

Имя Тип Описание
extendedLocation

ExtendedLocation

Пограничное расположение ресурса.

id

string (arm-id)

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

Удостоверения управляемой службы, назначенные этому ресурсу.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса

properties

InstanceProperties

Свойства, относящиеся к ресурсу, для этого ресурса.

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

InstanceResourceListResult

Ответ операции со списком InstanceResource.

Имя Тип Описание
nextLink

string (uri)

Ссылка на следующую страницу элементов

value

InstanceResource[]

Элементы InstanceResource на этой странице

ManagedServiceIdentity

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя Тип Описание
principalId

string (uuid)

Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.

tenantId

string (uuid)

Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.

type

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

userAssignedIdentities

<string,  UserAssignedIdentity>

удостоверения User-Assigned
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Перечисление, определяющее состояние ресурса.

Значение Описание
Succeeded

Ресурс создан.

Failed

Не удалось создать ресурс.

Canceled

Создание ресурсов было отменено.

Provisioning

Ресурс инициализируется.

Updating

Ресурс обновляется.

Deleting

Ресурс удаляется.

Accepted

Ресурс принят.

ResourceHealthState

Состояние работоспособности ресурса.

Значение Описание
Available

Ресурс доступен и функционирует как ожидается.

Degraded

Работоспособность ресурсов ухудшается.

Unavailable

Ресурс не функционирует должным образом.

Unknown

Состояние ресурса неизвестно.

SchemaRegistryRef

Ссылка на реестр схем для этого экземпляра AIO.

Имя Тип Описание
resourceId

string (arm-id)

Идентификатор ресурса реестра схем.

SecretProviderClassRef

Ссылка на класс провайдера AIO Secret.

Имя Тип Описание
resourceId

string (arm-id)

Идентификатор ресурса класса поставщика AIO Secret.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string (date-time)

Временная метка последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

Имя Тип Описание
clientId

string (uuid)

Идентификатор клиента назначенного удостоверения.

principalId

string (uuid)

Основной идентификатор назначенного удостоверения.