Edit

Share via

Get-AzVirtualRouter

Module:
Az.Network Module

Get an Azure VirtualRouter

Syntax

VirtualRouterSubscriptionIdParameterSet (Default) 

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

VirtualRouterNameParameterSet 

Get-AzVirtualRouter
    -ResourceGroupName <String>
    [-RouterName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

VirtualRouterResourceIdParameterSet 

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

Description

The Get-AzVirtualRouter cmdlet gets an Azure VirtualRouter

Examples

Example 1

Get-AzVirtualRouter -ResourceGroupName virtualRouterRG -RouterName virtualRouter

Example 2

$virtualRouterId = '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/virtualRouterRG/providers/Microsoft.Network/virtualRouters/virtualRouter'
Get-AzVirtualRouter -ResourceId $virtualRouterId

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 virtual router.

Parameter properties

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

Parameter sets

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

-ResourceId

ResourceId of the virtual router.

Parameter properties

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

Parameter sets

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

-RouterName

The name of the virtual router.

Parameter properties

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

Parameter sets

VirtualRouterNameParameterSet
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

PSVirtualRouter