Devices - Replace Properties

Substituir propriedades do dispositivo
Substitua todos os valores de propriedade de um dispositivo pela ID do dispositivo.

PUT https://{subdomain}.{baseDomain}/api/devices/{deviceId}/properties?api-version=2022-06-30-preview
PUT https://{subdomain}.{baseDomain}/api/devices/{deviceId}/properties?api-version=2022-06-30-preview&unmodeled={unmodeled}

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.

deviceId
path True
  • string

ID exclusiva do dispositivo.

subdomain
path True
  • string

O subdomínio do aplicativo.

api-version
query True
  • string

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

unmodeled
query
  • boolean

O parâmetro de consulta para dar suporte a propriedades não modeladas.

Corpo da solicitação

Name Type Description
body
  • DeviceProperties

As propriedades do dispositivo.

Respostas

Name Type Description
202 Accepted
  • DeviceProperties

Êxito

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

Update properties

Sample Request

PATCH https://appsubdomain.azureiotcentral.com/api/devices/mx1/properties?api-version=2022-06-30-preview

{
  "settings": {
    "voltage": 25,
    "current": 7
  }
}

Sample Response

{
  "settings": {
    "$metadata": {
      "voltage": {
        "desiredValue": 25
      },
      "current": {
        "desiredValue": 7
      }
    }
  }
}

Definições

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

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.