Device Groups - Get

Obtenga el grupo de dispositivos por identificador.

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

Parámetros de identificador URI

Name In Required Type Description
baseDomain
path True
  • string

Dominio base para todas las solicitudes de servicio de Azure IoT Central.

deviceGroupId
path True
  • string

Identificador único del grupo de dispositivos.

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

subdomain
path True
  • string

Subdominio de aplicación.

api-version
query True
  • string

Versión de la API a la que se llama.

Respuestas

Name Type Description
200 OK

Correcto

Other Status Codes

Respuesta de error recibida del servicio IoT Central.

Headers

  • x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Definiciones

DeviceGroup

Definición del grupo de dispositivos.

Error

Definición de error de respuesta.

ErrorDetails

Información detallada del error.

DeviceGroup

Definición del grupo de dispositivos.

Name Type Description
description
  • string

Breve resumen del grupo de dispositivos.

displayName
  • string

Nombre para mostrar del grupo de dispositivos.

etag
  • string

ETag usado para evitar conflictos en las actualizaciones del grupo de dispositivos.

filter
  • string

Consulta que define qué dispositivos deben estar en este grupo, Referencia del lenguaje de consulta.

id
  • string

Identificador único del grupo de dispositivos.

organizations
  • string[]

Lista de identificadores de organización del grupo de dispositivos, actualmente solo se admite una organización, próximamente se admitirán varias organizaciones.

Error

Definición de error de respuesta.

Name Type Description
error

Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Name Type Description
code
  • string

Código de error.

message
  • string

Detalles del mensaje de error.

requestId
  • string

Id. de correlación para la solicitud actual.

time
  • string

Hora en que se produjo un error en la solicitud de error.