Get-AzVpnGateway
使用 ResourceGroupName 和 GatewayName 取得 VpnGateway 資源,或依 ResourceGroupName 或 SubscriptionId 列出所有閘道。
語法
ListBySubscriptionId (預設值)
Get-AzVpnGateway
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ListByResourceGroupName
Get-AzVpnGateway
[-ResourceGroupName <String>]
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
使用 ResourceGroupName 和 GatewayName 取得 VpnGateway 資源,或依 ResourceGroupName 或 SubscriptionId 列出所有閘道。
範例
範例 1
New-AzResourceGroup -Location "West US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2
Get-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw"
ResourceGroupName : testRG
Name : testvpngw
Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw
Location : West US
VpnGatewayScaleUnit : 2
VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub
BgpSettings : {}
IpConfigurations : {Instance0, Instance1}
Type : Microsoft.Network/vpnGateways
ProvisioningState : Succeeded
上述內容會在 Azure 的 「testRG」 資源群組中建立資源群組、虛擬 WAN、虛擬網路、美國西部的虛擬中樞。 此後,將會在具有 2 個縮放單位的虛擬中樞中建立 VPN 閘道。
然後,它會使用其 resourceGroupName 和閘道名稱來取得 VpnGateway。
範例 2
Get-AzVpnGateway -Name test*
ResourceGroupName : testRG
Name : test1
Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/test1
Location : West US
VpnGatewayScaleUnit : 2
VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub
BgpSettings : {}
IpConfigurations : {Instance0, Instance1}
Type : Microsoft.Network/vpnGateways
ProvisioningState : Succeeded
ResourceGroupName : testRG
Name : test2
Id : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/test2
Location : West US
VpnGatewayScaleUnit : 2
VirtualHub : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub
BgpSettings : {}
IpConfigurations : {Instance0, Instance1}
Type : Microsoft.Network/vpnGateways
ProvisioningState : Succeeded
此 Cmdlet 會取得所有以 “test” 開頭的閘道。
參數
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
參數屬性
| 類型: | IAzureContextContainer |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | AzContext, AzureRmContext, AzureCredential |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
資源名稱。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | True |
| 不要顯示: | False |
| 別名: | 資源名稱, VpnGatewayName |
參數集
ListByResourceGroupName
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ResourceGroupName
資源組名。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | True |
| 不要顯示: | False |
參數集
ListByResourceGroupName
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。