Device Templates - List

Rufen Sie die Liste der Gerätevorlagen in einer Anwendung mit grundlegender ODATA-Unterstützung ($top, $filter, $orderby) ab, weitere Details.

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-Parameter

Name In Required Type Description
baseDomain
path True
  • string

Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.

subdomain
path True
  • string

Die Anwendungsdomäne.

api-version
query True
  • string

Die Version der aufgerufenen API.

$filter
query
  • string

Ein Ausdruck für den Ressourcentyp, der die zu zurückgebenden Ressourcen auswählt.

$orderby
query
  • string

Ein Ausdruck, der die Reihenfolge der zurückgegebenen Ressourcen angibt.

$top
query
  • integer

Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen.

Antworten

Name Type Description
200 OK

Erfolg

Other Status Codes

Eine Fehlerantwort, die vom IoT Central Service empfangen wurde.

Headers

  • x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

DeviceTemplate

Die Gerätevorlagendefinition.

DeviceTemplateCollection

Die seitenseitigen Ergebnisse von Gerätevorlagen.

Error

Die Antwortfehlerdefinition.

ErrorDetails

Die Detailinformationen des Fehlers.

DeviceTemplate

Die Gerätevorlagendefinition.

Name Type Description
@id
  • string

Eindeutige ID der Gerätevorlage.

@type
  • string[]

Die JSON-LD-Typen dieser Gerätevorlage.

capabilityModel
  • object

Das von dieser Gerätevorlage verwendete Funktionsmodell.

deploymentManifest
  • object

Bereitstellungsmanifest, das dieser Gerätevorlage zugeordnet ist.

description
  • string

Detaillierte Beschreibung der Gerätevorlage.

displayName
  • string

Anzeigename der Gerätevorlage.

etag
  • string

ETag wird verwendet, um Konflikte in Gerätevorlagenupdates zu verhindern.

DeviceTemplateCollection

Die seitenseitigen Ergebnisse von Gerätevorlagen.

Name Type Description
nextLink
  • string

URL zum Abrufen der nächsten Seite von Gerätevorlagen.

value

Die Sammlung von Gerätevorlagen.

Error

Die Antwortfehlerdefinition.

Name Type Description
error

Fehlerdetails für aktuelle Anforderung.

ErrorDetails

Die Detailinformationen des Fehlers.

Name Type Description
code
  • string

Fehlercode

message
  • string

Details der Fehlermeldung.

requestId
  • string

Korrelations-ID für aktuelle Anforderung.

time
  • string

Fehler bei der Fehleranforderung.