Get-AzVpnGateway
Obtém um recurso VpnGateway usando ResourceGroupName e GatewayName OU lista todos os gateways por ResourceGroupName ou SubscriptionId.
Sintaxe
ListBySubscriptionId (Predefinição)
Get-AzVpnGateway
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ListByResourceGroupName
Get-AzVpnGateway
[-ResourceGroupName <String>]
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Obtém um recurso VpnGateway usando ResourceGroupName e GatewayName OU lista todos os gateways por ResourceGroupName ou SubscriptionId.
Exemplos
Exemplo 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
O acima criará um grupo de recursos, WAN Virtual, Rede Virtual, Virtual Hub no Oeste dos EUA, no grupo de recursos "testRG" no Azure. Um gateway VPN será criado posteriormente no Hub Virtual com 2 unidades de escala.
Em seguida, ele obtém o VpnGateway usando seu resourceGroupName e o nome do gateway.
Exemplo 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
Este cmdlet obtém todos os Gateways que começam com "test".
Parâmetros
-DefaultProfile
As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.
Propriedades dos parâmetros
| Tipo: | IAzureContextContainer |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Name
O nome do recurso.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
| Aliases: | Nome do Recurso, VpnGatewayName |
Conjuntos de parâmetros
ListByResourceGroupName
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-ResourceGroupName
O nome do grupo de recursos.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
ListByResourceGroupName
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.