Invoke-AzIotHubDeviceMethod

リファレンス

モジュール:: Az.IotHub

デバイスでダイレクトメソッドを呼び出します。

構文

Invoke-AzIotHubDeviceMethod
      [-ResourceGroupName] <String>
      [-IotHubName] <String>
      [-DeviceId] <String>
      -Name <String>
      [-Payload <String>]
      [-ResponseTimeOut <Int32>]
      [-ConnectionTimeOut <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzIotHubDeviceMethod
      [-InputObject] <PSIotHub>
      [-DeviceId] <String>
      -Name <String>
      [-Payload <String>]
      [-ResponseTimeOut <Int32>]
      [-ConnectionTimeOut <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzIotHubDeviceMethod
      [-ResourceId] <String>
      [-DeviceId] <String>
      -Name <String>
      [-Payload <String>]
      [-ResponseTimeOut <Int32>]
      [-ConnectionTimeOut <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

デバイスでダイレクトメソッドを呼び出します。詳細については、「 https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods 」を参照してください。

例

例 1

Invoke-AzIotHubDeviceMethod -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Name "methodName" -ResponseTimeOut 20 -ConnectionTimeOut 15

デバイスメソッドを呼び出します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionTimeOut

接続が正常に確立されるまで待機する秒数。既定値は 10 です。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceId

ターゲットデバイス ID。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

IotHub オブジェクト

Type:	PSIotHub
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IotHubName

IoT ハブの名前

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

このデバイスで呼び出すメソッドの名前。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Payload

このデバイスで呼び出すメソッドのペイロード。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

リソースグループの名前

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

IotHub リソース ID

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResponseTimeOut

ダイレクトメソッドから結果が受信されるまで待機する秒数。既定値は 10 です。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSIotHub

String

出力

PSCloudToDeviceMethodResult