Device Groups - Get

ID로 디바이스 그룹을 가져옵니다.

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

URI 매개 변수

Name In Required Type Description
baseDomain
path True
  • string

모든 Azure IoT Central 서비스 요청에 대한 기본 도메인입니다.

deviceGroupId
path True
  • string

디바이스 그룹의 고유 ID입니다.

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

subdomain
path True
  • string

애플리케이션 하위 도메인입니다.

api-version
query True
  • string

호출되는 API의 버전입니다.

응답

Name Type Description
200 OK

Success

Other Status Codes

IoT Central 서비스에서 받은 오류 응답입니다.

Headers

  • x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

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

정의

DeviceGroup

디바이스 그룹 정의입니다.

Error

응답 오류 정의입니다.

ErrorDetails

오류의 세부 정보입니다.

DeviceGroup

디바이스 그룹 정의입니다.

Name Type Description
description
  • string

디바이스 그룹의 간단한 요약입니다.

displayName
  • string

디바이스 그룹의 표시 이름입니다.

etag
  • string

ETag는 디바이스 그룹 업데이트에서 충돌을 방지하는 데 사용됩니다.

filter
  • string

이 그룹에 있어야 하는 디바이스를 정의하는 쿼리, 쿼리 언어 참조입니다.

id
  • string

디바이스 그룹의 고유 ID입니다.

organizations
  • string[]

디바이스 그룹의 조직 ID 목록, 현재는 하나의 조직만 지원되며, 여러 조직이 곧 지원될 예정입니다.

Error

응답 오류 정의입니다.

Name Type Description
error

현재 요청에 대한 오류 세부 정보입니다.

ErrorDetails

오류의 세부 정보입니다.

Name Type Description
code
  • string

오류 코드

message
  • string

오류 메시지 세부 정보입니다.

requestId
  • string

현재 요청에 대한 상관 관계 ID입니다.

time
  • string

오류 요청이 실패한 시간입니다.