次の方法で共有


Devices - Create Or Update Identity

IoT Hubの ID レジストリでデバイスの ID を作成または更新します。

PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12

URI パラメーター

名前 / 必須 説明
id
path True

string

デバイスの一意識別子。

api-version
query True

string

Api のバージョン。

要求ヘッダー

名前 必須 説明
If-Match

string

RFC7232に従って、デバイス ID の弱い ETag を表す文字列。 これは、デバイスの作成時には設定しないでくださいが、デバイスを更新するときに設定される場合があります。

要求本文

名前 説明
authentication

AuthenticationMechanism

デバイスで使用される認証メカニズム。

capabilities

DeviceCapabilities

デバイスの一連の機能。 たとえば、このデバイスがエッジ デバイスかどうか。

cloudToDeviceMessageCount

integer

デバイスに送信される現在キューに登録されているクラウドからデバイスへのメッセージの数。

connectionState enum:
  • Disconnected
  • Connected

デバイスの状態。

connectionStateUpdatedTime

string

接続状態が最後に更新された日時。

deviceId

string

デバイスの一意識別子。

deviceScope

string

デバイスのスコープ。 エッジ デバイスに対して自動生成および変更不可。リーフ デバイスで変更可能で、子と親の関係を作成します。

etag

string

RFC7232に従って、デバイス ID の弱い ETag を表す文字列。

generationId

string

IoT Hub生成される、最大 128 文字の大文字と小文字を区別する文字列。 この値は、デバイスが削除されて再作成された場合に、同じ deviceId を持つデバイスを区別するために使用します。

lastActivityTime

string

デバイスが最後に接続、受信、またはメッセージを送信した日時。

parentScopes

string[]

該当する場合は、上位レベルのエッジ デバイスのスコープ。 エッジ デバイスでのみ使用できます。

status enum:
  • enabled
  • disabled

デバイスの状態。 状態が無効になっている場合、デバイスはサービスに接続できません。

statusReason

string

デバイス ID の状態の理由を格納する 128 文字の文字列。 すべての UTF-8 文字を使用できます。

statusUpdatedTime

string

状態フィールドが最後に更新された日時。

応答

名前 説明
200 OK

Device

OK です。

定義

名前 説明
AuthenticationMechanism
Device
DeviceCapabilities

デバイスで有効になっている機能の状態。

SymmetricKey
X509Thumbprint

AuthenticationMechanism

名前 説明
symmetricKey

SymmetricKey

SAS ベースの認証に使用されるプライマリ キーとセカンダリ キー。

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

サービスへの接続に使用される認証の種類。

x509Thumbprint

X509Thumbprint

x509 ベースの認証に使用されるプライマリとセカンダリの x509 拇印。

Device

名前 説明
authentication

AuthenticationMechanism

デバイスで使用される認証メカニズム。

capabilities

DeviceCapabilities

デバイスの一連の機能。 たとえば、このデバイスがエッジ デバイスかどうか。

cloudToDeviceMessageCount

integer

デバイスに送信される現在キューに登録されているクラウドからデバイスへのメッセージの数。

connectionState enum:
  • Connected
  • Disconnected

デバイスの状態。

connectionStateUpdatedTime

string

接続状態が最後に更新された日時。

deviceId

string

デバイスの一意識別子。

deviceScope

string

デバイスのスコープ。 エッジ デバイスに対して自動生成および変更不可。リーフ デバイスで変更可能で、子と親の関係を作成します。

etag

string

RFC7232に従って、デバイス ID の弱い ETag を表す文字列。

generationId

string

IoT Hub生成される、最大 128 文字の大文字と小文字を区別する文字列。 この値は、デバイスが削除されて再作成された場合に、同じ deviceId を持つデバイスを区別するために使用します。

lastActivityTime

string

デバイスが最後に接続、受信、またはメッセージを送信した日時。

parentScopes

string[]

該当する場合は、上位レベルのエッジ デバイスのスコープ。 エッジ デバイスでのみ使用できます。

status enum:
  • disabled
  • enabled

デバイスの状態。 状態が無効になっている場合、デバイスはサービスに接続できません。

statusReason

string

デバイス ID の状態の理由を格納する 128 文字の文字列。 すべての UTF-8 文字を使用できます。

statusUpdatedTime

string

状態フィールドが最後に更新された日時。

DeviceCapabilities

デバイスで有効になっている機能の状態。

名前 説明
iotEdge

boolean

デバイスがエッジ デバイスかどうかを決定する プロパティ。

SymmetricKey

名前 説明
primaryKey

string

デバイスの base64 でエンコードされた主キー。

secondaryKey

string

デバイスの base64 でエンコードされたセカンダリ キー。

X509Thumbprint

名前 説明
primaryThumbprint

string

X509 クライアント証明書のプライマリ拇印。

secondaryThumbprint

string

X509 クライアント証明書のセカンダリ拇印。