Invoke-AzIotHubModuleMethod

Módulo:
Az.IotHub Module

Invoque um método de módulo de Borda.

Sintaxe

ResourceSet (Predefinição) 

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

InputObjectSet 

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

ResourceIdSet 

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

Descrição

Invoque um método de módulo de Borda. Veja https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obter mais informações.

Exemplos

Exemplo 1

Invoke-AzIotHubModuleMethod -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -ModuleId "myModule1" -Name "methodName" -Payload "method-input" -ResponseTimeOut 20 -ConnectionTimeOut 15

Invoque um método de módulo de Borda.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ConnectionTimeOut

Número de segundos para aguardar até que uma conexão seja feita com êxito. O padrão é 10.

Propriedades dos parâmetros

Tipo:Int32
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultProfile

As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DeviceId

ID do dispositivo de destino.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Objeto IotHub

Propriedades dos parâmetros

Tipo:PSIotHub
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

InputObjectSet
Posto:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-IotHubName

Nome do Hub Iot

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ResourceSet
Posto:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ModuleId

ID do módulo do dispositivo alvo.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

O nome do método a ser invocado neste módulo de dispositivo.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Payload

A carga útil para o método a ser invocado neste módulo de dispositivo.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ResourceGroupName

Nome do grupo de recursos

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ResourceSet
Posto:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ResourceId

ID do recurso do IotHub

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ResourceIdSet
Posto:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-ResponseTimeOut

Número de segundos para aguardar até que um resultado seja recebido do método direto. O padrão é 10.

Propriedades dos parâmetros

Tipo:Int32
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSIotHub

String

Saídas

PSCloudToDeviceMethodResult