Get-AzRouteServer

Module:

Az.Network Module

Get an Azure RouteServer

Syntax

RouteServerSubscriptionIdParameterSet (Default)

Get-AzRouteServer
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

RouteServerNameParameterSet

Get-AzRouteServer
    -ResourceGroupName <String>
    [-RouteServerName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

RouteServerResourceIdParameterSet

Get-AzRouteServer
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzRouteServer cmdlet gets an Azure RouteServer

Examples

Example 1

Get-AzRouteServer -ResourceGroupName routeServerRG -RouteServerName routeServer

Example 2

$routeServerId = '/subscriptions/8c992d64-fce9-426d-b278-85642dfeab03/resourceGroups/routeServerRG/providers/Microsoft.Network/virtualHubs/routeServer'
Get-AzRouteServer -ResourceId $routeServerId

Parameters

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The resource group name of the route server.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	True
DontShow:	False

Parameter sets

RouteServerNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceId

ResourceId of the route server.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

RouteServerResourceIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RouteServerName

The name of the route server.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	True
DontShow:	False
Aliases:	ResourceName

Parameter sets

RouteServerNameParameterSet

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

PSRouteServer