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

成功

Other Status Codes

IoT Central サービスから受信したエラー応答。

Headers

  • x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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 の一覧。現在サポートされている組織は 1 つだけで、複数の組織が間もなくサポートされます。

Error

応答エラーの定義。

Name Type Description
error

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージの詳細。

requestId
  • string

現在の要求の関連付け ID。

time
  • string

エラー要求が失敗した時刻。