Devices - Create Or Update

Serviço:: Azure Data Manager for Agriculture

Versão da API:: 2023-11-01-preview

Criar uma entidade de dispositivo.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/devices/{deviceId}?api-version=2023-11-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
deviceId	path	True	string	ID do recurso do dispositivo.
endpoint	path	True	string (uri)	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	ID do parceiro do sensor.
api-version	query	True	string	A versão da API solicitada

Cabeçalho da solicitação

Media Types: "application/merge-patch+json"

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Corpo da solicitação

Media Types: "application/merge-patch+json"

Nome	Tipo	Description
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
deviceDataModelId	string	ID do modelo de dados do dispositivo associado.
hardwareId	string minLength: 0 maxLength: 100	HardwareId do dispositivo.
integrationId	string	ID de integração para o dispositivo.
location	Location	Classe de modelo de localização.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
parentDeviceId	string	ID do dispositivo pai para este dispositivo.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
reportingIntervalInSeconds	integer (int32)	Intervalo no qual o dispositivo envia dados em segundos.
status	string minLength: 0 maxLength: 100	Status do recurso.
type	string minLength: 0 maxLength: 100	Tipo de dispositivo.

Respostas

Nome	Tipo	Description
200 OK	Device	Êxito
201 Created	Device	Criado
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

Device

Êxito

201 Created

Device

Criado

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Devices_CreateOrUpdate

Solicitação de exemplo

HTTP

PATCH {endpoint}/sensor-partners/sp1/devices/d124?api-version=2023-11-01-preview

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Resposta de exemplo

Código de status:: 200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Código de status:: 201

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definições

Nome	Description
Device	Modelo de API do dispositivo.
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
Location	Classe de modelo de localização.

Device

Objeto

Modelo de API do dispositivo.

Nome	Tipo	Description
createdBy	string	Criado por ID de usuário/locatário.
createdDateTime	string (date-time)	Data/hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
deviceDataModelId	string	ID do modelo de dados do dispositivo associado.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
hardwareId	string minLength: 0 maxLength: 100	HardwareId do dispositivo.
id	string	ID do recurso.
integrationId	string	ID de integração para o dispositivo.
location	Location	Classe de modelo de localização.
modifiedBy	string	Modificado pela ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
parentDeviceId	string	ID do dispositivo pai para este dispositivo.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
reportingIntervalInSeconds	integer (int32)	Intervalo no qual o dispositivo envia dados em segundos.
sensorPartnerId	string	ID do parceiro de sensor associado.
status	string minLength: 0 maxLength: 100	Status do recurso.
type	string minLength: 0 maxLength: 100	Tipo de dispositivo.

Error

Objeto

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string minLength: 1	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
message	string minLength: 1	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Objeto

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Objeto

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Location

Objeto

Classe de modelo de localização.

Nome	Tipo	Description
latitude	number (double) minimum: -90 maximum: 90	Latitude do local.
longitude	number (double) minimum: -180 maximum: 180	Longitude do local.

Compartilhar via

Devices - Create Or Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Authorization

Exemplos

Devices_CreateOrUpdate

Solicitação de exemplo

Resposta de exemplo

Definições

Device

Error

ErrorResponse

InnerError

Location