Instance - List By Subscription

Referência

Serviço:: IoT Operations

Versão da API:: 2025-04-01

Listar recursos InstanceResource por ID de assinatura

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	InstanceResourceListResult	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Instance_ListBySubscription

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExtendedLocation	O local estendido é uma extensão dos locais do Azure. Eles fornecem uma maneira de usar seus clusters kubernetes habilitados para Azure ARC como locais de destino para implantar instâncias de serviços do Azure.
ExtendedLocationType	O tipo de definição de enumeração de ExtendedLocation aceito.
InstanceFeature	Os recursos da Instância de AIO.
InstanceFeatureMode	O modo de definição de enumeração de um recurso.
InstanceProperties	As propriedades do recurso instância.
InstanceResource	Um recurso de Instância é um contêiner lógico para um conjunto de recursos filho.
InstanceResourceListResult	A resposta de uma operação de lista InstanceResource.
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
ProvisioningState	A enumeração definindo o status do recurso.
SchemaRegistryRef	A referência ao Registro de Esquema para esta Instância de AIO.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedLocation

Objeto

O local estendido é uma extensão dos locais do Azure. Eles fornecem uma maneira de usar seus clusters kubernetes habilitados para Azure ARC como locais de destino para implantar instâncias de serviços do Azure.

Nome	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationType	Tipo de ExtendedLocation.

ExtendedLocationType

Enumeração

O tipo de definição de enumeração de ExtendedLocation aceito.

Valor	Description
CustomLocation	Tipo CustomLocation

InstanceFeature

Objeto

Os recursos da Instância de AIO.

Nome	Tipo	Description
mode	InstanceFeatureMode	O estado do recurso.
settings	object	As configurações do recurso.

InstanceFeatureMode

Enumeração

O modo de definição de enumeração de um recurso.

Valor	Description
Disabled	Recusar um recurso
Preview	Aceitar para habilitar um recurso de visualização
Stable	Aceitar para habilitar um recurso estável

InstanceProperties

Objeto

As propriedades do recurso instância.

Nome	Tipo	Description
description	string	Descrição detalhada da Instância.
features	<string, InstanceFeature>	Os recursos da Instância de AIO.
provisioningState	ProvisioningState	O status da última operação.
schemaRegistryRef	SchemaRegistryRef	A referência ao Registro de Esquema para esta Instância de AIO.
version	string	A versão do Azure IoT Operations.

InstanceResource

Objeto

Um recurso de Instância é um contêiner lógico para um conjunto de recursos filho.

Nome	Tipo	Description
extendedLocation	ExtendedLocation	Local de borda do recurso.
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	As identidades de serviço gerenciadas atribuídas a esse recurso.
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties	InstanceProperties	As propriedades específicas do recurso para esse recurso.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

InstanceResourceListResult

Objeto

A resposta de uma operação de lista InstanceResource.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	InstanceResource[]	Os itens InstanceResource nesta página

ManagedServiceIdentity

Objeto

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

Nome	Tipo	Description
principalId	string (uuid)	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string (uuid)	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ProvisioningState

Enumeração

A enumeração definindo o status do recurso.

Valor	Description
Accepted	O recurso foi aceito.
Canceled	A criação de recursos foi cancelada.
Deleting	O recurso está excluindo.
Failed	Falha na criação de recursos.
Provisioning	O recurso está sendo provisionado.
Succeeded	O recurso foi criado.
Updating	O recurso está sendo atualizado.

SchemaRegistryRef

Objeto

A referência ao Registro de Esquema para esta Instância de AIO.

Nome	Tipo	Description
resourceId	string (arm-id)	A ID do recurso do Registro de Esquema.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.

Compartilhar via

Instance - List By Subscription

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Instance_ListBySubscription

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationType

InstanceFeature

InstanceFeatureMode

InstanceProperties

InstanceResource

InstanceResourceListResult

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

SchemaRegistryRef

systemData

UserAssignedIdentity