Get-AzVirtualRouter

Reference

Module:: Az.Network

Get an Azure VirtualRouter

Syntax

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

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

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.

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

-ResourceGroupName

The resource group name of the virtual router.

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

-ResourceId

ResourceId of the virtual router.

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

-RouterName

The name of the virtual router.

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

Inputs

String

Outputs

PSVirtualRouter