Update-AzIotHubModuleTwin
IoT デバイス モジュール ツインのタグと必要なプロパティを更新します。
構文
Update-AzIotHubModuleTwin
[-ResourceGroupName] <String>
[-IotHubName] <String>
[-DeviceId] <String>
-ModuleId <String>
[-Tag <Hashtable>]
[-Desired <Hashtable>]
[-Partial]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzIotHubModuleTwin
[-InputObject] <PSIotHub>
[-DeviceId] <String>
-ModuleId <String>
[-Tag <Hashtable>]
[-Desired <Hashtable>]
[-Partial]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzIotHubModuleTwin
[-ResourceId] <String>
[-DeviceId] <String>
-ModuleId <String>
[-Tag <Hashtable>]
[-Desired <Hashtable>]
[-Partial]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
デバイス ツインを更新または置き換えます。 詳細については、「 https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-module-twins 」を参照してください。
例
例 1
Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Tag $updatedTag -Desired $updatedDesired -Partial更新されたデバイス モジュール ツイン オブジェクトを返します。
例 2
Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Desired $updatedDesired -Partial必要なプロパティが更新されたデバイス モジュール ツイン オブジェクトを返します。
例 3
Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Tag $updatedTag -Partial更新された tags プロパティを持つデバイス モジュール ツイン オブジェクトを返します。
例 4
Update-AzIotHubModuleTwin -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Tag $updatedTag -Desired $updatedDesired置き換えられたデバイス モジュール ツイン オブジェクトを返します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Desired
モジュール ツインで目的のプロパティを追加または更新します。
| 型: | Hashtable |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DeviceId
ターゲット デバイス ID。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
IotHub オブジェクト
| 型: | PSIotHub |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-IotHubName
IoT ハブの名前
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ModuleId
ターゲット モジュール ID。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Partial
モジュール ツインのタグと必要なプロパティのみを部分的に更新できます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループの名前
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceId
IotHub リソース ID
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Tag
モジュール ツインの tags プロパティを追加または更新します。
| 型: | Hashtable |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |