Device Templates - List

Obtenha a lista de modelos de dispositivo em um aplicativo com suporte básico do ODATA ($top, $filter, $orderby), mais detalhes.

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}

Parâmetros de URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todas as solicitações de serviço do Azure IoT Central.

subdomain
path True
  • string

O subdomínio do aplicativo.

api-version
query True
  • string

A versão da API que está sendo chamada.

$filter
query
  • string

Uma expressão no tipo de recurso que seleciona os recursos a serem retornados.

$orderby
query
  • string

Uma expressão que especifica a ordem dos recursos retornados.

$top
query
  • integer

O número máximo de recursos a serem retornados da coleção.

Respostas

Name Type Description
200 OK

Sucesso

Other Status Codes

Uma resposta de erro recebida do Serviço Central de IoT.

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

DeviceTemplate

A definição do modelo de dispositivo.

DeviceTemplateCollection

Os resultados de páginas de modelos de dispositivo.

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

DeviceTemplate

A definição do modelo de dispositivo.

Name Type Description
@id
  • string

ID exclusiva do modelo de dispositivo.

@type
  • string[]

Os tipos JSON-LD desse modelo de dispositivo.

capabilityModel
  • object

O modelo de funcionalidade utilizado por este modelo de dispositivo.

deploymentManifest
  • object

Manifesto de implantação associado a este modelo de dispositivo.

description
  • string

Descrição detalhada do modelo de dispositivo.

displayName
  • string

Nome de exibição do modelo de dispositivo.

etag
  • string

ETag usada para evitar conflitos em atualizações de modelo de dispositivo.

DeviceTemplateCollection

Os resultados de páginas de modelos de dispositivo.

Name Type Description
nextLink
  • string

URL para obter a próxima página de modelos de dispositivo.

value

A coleção de modelos de dispositivo.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

ID de correlação para a solicitação atual.

time
  • string

A hora em que a solicitação de erro falhou.