Get-AzVirtualNetwork
Gets a virtual network in a resource group.
Syntax
NoExpand
Get-AzVirtualNetwork
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Expand
Get-AzVirtualNetwork
-Name <String>
-ResourceGroupName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzVirtualNetwork cmdlet gets one or more virtual networks in a resource group.
Examples
Example 1: Retrieve a virtual network
Get-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup
Name : MyVirtualNetwork1
ResourceGroupName : TestResourceGroup
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup
/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
AddressSpace : {
"AddressPrefixes": [
"xx.x.x.x/x"
]
}
DhcpOptions : {}
FlowTimeoutInMinutes : null
Subnets : []
VirtualNetworkPeerings : []
EnableDdosProtection : false
DdosProtectionPlan : null
This command gets the virtual network named MyVirtualNetwork in the resource group TestResourceGroup
Example 2: List virtual networks using filter
Get-AzVirtualNetwork -Name MyVirtualNetwork*
Name : MyVirtualNetwork1
ResourceGroupName : TestResourceGroup
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup
/providers/Microsoft.Network/virtualNetworks/MyVirtualNetwork1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
AddressSpace : {
"AddressPrefixes": [
"xx.x.x.x/x"
]
}
DhcpOptions : {}
FlowTimeoutInMinutes : null
Subnets : []
VirtualNetworkPeerings : []
EnableDdosProtection : false
DdosProtectionPlan : null
This command gets all virtual networks that start with "MyVirtualNetwork".
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 |
-ExpandResource
The Get-AzVirtualNetwork cmdlet gets one or more virtual networks in a resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Expand
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of the virtual network that this cmdlet gets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
NoExpand
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of the resource group that virtual network belongs to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
NoExpand
| 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.
