Devices - Replace Properties

Reemplazar las propiedades del dispositivo
Reemplace todos los valores de propiedad de un dispositivo por identificador de 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 identificador URI

Name In Required Type Description
baseDomain
path True
  • string

Dominio base para todas las solicitudes de servicio de Azure IoT Central.

deviceId
path True
  • string

Identificador único del dispositivo.

subdomain
path True
  • string

Subdominio de aplicación.

api-version
query True
  • string

Versión de la API a la que se llama.

unmodeled
query
  • boolean

Parámetro de consulta para admitir propiedades no modeladas.

Cuerpo de la solicitud

Name Type Description
body
  • DeviceProperties

Propiedades del dispositivo:

Respuestas

Name Type Description
202 Accepted
  • DeviceProperties

Correcto

Other Status Codes

Respuesta de error recibida del servicio IoT Central.

Headers

  • x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Definiciones

Error

Definición de error de respuesta.

ErrorDetails

Información detallada del error.

Error

Definición de error de respuesta.

Name Type Description
error

Detalles del error para la solicitud actual.

ErrorDetails

Información detallada del error.

Name Type Description
code
  • string

Código de error.

message
  • string

Detalles del mensaje de error.

requestId
  • string

Id. de correlación para la solicitud actual.

time
  • string

Hora en que se produjo un error en la solicitud de error.