Device Groups - Get

Obtenha o grupo de dispositivos por ID.

GET https://{subdomain}.{baseDomain}/api/deviceGroups/{deviceGroupId}?api-version=2022-06-30-preview

Parâmetros de URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todas as solicitações de serviço do Azure IoT Central.

deviceGroupId
path True
  • string

ID exclusiva para o grupo de dispositivos.

Regex pattern: ^[a-zA-Z0-9_-]*$

subdomain
path True
  • string

O subdomínio do aplicativo.

api-version
query True
  • string

A versão da API que está sendo chamada.

Respostas

Name Type Description
200 OK

Êxito

Other Status Codes

Uma resposta de erro recebida do Serviço Do IoT Central.

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Get device group by ID

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/deviceGroups/475cad48-b7ff-4a09-b51e-1a9021385453?api-version=2022-06-30-preview

Sample Response

{
  "id": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "displayName": "DeviceGroupEntry1",
  "description": "This is a default device group containing all the devices for this particular Device Template.",
  "filter": "SELECT * FROM devices WHERE $template = \"dtmi:modelDefinition:dtdlv2\" AND $provisioned = true",
  "organizations": [
    "seattle"
  ]
}

Definições

DeviceGroup

A definição do grupo de dispositivos.

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

DeviceGroup

A definição do grupo de dispositivos.

Name Type Description
description
  • string

Resumo curto do grupo de dispositivos.

displayName
  • string

Nome de exibição do grupo de dispositivos.

etag
  • string

ETag usada para evitar conflitos em atualizações de grupo de dispositivos.

filter
  • string

Consulta definindo quais dispositivos devem estar nesse grupo, Referência de Linguagem de Consulta.

id
  • string

ID exclusiva do grupo de dispositivos.

organizations
  • string[]

Lista de IDs da organização do grupo de dispositivos, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

ID de correlação para a solicitação atual.

time
  • string

A hora em que a solicitação de erro falhou.