Device Templates - List

자세한 내용은 기본 ODATA 지원($top, $filter, $orderby)을 사용하여 애플리케이션의 디바이스 템플릿 목록을 가져옵니다.

GET https://{subdomain}.{baseDomain}/api/deviceTemplates?api-version=2022-06-30-preview
GET https://{subdomain}.{baseDomain}/api/deviceTemplates?api-version=2022-06-30-preview&$filter={$filter}&$top={$top}&$orderby={$orderby}

URI 매개 변수

Name In Required Type Description
baseDomain
path True
  • string

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

subdomain
path True
  • string

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

api-version
query True
  • string

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

$filter
query
  • string

반환할 리소스를 선택하는 리소스 종류에 대한 식입니다.

$orderby
query
  • string

반환된 리소스의 순서를 지정하는 식입니다.

$top
query
  • integer

컬렉션에서 반환할 최대 리소스 수입니다.

응답

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 사용자 계정 가장

예제

List device templates

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/deviceTemplates?api-version=2022-06-30-preview

Sample Response

{
  "value": [
    {
      "@id": "dtmi:contoso:testDeviceTemplate;1",
      "@type": [
        "ModelDefinition",
        "DeviceModel",
        "EdgeModel"
      ],
      "displayName": "Test Definition",
      "etag": "\"~jbzfGhYctc9wtzNZXVmVua5JjTHO/FfjMUJvk9hqkRY=\"",
      "capabilityModel": {
        "@id": "dtmi:contoso:testCapabilityModel;1",
        "@type": "Interface",
        "displayName": "Test Capability Model",
        "extends": [
          {
            "@id": "dtmi:contoso:testInterface;1",
            "@type": "Interface",
            "displayName": "Test Interface",
            "contents": [
              {
                "@type": "Telemetry",
                "displayName": "Test Telemetry",
                "name": "testTelemetry",
                "schema": "double"
              },
              {
                "@type": [
                  "Telemetry",
                  "Event",
                  "EventValue"
                ],
                "displayName": "Test Event",
                "name": "testEvent",
                "schema": "integer",
                "severity": "warning"
              },
              {
                "@type": [
                  "Property",
                  "Initialized"
                ],
                "displayName": "Test Property",
                "name": "testProperty",
                "schema": "string",
                "writable": true,
                "initialValue": "initialValue1"
              },
              {
                "@type": "Property",
                "displayName": "Test Read-Only Property",
                "name": "testReadOnly",
                "schema": "string"
              },
              {
                "@type": "Property",
                "displayName": "Test Complex Property",
                "name": "testComplex",
                "schema": {
                  "@id": "dtmi:contoso:testComplex;1",
                  "@type": "Object",
                  "displayName": "Object",
                  "fields": [
                    {
                      "displayName": "First",
                      "name": "first",
                      "schema": "string"
                    },
                    {
                      "displayName": "Second",
                      "name": "second",
                      "schema": "string"
                    }
                  ]
                },
                "writable": true
              },
              {
                "@type": "Command",
                "commandType": "synchronous",
                "displayName": "Test Command",
                "name": "testCommand",
                "request": {
                  "displayName": "Test Request",
                  "name": "testRequest",
                  "schema": "double"
                },
                "response": {
                  "displayName": "Test Response",
                  "name": "testResponse",
                  "schema": "geopoint"
                }
              },
              {
                "@type": "Property",
                "displayName": "Test Enum",
                "name": "testEnum",
                "schema": {
                  "@id": "dtmi:contoso:testEnum;1",
                  "@type": "Enum",
                  "displayName": "Enum",
                  "enumValues": [
                    {
                      "displayName": "First",
                      "enumValue": 1,
                      "name": "first"
                    },
                    {
                      "displayName": "Second",
                      "enumValue": 2,
                      "name": "second"
                    }
                  ],
                  "valueSchema": "integer"
                },
                "writable": true
              }
            ]
          }
        ],
        "contents": [
          {
            "@type": [
              "Relationship",
              "EdgeModule"
            ],
            "displayName": "Test Module",
            "maxMultiplicity": 1,
            "name": "testModule",
            "target": [
              {
                "@id": "dtmi:contoso:testModuleCapabilityModel;1",
                "@type": "Interface",
                "displayName": "Test Module Capability Model",
                "extends": [
                  {
                    "@id": "dtmi:contoso:testModuleInterface;1",
                    "@type": "Interface",
                    "contents": [
                      {
                        "@type": "Telemetry",
                        "displayName": "Test Module Telemetry",
                        "name": "testModuleTelemetry",
                        "schema": "double"
                      },
                      {
                        "@type": "Property",
                        "displayName": "Test Module Property",
                        "name": "testModuleProperty",
                        "schema": "string",
                        "writable": true
                      }
                    ],
                    "displayName": "Test Module Interface"
                  }
                ]
              }
            ]
          },
          {
            "@type": [
              "Cloud",
              "Property"
            ],
            "displayName": "Test Cloud Property",
            "name": "testCloudProperty",
            "schema": "dateTime"
          }
        ]
      },
      "deploymentManifest": {
        "modulesContent": {
          "$edgeAgent": {
            "properties.desired": {
              "schemaVersion": "1.1",
              "runtime": {
                "type": "docker",
                "settings": {
                  "minDockerVersion": "v1.25",
                  "loggingOptions": "",
                  "registryCredentials": {
                    "ContosoRegistry": {
                      "username": "myacr",
                      "password": "<password>",
                      "address": "myacr.azurecr.io"
                    }
                  }
                }
              },
              "systemModules": {
                "edgeAgent": {
                  "type": "docker",
                  "settings": {
                    "image": "mcr.microsoft.com/azureiotedge-agent:1.1",
                    "createOptions": "{}"
                  }
                },
                "edgeHub": {
                  "type": "docker",
                  "status": "running",
                  "restartPolicy": "always",
                  "startupOrder": 0,
                  "settings": {
                    "image": "mcr.microsoft.com/azureiotedge-hub:1.1",
                    "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}"
                  }
                }
              },
              "modules": {
                "SimulatedTemperatureSensor": {
                  "version": "1.0",
                  "type": "docker",
                  "status": "running",
                  "restartPolicy": "always",
                  "startupOrder": 2,
                  "settings": {
                    "image": "mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0",
                    "createOptions": "{}"
                  }
                },
                "testModule": {
                  "version": "1.0",
                  "type": "docker",
                  "status": "running",
                  "restartPolicy": "always",
                  "startupOrder": 1,
                  "env": {
                    "tempLimit": {
                      "value": "100"
                    }
                  },
                  "settings": {
                    "image": "myacr.azurecr.io/testModule:latest",
                    "createOptions": "{}"
                  }
                }
              }
            }
          },
          "$edgeHub": {
            "properties.desired": {
              "schemaVersion": "1.1",
              "routes": {
                "sensorToFilter": {
                  "route": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/testModule/inputs/input1\")",
                  "priority": 0,
                  "timeToLiveSecs": 1800
                },
                "filterToIoTHub": {
                  "route": "FROM /messages/modules/testModule/outputs/output1 INTO $upstream",
                  "priority": 1,
                  "timeToLiveSecs": 1800
                }
              },
              "storeAndForwardConfiguration": {
                "timeToLiveSecs": 100
              }
            }
          }
        }
      }
    }
  ]
}

