Test-AzureRmIotHubRoute
Test routes in IoT Hub
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Test-AzureRmIotHubRoute
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzureRmIotHubRoute
[-InputObject] <PSIotHub>
[-RouteName] <String>
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-ShowError]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzureRmIotHubRoute
[-InputObject] <PSIotHub>
[-Source] <PSRoutingSource>
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzureRmIotHubRoute
[-ResourceGroupName] <String>
[-Name] <String>
[-RouteName] <String>
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-ShowError]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzureRmIotHubRoute
[-ResourceGroupName] <String>
[-Name] <String>
[-Source] <PSRoutingSource>
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzureRmIotHubRoute
[-ResourceId] <String>
[-RouteName] <String>
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-ShowError]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Test-AzureRmIotHubRoute
[-ResourceId] <String>
[-Source] <PSRoutingSource>
[-Body <String>]
[-AppProperty <Hashtable>]
[-SystemProperty <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Test a specific route.
Examples
Example 1
PS C:\> Test-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -Source DeviceMessages
RouteName DataSource EndpointNames IsEnabled
--------- ---------- ------------- ---------
R1 DeviceMessages events True
R5 DeviceMessages E1 True
Test all route with source "DeviceMessges".
Example 2
PS C:\> Test-AzureRmIotHubRoute -ResourceGroupName "myresourcegroup" -Name "myiothub" -RouteName R1
Result : true
Test a specific route.
Example 3
PS C:\> Test-AzureRmIotHubRoute -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.
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: | 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 |
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
System.String
Outputs
Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteCompilationError System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRouteProperties, Microsoft.Azure.Commands.IotHub, Version=3.1.3.0, Culture=neutral, PublicKeyToken=null]]