Get-AzLocalNetworkGateway
Gets a Local Network Gateway
Syntax
Default (Default)
Get-AzLocalNetworkGateway
[-Name <String>]
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Local Network Gateway is the object representing your VPN device On-Premises. The Get-AzLocalNetworkGateway cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name.
Examples
Example 1: Get a Local Network Gateway
Get-AzLocalNetworkGateway -Name myLocalGW1 -ResourceGroupName myRG
Name : myLocalGW1
ResourceGroupName : myRG
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M
icrosoft.Network/localNetworkGateways/myLocalGW1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
GatewayIpAddress : x.x.x.x
LocalNetworkAddressSpace : {
"AddressPrefixes": []
}
BgpSettings : null
Returns the object of the Local Network Gateway with the name "myLocalGW1" within the resource group "myRG"
Example 2: Get Local Network Gateways using filtering
Get-AzLocalNetworkGateway -Name myLocalGW* -ResourceGroupName myRG
Name : myLocalGW1
ResourceGroupName : myRG
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M
icrosoft.Network/localNetworkGateways/myLocalGW1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
GatewayIpAddress : x.x.x.x
LocalNetworkAddressSpace : {
"AddressPrefixes": []
}
BgpSettings : null
Name : myLocalGW2
ResourceGroupName : myRG
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M
icrosoft.Network/localNetworkGateways/myLocalGW2
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
GatewayIpAddress : x.x.x.x
LocalNetworkAddressSpace : {
"AddressPrefixes": []
}
BgpSettings : null
Returns the object of the Local Network Gateway with name starting with "myLocalGW" within the resource group "myRG"
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 |
-Name
The Local Network Gateway is the object representing your VPN device On-Premises. The Get-AzLocalNetworkGateway cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The Local Network Gateway is the object representing your VPN device On-Premises. The Get-AzLocalNetworkGateway cmdlet returns the object representing your on-prem gateway based on Name and Resource Group Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| 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.