Get-AzExpressRouteCircuitRouteTableSummary

  • Reference
Module:
Az.Network

Gets a route table summary of an ExpressRoute circuit.

Syntax

Get-AzExpressRouteCircuitRouteTableSummary
   -ResourceGroupName <String>
   -ExpressRouteCircuitName <String>
   -PeeringType <String>
   -DevicePath <DevicePathEnum>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzExpressRouteCircuitRouteTableSummary cmdlet retrieves a summary of BGP neighbor information for a particular routing context. This information is useful to determine for how long a routing context has been established and the number of route prefixes advertised by the peering router.

Examples

Example 1: Display the route summary for the primary path

Get-AzExpressRouteCircuitRouteTableSummary -ResourceGroupName $RG -ExpressRouteCircuitName $CircuitName -DevicePath 'Primary'

Parameters

-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

-DevicePath

The acceptable values for this parameter are: Primary or Secondary

Type:DevicePathEnum
Accepted values:Primary, Secondary
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExpressRouteCircuitName

The name of the ExpressRoute circuit being examined.

Type:String
Aliases:Name, ResourceName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PeeringType

The acceptable values for this parameter are: AzurePrivatePeering, AzurePublicPeering, and MicrosoftPeering

Type:String
Accepted values:AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group containing the ExpressRoute circuit.

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

Inputs

String

Outputs

PSExpressRouteCircuitRoutesTableSummary