Devices - Replace Properties

デバイスのプロパティを置き換える
デバイスのすべてのプロパティ値をデバイス ID で置き換えます。

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}

URI パラメーター

Name In Required Type Description
baseDomain
path True
  • string

すべての Azure IoT Central サービス要求の基本ドメイン。

deviceId
path True
  • string

デバイスの一意の ID。

subdomain
path True
  • string

アプリケーションサブドメイン。

api-version
query True
  • string

呼び出される API のバージョン。

unmodeled
query
  • boolean

モデル化されていないプロパティをサポートするためのクエリ パラメーター。

要求本文

Name Type Description
body
  • DeviceProperties

デバイスのプロパティ:

応答

Name Type Description
202 Accepted
  • DeviceProperties

成功

Other Status Codes

IoT Central サービスから受信したエラー応答。

Headers

  • x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

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

定義

Error

応答エラーの定義。

ErrorDetails

エラーの詳細情報。

Error

応答エラーの定義。

Name Type Description
error

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージの詳細。

requestId
  • string

現在の要求の関連付け ID。

time
  • string

エラー要求が失敗した時刻。