Compartilhar via


Catalogs - List Devices

Lista dispositivos para catálogo.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices?api-version=2024-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices?api-version=2024-04-01&$filter={$filter}&$top={$top}&$skip={$skip}&$maxpagesize={$maxpagesize}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
catalogName
path True

string

Nome do catálogo

Padrão Regex: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

$filter
query

string

Filtrar a lista de resultados usando a expressão fornecida

$maxpagesize
query

integer

int32

O número máximo de itens de resultado por página.

$skip
query

integer

int32

O número de itens de resultado a serem ignoradas.

$top
query

integer

int32

O número de itens de resultado a serem retornados.

Respostas

Nome Tipo Description
200 OK

DeviceListResult

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

Catalogs_ListDevices

Solicitação de exemplo

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/listDevices?api-version=2024-04-01

Resposta de exemplo

{
  "value": [
    {
      "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "properties": {}
    },
    {
      "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "properties": {}
    }
  ]
}

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.

Device

Um recurso de dispositivo pertencente a um recurso de grupo de dispositivos.

DeviceListResult

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

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ProvisioningState

Estado de provisionamento do recurso.

systemData

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

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

Device

Um recurso de dispositivo pertencente a um recurso de grupo de dispositivos.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.chipSku

string

SKU do chip

properties.deviceId

string

ID do Dispositivo

properties.lastAvailableOsVersion

string

Versão do sistema operacional disponível para instalação quando a atualização é solicitada

properties.lastInstalledOsVersion

string

Versão do sistema operacional em execução no dispositivo quando a atualização é solicitada

properties.lastOsUpdateUtc

string

Hora em que a atualização solicitada e a nova versão do sistema operacional estão disponíveis

properties.lastUpdateRequestUtc

string

Hora em que a atualização foi solicitada pela última vez

properties.provisioningState

ProvisioningState

O status da última operação.

systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DeviceListResult

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

Nome Tipo Description
nextLink

string

O link para a próxima página de itens

value

Device[]

Os itens do dispositivo nesta página

ErrorAdditionalInfo

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

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

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ProvisioningState

Estado de provisionamento do recurso.

Nome Tipo Description
Accepted

string

A solicitação de criação de recurso foi aceita

Canceled

string

A criação de recursos foi cancelada.

Deleting

string

O recurso está sendo excluído

Failed

string

Falha na criação de recursos.

Provisioning

string

O recurso está sendo provisionado

Succeeded

string

O recurso foi criado.

Updating

string

O recurso está sendo atualizado

systemData

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

Nome Tipo Description
createdAt

string

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

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.