Azure v6.21.0, Mar 7 25

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

azure.network.getVirtualNetworkGateway

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getVirtualNetworkGateway({
    name: "production",
    resourceGroupName: "networking",
});
export const virtualNetworkGatewayId = example.then(example => example.id);

import pulumi
import pulumi_azure as azure

example = azure.network.get_virtual_network_gateway(name="production",
    resource_group_name="networking")
pulumi.export("virtualNetworkGatewayId", example.id)

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := network.LookupVirtualNetworkGateway(ctx, &network.LookupVirtualNetworkGatewayArgs{
			Name:              "production",
			ResourceGroupName: "networking",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("virtualNetworkGatewayId", example.Id)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Network.GetVirtualNetworkGateway.Invoke(new()
    {
        Name = "production",
        ResourceGroupName = "networking",
    });

    return new Dictionary<string, object?>
    {
        ["virtualNetworkGatewayId"] = example.Apply(getVirtualNetworkGatewayResult => getVirtualNetworkGatewayResult.Id),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetVirtualNetworkGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetworkFunctions.getVirtualNetworkGateway(GetVirtualNetworkGatewayArgs.builder()
            .name("production")
            .resourceGroupName("networking")
            .build());

        ctx.export("virtualNetworkGatewayId", example.applyValue(getVirtualNetworkGatewayResult -> getVirtualNetworkGatewayResult.id()));
    }
}

variables:
  example:
    fn::invoke:
      function: azure:network:getVirtualNetworkGateway
      arguments:
        name: production
        resourceGroupName: networking
outputs:
  virtualNetworkGatewayId: ${example.id}

Using getVirtualNetworkGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVirtualNetworkGateway(args: GetVirtualNetworkGatewayArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayResult>
function getVirtualNetworkGatewayOutput(args: GetVirtualNetworkGatewayOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayResult>

def get_virtual_network_gateway(name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayResult
def get_virtual_network_gateway_output(name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayResult]

func LookupVirtualNetworkGateway(ctx *Context, args *LookupVirtualNetworkGatewayArgs, opts ...InvokeOption) (*LookupVirtualNetworkGatewayResult, error)
func LookupVirtualNetworkGatewayOutput(ctx *Context, args *LookupVirtualNetworkGatewayOutputArgs, opts ...InvokeOption) LookupVirtualNetworkGatewayResultOutput

> Note: This function is named LookupVirtualNetworkGateway in the Go SDK.

public static class GetVirtualNetworkGateway 
{
    public static Task<GetVirtualNetworkGatewayResult> InvokeAsync(GetVirtualNetworkGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayResult> Invoke(GetVirtualNetworkGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualNetworkGatewayResult> getVirtualNetworkGateway(GetVirtualNetworkGatewayArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkGatewayResult> getVirtualNetworkGateway(GetVirtualNetworkGatewayArgs args, InvokeOptions options)

fn::invoke:
  function: azure:network/getVirtualNetworkGateway:getVirtualNetworkGateway
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specifies the name of the Virtual Network Gateway.
ResourceGroupName string: Specifies the name of the resource group the Virtual Network Gateway is located in.

Name string: Specifies the name of the Virtual Network Gateway.
ResourceGroupName string: Specifies the name of the resource group the Virtual Network Gateway is located in.

name String: Specifies the name of the Virtual Network Gateway.
resourceGroupName String: Specifies the name of the resource group the Virtual Network Gateway is located in.

name string: Specifies the name of the Virtual Network Gateway.
resourceGroupName string: Specifies the name of the resource group the Virtual Network Gateway is located in.

name str: Specifies the name of the Virtual Network Gateway.
resource_group_name str: Specifies the name of the resource group the Virtual Network Gateway is located in.

name String: Specifies the name of the Virtual Network Gateway.
resourceGroupName String: Specifies the name of the resource group the Virtual Network Gateway is located in.

getVirtualNetworkGateway Result

The following output properties are available:

ActiveActive bool: Is this an Active-Active Gateway?
BgpSettings List<GetVirtualNetworkGatewayBgpSetting>
CustomRoutes List<GetVirtualNetworkGatewayCustomRoute>
DefaultLocalNetworkGatewayId string: The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.
EnableBgp bool: Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.
Generation string: The Generation of the Virtual Network Gateway.
Id string: The provider-assigned unique ID for this managed resource.
IpConfigurations List<GetVirtualNetworkGatewayIpConfiguration>: One or two ip_configuration blocks documented below.
Location string: The location/region where the Virtual Network Gateway is located.
Name string: The user-defined name of the root certificate.
PrivateIpAddressEnabled bool: Whether a private IP will be used for this gateway for connections.
ResourceGroupName string
Sku string: Configuration of the size and capacity of the Virtual Network Gateway.
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.
Type string: The type of the Virtual Network Gateway.
VpnClientConfigurations List<GetVirtualNetworkGatewayVpnClientConfiguration>: A vpn_client_configuration block which is documented below.
VpnType string: The routing type of the Virtual Network Gateway.

ActiveActive bool: Is this an Active-Active Gateway?
BgpSettings []GetVirtualNetworkGatewayBgpSetting
CustomRoutes []GetVirtualNetworkGatewayCustomRoute
DefaultLocalNetworkGatewayId string: The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.
EnableBgp bool: Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.
Generation string: The Generation of the Virtual Network Gateway.
Id string: The provider-assigned unique ID for this managed resource.
IpConfigurations []GetVirtualNetworkGatewayIpConfiguration: One or two ip_configuration blocks documented below.
Location string: The location/region where the Virtual Network Gateway is located.
Name string: The user-defined name of the root certificate.
PrivateIpAddressEnabled bool: Whether a private IP will be used for this gateway for connections.
ResourceGroupName string
Sku string: Configuration of the size and capacity of the Virtual Network Gateway.
Tags map[string]string: A mapping of tags assigned to the resource.
Type string: The type of the Virtual Network Gateway.
VpnClientConfigurations []GetVirtualNetworkGatewayVpnClientConfiguration: A vpn_client_configuration block which is documented below.
VpnType string: The routing type of the Virtual Network Gateway.

activeActive Boolean: Is this an Active-Active Gateway?
bgpSettings List<GetVirtualNetworkGatewayBgpSetting>
customRoutes List<GetVirtualNetworkGatewayCustomRoute>
defaultLocalNetworkGatewayId String: The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.
enableBgp Boolean: Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.
generation String: The Generation of the Virtual Network Gateway.
id String: The provider-assigned unique ID for this managed resource.
ipConfigurations List<GetVirtualNetworkGatewayIpConfiguration>: One or two ip_configuration blocks documented below.
location String: The location/region where the Virtual Network Gateway is located.
name String: The user-defined name of the root certificate.
privateIpAddressEnabled Boolean: Whether a private IP will be used for this gateway for connections.
resourceGroupName String
sku String: Configuration of the size and capacity of the Virtual Network Gateway.
tags Map<String,String>: A mapping of tags assigned to the resource.
type String: The type of the Virtual Network Gateway.
vpnClientConfigurations List<GetVirtualNetworkGatewayVpnClientConfiguration>: A vpn_client_configuration block which is documented below.
vpnType String: The routing type of the Virtual Network Gateway.

activeActive boolean: Is this an Active-Active Gateway?
bgpSettings GetVirtualNetworkGatewayBgpSetting[]
customRoutes GetVirtualNetworkGatewayCustomRoute[]
defaultLocalNetworkGatewayId string: The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.
enableBgp boolean: Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.
generation string: The Generation of the Virtual Network Gateway.
id string: The provider-assigned unique ID for this managed resource.
ipConfigurations GetVirtualNetworkGatewayIpConfiguration[]: One or two ip_configuration blocks documented below.
location string: The location/region where the Virtual Network Gateway is located.
name string: The user-defined name of the root certificate.
privateIpAddressEnabled boolean: Whether a private IP will be used for this gateway for connections.
resourceGroupName string
sku string: Configuration of the size and capacity of the Virtual Network Gateway.
tags {[key: string]: string}: A mapping of tags assigned to the resource.
type string: The type of the Virtual Network Gateway.
vpnClientConfigurations GetVirtualNetworkGatewayVpnClientConfiguration[]: A vpn_client_configuration block which is documented below.
vpnType string: The routing type of the Virtual Network Gateway.

active_active bool: Is this an Active-Active Gateway?
bgp_settings Sequence[GetVirtualNetworkGatewayBgpSetting]
custom_routes Sequence[GetVirtualNetworkGatewayCustomRoute]
default_local_network_gateway_id str: The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.
enable_bgp bool: Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.
generation str: The Generation of the Virtual Network Gateway.
id str: The provider-assigned unique ID for this managed resource.
ip_configurations Sequence[GetVirtualNetworkGatewayIpConfiguration]: One or two ip_configuration blocks documented below.
location str: The location/region where the Virtual Network Gateway is located.
name str: The user-defined name of the root certificate.
private_ip_address_enabled bool: Whether a private IP will be used for this gateway for connections.
resource_group_name str
sku str: Configuration of the size and capacity of the Virtual Network Gateway.
tags Mapping[str, str]: A mapping of tags assigned to the resource.
type str: The type of the Virtual Network Gateway.
vpn_client_configurations Sequence[GetVirtualNetworkGatewayVpnClientConfiguration]: A vpn_client_configuration block which is documented below.
vpn_type str: The routing type of the Virtual Network Gateway.

activeActive Boolean: Is this an Active-Active Gateway?
bgpSettings List<Property Map>
customRoutes List<Property Map>
defaultLocalNetworkGatewayId String: The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.
enableBgp Boolean: Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.
generation String: The Generation of the Virtual Network Gateway.
id String: The provider-assigned unique ID for this managed resource.
ipConfigurations List<Property Map>: One or two ip_configuration blocks documented below.
location String: The location/region where the Virtual Network Gateway is located.
name String: The user-defined name of the root certificate.
privateIpAddressEnabled Boolean: Whether a private IP will be used for this gateway for connections.
resourceGroupName String
sku String: Configuration of the size and capacity of the Virtual Network Gateway.
tags Map<String>: A mapping of tags assigned to the resource.
type String: The type of the Virtual Network Gateway.
vpnClientConfigurations List<Property Map>: A vpn_client_configuration block which is documented below.
vpnType String: The routing type of the Virtual Network Gateway.

Supporting Types

GetVirtualNetworkGatewayBgpSetting

Asn int: The Autonomous System Number (ASN) to use as part of the BGP.
PeerWeight int: The weight added to routes which have been learned through BGP peering.
PeeringAddress string: The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

Asn int: The Autonomous System Number (ASN) to use as part of the BGP.
PeerWeight int: The weight added to routes which have been learned through BGP peering.
PeeringAddress string: The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

asn Integer: The Autonomous System Number (ASN) to use as part of the BGP.
peerWeight Integer: The weight added to routes which have been learned through BGP peering.
peeringAddress String: The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

asn number: The Autonomous System Number (ASN) to use as part of the BGP.
peerWeight number: The weight added to routes which have been learned through BGP peering.
peeringAddress string: The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

asn int: The Autonomous System Number (ASN) to use as part of the BGP.
peer_weight int: The weight added to routes which have been learned through BGP peering.
peering_address str: The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

asn Number: The Autonomous System Number (ASN) to use as part of the BGP.
peerWeight Number: The weight added to routes which have been learned through BGP peering.
peeringAddress String: The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

GetVirtualNetworkGatewayCustomRoute

AddressPrefixes List<string>: A list of address blocks reserved for this virtual network in CIDR notation.

AddressPrefixes []string: A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes List<String>: A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes string[]: A list of address blocks reserved for this virtual network in CIDR notation.

address_prefixes Sequence[str]: A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes List<String>: A list of address blocks reserved for this virtual network in CIDR notation.

GetVirtualNetworkGatewayIpConfiguration

Id string: The resource ID of the IP configuration.
Name string: Specifies the name of the Virtual Network Gateway.
PrivateIpAddress string: The Private IP Address associated with the Virtual Network Gateway.
PrivateIpAddressAllocation string: Defines how the private IP address of the gateways virtual interface is assigned.
PublicIpAddressId string: The ID of the Public IP Address associated with the Virtual Network Gateway.
SubnetId string: The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

Id string: The resource ID of the IP configuration.
Name string: Specifies the name of the Virtual Network Gateway.
PrivateIpAddress string: The Private IP Address associated with the Virtual Network Gateway.
PrivateIpAddressAllocation string: Defines how the private IP address of the gateways virtual interface is assigned.
PublicIpAddressId string: The ID of the Public IP Address associated with the Virtual Network Gateway.
SubnetId string: The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

id String: The resource ID of the IP configuration.
name String: Specifies the name of the Virtual Network Gateway.
privateIpAddress String: The Private IP Address associated with the Virtual Network Gateway.
privateIpAddressAllocation String: Defines how the private IP address of the gateways virtual interface is assigned.
publicIpAddressId String: The ID of the Public IP Address associated with the Virtual Network Gateway.
subnetId String: The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

id string: The resource ID of the IP configuration.
name string: Specifies the name of the Virtual Network Gateway.
privateIpAddress string: The Private IP Address associated with the Virtual Network Gateway.
privateIpAddressAllocation string: Defines how the private IP address of the gateways virtual interface is assigned.
publicIpAddressId string: The ID of the Public IP Address associated with the Virtual Network Gateway.
subnetId string: The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

id str: The resource ID of the IP configuration.
name str: Specifies the name of the Virtual Network Gateway.
private_ip_address str: The Private IP Address associated with the Virtual Network Gateway.
private_ip_address_allocation str: Defines how the private IP address of the gateways virtual interface is assigned.
public_ip_address_id str: The ID of the Public IP Address associated with the Virtual Network Gateway.
subnet_id str: The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

id String: The resource ID of the IP configuration.
name String: Specifies the name of the Virtual Network Gateway.
privateIpAddress String: The Private IP Address associated with the Virtual Network Gateway.
privateIpAddressAllocation String: Defines how the private IP address of the gateways virtual interface is assigned.
publicIpAddressId String: The ID of the Public IP Address associated with the Virtual Network Gateway.
subnetId String: The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

GetVirtualNetworkGatewayVpnClientConfiguration

AadAudience string: The client id of the Azure VPN application. See Create an Active Directory (AD) tenant for P2S OpenVPN protocol connections for values This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
AadIssuer string: The STS url for your tenant This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
AadTenant string: AzureAD Tenant URL This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
AddressSpaces List<string>: The address space out of which IP addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
RadiusServerAddress string: The address of the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
RadiusServerSecret string: The secret used by the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
RevokedCertificates List<GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate>: One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
RootCertificates List<GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate>: One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
VpnClientProtocols List<string>: List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

AadAudience string: The client id of the Azure VPN application. See Create an Active Directory (AD) tenant for P2S OpenVPN protocol connections for values This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
AadIssuer string: The STS url for your tenant This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
AadTenant string: AzureAD Tenant URL This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
AddressSpaces []string: The address space out of which IP addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
RadiusServerAddress string: The address of the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
RadiusServerSecret string: The secret used by the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
RevokedCertificates []GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate: One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
RootCertificates []GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate: One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
VpnClientProtocols []string: List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

aadAudience String: The client id of the Azure VPN application. See Create an Active Directory (AD) tenant for P2S OpenVPN protocol connections for values This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aadIssuer String: The STS url for your tenant This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aadTenant String: AzureAD Tenant URL This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
addressSpaces List<String>: The address space out of which IP addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radiusServerAddress String: The address of the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
radiusServerSecret String: The secret used by the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
revokedCertificates List<GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate>: One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
rootCertificates List<GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate>: One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
vpnClientProtocols List<String>: List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

aadAudience string: The client id of the Azure VPN application. See Create an Active Directory (AD) tenant for P2S OpenVPN protocol connections for values This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aadIssuer string: The STS url for your tenant This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aadTenant string: AzureAD Tenant URL This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
addressSpaces string[]: The address space out of which IP addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radiusServerAddress string: The address of the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
radiusServerSecret string: The secret used by the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
revokedCertificates GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate[]: One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
rootCertificates GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate[]: One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
vpnClientProtocols string[]: List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

aad_audience str: The client id of the Azure VPN application. See Create an Active Directory (AD) tenant for P2S OpenVPN protocol connections for values This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aad_issuer str: The STS url for your tenant This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aad_tenant str: AzureAD Tenant URL This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
address_spaces Sequence[str]: The address space out of which IP addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radius_server_address str: The address of the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
radius_server_secret str: The secret used by the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
revoked_certificates Sequence[GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate]: One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
root_certificates Sequence[GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate]: One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
vpn_client_protocols Sequence[str]: List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

aadAudience String: The client id of the Azure VPN application. See Create an Active Directory (AD) tenant for P2S OpenVPN protocol connections for values This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aadIssuer String: The STS url for your tenant This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
aadTenant String: AzureAD Tenant URL This setting is incompatible with the use of root_certificate and revoked_certificate, radius_server_address, and radius_server_secret.
addressSpaces List<String>: The address space out of which IP addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radiusServerAddress String: The address of the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
radiusServerSecret String: The secret used by the Radius server. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, root_certificate and revoked_certificate.
revokedCertificates List<Property Map>: One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
rootCertificates List<Property Map>: One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of aad_tenant, aad_audience, aad_issuer, radius_server_address, and radius_server_secret.
vpnClientProtocols List<String>: List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate

Name string: Specifies the name of the Virtual Network Gateway.
Thumbprint string

Name string: Specifies the name of the Virtual Network Gateway.
Thumbprint string

name String: Specifies the name of the Virtual Network Gateway.
thumbprint String

name string: Specifies the name of the Virtual Network Gateway.
thumbprint string

name str: Specifies the name of the Virtual Network Gateway.
thumbprint str

name String: Specifies the name of the Virtual Network Gateway.
thumbprint String

GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate

Name string: Specifies the name of the Virtual Network Gateway.
PublicCertData string: The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM).

Name string: Specifies the name of the Virtual Network Gateway.
PublicCertData string: The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM).

name String: Specifies the name of the Virtual Network Gateway.
publicCertData String: The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM).

name string: Specifies the name of the Virtual Network Gateway.
publicCertData string: The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM).

name str: Specifies the name of the Virtual Network Gateway.
public_cert_data str: The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM).

name String: Specifies the name of the Virtual Network Gateway.
publicCertData String: The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM).

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-azure

azure.network.getVirtualNetworkGateway

On this page

On this page

Example Usage

Using getVirtualNetworkGateway

getVirtualNetworkGateway Result

Supporting Types

GetVirtualNetworkGatewayBgpSetting

GetVirtualNetworkGatewayCustomRoute

GetVirtualNetworkGatewayIpConfiguration

GetVirtualNetworkGatewayVpnClientConfiguration

GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate

GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate

Package Details

On this page

On this page