Get-AzVirtualRouter
Get an Azure VirtualRouter
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group name of the virtual router.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
ResourceId of the virtual router.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RouterName
The name of the virtual router.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |