Editar

Compartilhar via

Test-AzIotHubRoute

  • Reference
Module:
Az.IotHub

Test routes in IoT Hub

Syntax

Test-AzIotHubRoute
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzIotHubRoute
    [-InputObject] <PSIotHub>
    [-RouteName] <String>
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-ShowError]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzIotHubRoute
    [-InputObject] <PSIotHub>
    [-Source] <PSRoutingSource>
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzIotHubRoute
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-RouteName] <String>
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-ShowError]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzIotHubRoute
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-Source] <PSRoutingSource>
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzIotHubRoute
    [-ResourceId] <String>
    [-RouteName] <String>
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-ShowError]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzIotHubRoute
    [-ResourceId] <String>
    [-Source] <PSRoutingSource>
    [-Body <String>]
    [-AppProperty <Hashtable>]
    [-SystemProperty <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Test a specific route.

Examples

Example 1

Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -Source DeviceMessages

RouteName DataSource     EndpointNames IsEnabled
--------- ----------     ------------- ---------
R1        DeviceMessages events        True
R5        DeviceMessages E1            True

Test all route with source "DeviceMessages".

Example 2

Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1

Result : true

Test a specific route.

Example 3

Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -ShowError

ErrorMessage  Severity LocationStartLine LocationStartColumn LocationEndLine LocationEndColumn
------------  -------- ----------------- ------------------- --------------- -----------------
Syntax error. error    1                 29                  1               30

Test a specific route and showing the reason of failure.

Example 4

$ap = @{}
$ap.add("key0","value0")
$sp = @{}
$sp.add("key1", "value1")
Test-AzIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1 -AppProperty $ap -SystemProperty $sp

Result : true

Test a specific route with AppProperty and SystemProperty.

Parameters

-AppProperty

App properties of the route message

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

-Body

Body of the route message

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-InputObject

IotHub Object

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

-Name

Name of the Iot Hub

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

-ResourceGroupName

Name of the Resource Group

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

-ResourceId

IotHub Resource Id

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

-RouteName

Name of the Route

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

-ShowError

Show detailed error, if exist

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

-Source

Source of the route

Type:PSRoutingSource
Accepted values:Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents, DigitalTwinChangeEvents
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SystemProperty

System properties of the route message

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

Inputs

PSIotHub

String

Outputs

PSTestRouteResult

PSRouteCompilationError

PSRouteProperties[]