정의

DeviceTemplate

디바이스 템플릿 정의입니다.

DeviceTemplateCollection

디바이스 템플릿의 페이징된 결과입니다.

Error

응답 오류 정의입니다.

ErrorDetails

오류의 세부 정보입니다.

DeviceTemplate

디바이스 템플릿 정의입니다.

Name Type Description
@id
  • string

디바이스 템플릿의 고유 ID입니다.

@type
  • string[]

이 디바이스 템플릿의 JSON-LD 형식입니다.

capabilityModel
  • object

이 디바이스 템플릿에서 활용하는 기능 모델입니다.

deploymentManifest
  • object

이 디바이스 템플릿에 연결된 배포 매니페스트입니다.

description
  • string

디바이스 템플릿에 대한 자세한 설명입니다.

displayName
  • string

디바이스 템플릿의 표시 이름입니다.

etag
  • string

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

DeviceTemplateCollection

디바이스 템플릿의 페이징된 결과입니다.

Name Type Description
nextLink
  • string

디바이스 템플릿의 다음 페이지를 가져오는 URL입니다.

value

디바이스 템플릿의 컬렉션입니다.

Error

응답 오류 정의입니다.

Name Type Description
error

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

ErrorDetails

오류의 세부 정보입니다.

Name Type Description
code
  • string

오류 코드

message
  • string

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

requestId
  • string

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

time
  • string

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