Invoke-AzIotHubDeviceMethod

Référence

Module:: Az.IotHub

Appelez une méthode directe sur un appareil.

Syntaxe

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

Description

Appelez une méthode directe sur un appareil. Pour plus d’informations, consultez https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.

Exemples

Exemple 1

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

Appelez une méthode d’appareil.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ConnectionTimeOut

Nombre de secondes à attendre jusqu’à ce qu’une connexion soit établie. La valeur par défaut est 10.

Type:	Int32
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-DeviceId

ID d’appareil cible.

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-InputObject

Objet IotHub

Type:	PSIotHub
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-IotHubName

Nom du hub Iot

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Name

Nom de la méthode à appeler sur cet appareil.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Payload

Charge utile de la méthode à appeler sur cet appareil.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ResourceGroupName

Nom du groupe de ressources

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ResourceId

ID de ressource IotHub

Type:	String
Position:	0
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResponseTimeOut

Nombre de secondes à attendre jusqu’à ce qu’un résultat soit reçu de la méthode directe. La valeur par défaut est 10.

Type:	Int32
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Alias:	wi
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

PSIotHub

String

Sorties

PSCloudToDeviceMethodResult

Partager via