GetGatewayConnection

Use this data source to access information about an existing Virtual Network Gateway Connection.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Network.GetGatewayConnection.InvokeAsync(new Azure.Network.GetGatewayConnectionArgs
        {
            Name = "production",
            ResourceGroupName = "networking",
        }));
        this.VirtualNetworkGatewayConnectionId = example.Apply(example => example.Id);
    }

    [Output("virtualNetworkGatewayConnectionId")]
    public Output<string> VirtualNetworkGatewayConnectionId { get; set; }
}

package main

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

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

import pulumi
import pulumi_azure as azure

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

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

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

Using GetGatewayConnection

function getGatewayConnection(args: GetGatewayConnectionArgs, opts?: InvokeOptions): Promise<GetGatewayConnectionResult>

function  get_gateway_connection(name=None, resource_group_name=None, opts=None)

func GetGatewayConnection(ctx *Context, args *GetGatewayConnectionArgs, opts ...InvokeOption) (*GetGatewayConnectionResult, error)

public static class GetGatewayConnection {
    public static Task<GetGatewayConnectionResult> InvokeAsync(GetGatewayConnectionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

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

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

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

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

GetGatewayConnection Result

The following output properties are available:

AuthorizationKey string: The authorization key associated with the Express Route Circuit. This field is present only if the type is an ExpressRoute connection.
ConnectionProtocol string
EgressBytesTransferred int
EnableBgp bool: If true, BGP (Border Gateway Protocol) is enabled for this connection.
ExpressRouteCircuitId string: The ID of the Express Route Circuit (i.e. when type is ExpressRoute).
ExpressRouteGatewayBypass bool: If true, data packets will bypass ExpressRoute Gateway for data forwarding. This is only valid for ExpressRoute connections.
Id string: The provider-assigned unique ID for this managed resource.
IngressBytesTransferred int
IpsecPolicies List<GetGatewayConnectionIpsecPolicy>
LocalNetworkGatewayId string: The ID of the local network gateway when a Site-to-Site connection (i.e. when type is IPsec).
Location string: The location/region where the connection is located.
Name string
PeerVirtualNetworkGatewayId string: The ID of the peer virtual network gateway when a VNet-to-VNet connection (i.e. when type is Vnet2Vnet).
ResourceGroupName string
ResourceGuid string
RoutingWeight int: The routing weight.
SharedKey string: The shared IPSec key.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Type string: The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet).
UsePolicyBasedTrafficSelectors bool: If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block.
VirtualNetworkGatewayId string: The ID of the Virtual Network Gateway in which the connection is created.

AuthorizationKey string: The authorization key associated with the Express Route Circuit. This field is present only if the type is an ExpressRoute connection.
ConnectionProtocol string
EgressBytesTransferred int
EnableBgp bool: If true, BGP (Border Gateway Protocol) is enabled for this connection.
ExpressRouteCircuitId string: The ID of the Express Route Circuit (i.e. when type is ExpressRoute).
ExpressRouteGatewayBypass bool: If true, data packets will bypass ExpressRoute Gateway for data forwarding. This is only valid for ExpressRoute connections.
Id string: The provider-assigned unique ID for this managed resource.
IngressBytesTransferred int
IpsecPolicies []GetGatewayConnectionIpsecPolicy
LocalNetworkGatewayId string: The ID of the local network gateway when a Site-to-Site connection (i.e. when type is IPsec).
Location string: The location/region where the connection is located.
Name string
PeerVirtualNetworkGatewayId string: The ID of the peer virtual network gateway when a VNet-to-VNet connection (i.e. when type is Vnet2Vnet).
ResourceGroupName string
ResourceGuid string
RoutingWeight int: The routing weight.
SharedKey string: The shared IPSec key.
Tags map[string]string: A mapping of tags to assign to the resource.
Type string: The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet).
UsePolicyBasedTrafficSelectors bool: If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block.
VirtualNetworkGatewayId string: The ID of the Virtual Network Gateway in which the connection is created.

authorizationKey string: The authorization key associated with the Express Route Circuit. This field is present only if the type is an ExpressRoute connection.
connectionProtocol string
egressBytesTransferred number
enableBgp boolean: If true, BGP (Border Gateway Protocol) is enabled for this connection.
expressRouteCircuitId string: The ID of the Express Route Circuit (i.e. when type is ExpressRoute).
expressRouteGatewayBypass boolean: If true, data packets will bypass ExpressRoute Gateway for data forwarding. This is only valid for ExpressRoute connections.
id string: The provider-assigned unique ID for this managed resource.
ingressBytesTransferred number
ipsecPolicies GetGatewayConnectionIpsecPolicy[]
localNetworkGatewayId string: The ID of the local network gateway when a Site-to-Site connection (i.e. when type is IPsec).
location string: The location/region where the connection is located.
name string
peerVirtualNetworkGatewayId string: The ID of the peer virtual network gateway when a VNet-to-VNet connection (i.e. when type is Vnet2Vnet).
resourceGroupName string
resourceGuid string
routingWeight number: The routing weight.
sharedKey string: The shared IPSec key.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
type string: The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet).
usePolicyBasedTrafficSelectors boolean: If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block.
virtualNetworkGatewayId string: The ID of the Virtual Network Gateway in which the connection is created.

authorization_key str: The authorization key associated with the Express Route Circuit. This field is present only if the type is an ExpressRoute connection.
connection_protocol str
egress_bytes_transferred float
enable_bgp bool: If true, BGP (Border Gateway Protocol) is enabled for this connection.
express_route_circuit_id str: The ID of the Express Route Circuit (i.e. when type is ExpressRoute).
express_route_gateway_bypass bool: If true, data packets will bypass ExpressRoute Gateway for data forwarding. This is only valid for ExpressRoute connections.
id str: The provider-assigned unique ID for this managed resource.
ingress_bytes_transferred float
ipsec_policies List[GetGatewayConnectionIpsecPolicy]
local_network_gateway_id str: The ID of the local network gateway when a Site-to-Site connection (i.e. when type is IPsec).
location str: The location/region where the connection is located.
name str
peer_virtual_network_gateway_id str: The ID of the peer virtual network gateway when a VNet-to-VNet connection (i.e. when type is Vnet2Vnet).
resource_group_name str
resource_guid str
routing_weight float: The routing weight.
shared_key str: The shared IPSec key.
tags Dict[str, str]: A mapping of tags to assign to the resource.
type str: The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet).
use_policy_based_traffic_selectors bool: If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block.
virtual_network_gateway_id str: The ID of the Virtual Network Gateway in which the connection is created.

Supporting Types

GetGatewayConnectionIpsecPolicy

See the output API doc for this type.

DhGroup string: The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
IkeEncryption string: The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
IkeIntegrity string: The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
IpsecEncryption string: The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
IpsecIntegrity string: The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
PfsGroup string: The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
SaDatasize int: The IPSec SA payload size in KB. Must be at least 1024 KB.
SaLifetime int: The IPSec SA lifetime in seconds. Must be at least 300 seconds.

DhGroup string: The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
IkeEncryption string: The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
IkeIntegrity string: The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
IpsecEncryption string: The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
IpsecIntegrity string: The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
PfsGroup string: The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
SaDatasize int: The IPSec SA payload size in KB. Must be at least 1024 KB.
SaLifetime int: The IPSec SA lifetime in seconds. Must be at least 300 seconds.

dhGroup string: The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
ikeEncryption string: The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
ikeIntegrity string: The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
ipsecEncryption string: The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
ipsecIntegrity string: The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
pfsGroup string: The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
saDatasize number: The IPSec SA payload size in KB. Must be at least 1024 KB.
saLifetime number: The IPSec SA lifetime in seconds. Must be at least 300 seconds.

dhGroup str: The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
ikeEncryption str: The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
ikeIntegrity str: The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
ipsecEncryption str: The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
ipsecIntegrity str: The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
pfsGroup str: The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
saDatasize float: The IPSec SA payload size in KB. Must be at least 1024 KB.
saLifetime float: The IPSec SA lifetime in seconds. Must be at least 300 seconds.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetGatewayConnection

Example Usage

Using GetGatewayConnection

GetGatewayConnection Result

Supporting Types

GetGatewayConnectionIpsecPolicy

Package Details

On This Page