Share via

Microsoft.Network connections 2016-06-01

Bicep resource definition

The connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/connections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/connections@2016-06-01' = {
  scope: resourceSymbolicName or scope
  etag: 'string'
  ___location: 'string'
  name: 'string'
  properties: {
    authorizationKey: 'string'
    connectionStatus: 'string'
    connectionType: 'string'
    egressBytesTransferred: int
    enableBgp: bool
    ingressBytesTransferred: int
    localNetworkGateway2: {
      etag: 'string'
      id: 'string'
      ___location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        gatewayIpAddress: 'string'
        localNetworkAddressSpace: {
          addressPrefixes: [
            'string'
          ]
        }
        provisioningState: 'string'
        resourceGuid: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    peer: {
      id: 'string'
    }
    provisioningState: 'string'
    resourceGuid: 'string'
    routingWeight: int
    sharedKey: 'string'
    virtualNetworkGateway1: {
      etag: 'string'
      id: 'string'
      ___location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    virtualNetworkGateway2: {
      etag: 'string'
      id: 'string'
      ___location: 'string'
      properties: {
        activeActive: bool
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/connections

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
___location Resource ___location string
name The resource name string (required)
properties VirtualNetworkGatewayConnection properties VirtualNetworkGatewayConnectionPropertiesFormat
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates

AddressSpace

Name Description Value
addressPrefixes Gets or sets list of address blocks reserved for this virtual network in CIDR notation string[]

BgpSettings

Name Description Value
asn Gets or sets this BGP speaker's ASN int
bgpPeeringAddress Gets or sets the BGP peering address and BGP identifier of this BGP speaker string
peerWeight Gets or sets the weight added to routes learned from this BGP speaker int

LocalNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
id Resource Id string
___location Resource ___location string
properties LocalNetworkGateway properties LocalNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

LocalNetworkGatewayPropertiesFormat

Name Description Value
bgpSettings Local network gateway's BGP speaker settings BgpSettings
gatewayIpAddress IP address of local network gateway. string
localNetworkAddressSpace Local network site Address space AddressSpace
provisioningState Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the LocalNetworkGateway resource string

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource Id string

VirtualNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
id Resource Id string
___location Resource ___location string
properties VirtualNetworkGateway properties VirtualNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

Name Description Value
authorizationKey The authorizationKey. string
connectionStatus Virtual network Gateway connection status 'Connected'
'Connecting'
'NotConnected'
'Unknown'
connectionType Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet 'ExpressRoute'
'IPsec'
'Vnet2Vnet'
'VPNClient'
egressBytesTransferred The Egress Bytes Transferred in this connection int
enableBgp EnableBgp Flag bool
ingressBytesTransferred The Ingress Bytes Transferred in this connection int
localNetworkGateway2 A common class for general resource information LocalNetworkGateway
peer The reference to peerings resource. SubResource
provisioningState Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource string
routingWeight The Routing weight. int
sharedKey The IPsec share key. string
virtualNetworkGateway1 A common class for general resource information VirtualNetworkGateway
virtualNetworkGateway2 A common class for general resource information VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of VirtualNetworkGatewayIPConfiguration VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Name Description Value
privateIPAllocationMethod Gets or sets PrivateIP allocation method 'Dynamic'
'Static'
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
publicIPAddress Gets or sets the reference of the PublicIP resource SubResource
subnet Gets or sets the reference of the subnet resource SubResource

VirtualNetworkGatewayPropertiesFormat

Name Description Value
activeActive ActiveActive flag bool
bgpSettings Virtual network gateway's BGP speaker settings BgpSettings
enableBgp EnableBgp Flag bool
gatewayDefaultSite Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource
gatewayType The type of this virtual network gateway. 'ExpressRoute'
'Vpn'
ipConfigurations IpConfigurations for Virtual network gateway. VirtualNetworkGatewayIPConfiguration[]
provisioningState Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGateway resource string
sku Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. VirtualNetworkGatewaySku
vpnClientConfiguration Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration
vpnType The type of this virtual network gateway. 'PolicyBased'
'RouteBased'

VirtualNetworkGatewaySku

Name Description Value
capacity The capacity int
name Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance 'Basic'
'HighPerformance'
'Standard'
'UltraPerformance'
tier Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance 'Basic'
'HighPerformance'
'Standard'
'UltraPerformance'

VpnClientConfiguration

Name Description Value
vpnClientAddressPool Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. AddressSpace
vpnClientRevokedCertificates VpnClientRevokedCertificate for Virtual network gateway. VpnClientRevokedCertificate[]
vpnClientRootCertificates VpnClientRootCertificate for Virtual network gateway. VpnClientRootCertificate[]

VpnClientRevokedCertificate

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of the revoked VPN client certificate of virtual network gateway VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

Name Description Value
provisioningState Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed string
thumbprint Gets or sets the revoked Vpn client certificate thumbprint string

VpnClientRootCertificate

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of SSL certificates of application gateway VpnClientRootCertificatePropertiesFormat

VpnClientRootCertificatePropertiesFormat

Name Description Value
provisioningState Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed string
publicCertData Gets or sets the certificate public data string

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Virtual Network Gateway Connection AVM Resource Module for Virtual Network Gateway Connection

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create a BGP VNET to VNET connection This template allows you to connect two VNETs using Virtual Network Gateways and BGP
Site-to-Site VPN with active-active VPN Gateways with BGP This template allows you to deploy a site-to-site VPN between two VNets with VPN Gateways in configuration active-active with BGP. Each Azure VPN Gateway resolves the FQDN of the remote peers to determine the public IP of the remote VPN Gateway. Template runs as expected in Azure regions with availability zones.

ARM template resource definition

The connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/connections resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/connections",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "___location": "string",
  "properties": {
    "authorizationKey": "string",
    "connectionStatus": "string",
    "connectionType": "string",
    "egressBytesTransferred": "int",
    "enableBgp": "bool",
    "ingressBytesTransferred": "int",
    "localNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "___location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "gatewayIpAddress": "string",
        "localNetworkAddressSpace": {
          "addressPrefixes": [ "string" ]
        },
        "provisioningState": "string",
        "resourceGuid": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "peer": {
      "id": "string"
    },
    "provisioningState": "string",
    "resourceGuid": "string",
    "routingWeight": "int",
    "sharedKey": "string",
    "virtualNetworkGateway1": {
      "etag": "string",
      "id": "string",
      "___location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "virtualNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "___location": "string",
      "properties": {
        "activeActive": "bool",
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/connections

Name Description Value
apiVersion The api version '2016-06-01'
etag Gets a unique read-only string that changes whenever the resource is updated string
___location Resource ___location string
name The resource name string (required)
properties VirtualNetworkGatewayConnection properties VirtualNetworkGatewayConnectionPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/connections'

AddressSpace

Name Description Value
addressPrefixes Gets or sets list of address blocks reserved for this virtual network in CIDR notation string[]

BgpSettings

Name Description Value
asn Gets or sets this BGP speaker's ASN int
bgpPeeringAddress Gets or sets the BGP peering address and BGP identifier of this BGP speaker string
peerWeight Gets or sets the weight added to routes learned from this BGP speaker int

LocalNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
id Resource Id string
___location Resource ___location string
properties LocalNetworkGateway properties LocalNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

LocalNetworkGatewayPropertiesFormat

Name Description Value
bgpSettings Local network gateway's BGP speaker settings BgpSettings
gatewayIpAddress IP address of local network gateway. string
localNetworkAddressSpace Local network site Address space AddressSpace
provisioningState Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the LocalNetworkGateway resource string

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource Id string

VirtualNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
id Resource Id string
___location Resource ___location string
properties VirtualNetworkGateway properties VirtualNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

Name Description Value
authorizationKey The authorizationKey. string
connectionStatus Virtual network Gateway connection status 'Connected'
'Connecting'
'NotConnected'
'Unknown'
connectionType Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet 'ExpressRoute'
'IPsec'
'Vnet2Vnet'
'VPNClient'
egressBytesTransferred The Egress Bytes Transferred in this connection int
enableBgp EnableBgp Flag bool
ingressBytesTransferred The Ingress Bytes Transferred in this connection int
localNetworkGateway2 A common class for general resource information LocalNetworkGateway
peer The reference to peerings resource. SubResource
provisioningState Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource string
routingWeight The Routing weight. int
sharedKey The IPsec share key. string
virtualNetworkGateway1 A common class for general resource information VirtualNetworkGateway
virtualNetworkGateway2 A common class for general resource information VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of VirtualNetworkGatewayIPConfiguration VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Name Description Value
privateIPAllocationMethod Gets or sets PrivateIP allocation method 'Dynamic'
'Static'
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
publicIPAddress Gets or sets the reference of the PublicIP resource SubResource
subnet Gets or sets the reference of the subnet resource SubResource

VirtualNetworkGatewayPropertiesFormat

Name Description Value
activeActive ActiveActive flag bool
bgpSettings Virtual network gateway's BGP speaker settings BgpSettings
enableBgp EnableBgp Flag bool
gatewayDefaultSite Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource
gatewayType The type of this virtual network gateway. 'ExpressRoute'
'Vpn'
ipConfigurations IpConfigurations for Virtual network gateway. VirtualNetworkGatewayIPConfiguration[]
provisioningState Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGateway resource string
sku Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. VirtualNetworkGatewaySku
vpnClientConfiguration Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration
vpnType The type of this virtual network gateway. 'PolicyBased'
'RouteBased'

VirtualNetworkGatewaySku

Name Description Value
capacity The capacity int
name Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance 'Basic'
'HighPerformance'
'Standard'
'UltraPerformance'
tier Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance 'Basic'
'HighPerformance'
'Standard'
'UltraPerformance'

VpnClientConfiguration

Name Description Value
vpnClientAddressPool Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. AddressSpace
vpnClientRevokedCertificates VpnClientRevokedCertificate for Virtual network gateway. VpnClientRevokedCertificate[]
vpnClientRootCertificates VpnClientRootCertificate for Virtual network gateway. VpnClientRootCertificate[]

VpnClientRevokedCertificate

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of the revoked VPN client certificate of virtual network gateway VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

Name Description Value
provisioningState Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed string
thumbprint Gets or sets the revoked Vpn client certificate thumbprint string

VpnClientRootCertificate

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of SSL certificates of application gateway VpnClientRootCertificatePropertiesFormat

VpnClientRootCertificatePropertiesFormat

Name Description Value
provisioningState Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed string
publicCertData Gets or sets the certificate public data string

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Connect an ExpressRoute circuit to a VNET

Deploy to Azure		 This template creates a VNET, an ExpresRoute Gateway and a connection to a provisioned and enabled ExpressRoute circuit with AzurePrivatePeering configured.
Create a BGP VNET to VNET connection

Deploy to Azure		 This template allows you to connect two VNETs using Virtual Network Gateways and BGP
Create a Site-to-Site VPN Connection

Deploy to Azure		 This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Create a Site-to-Site VPN Connection with VM

Deploy to Azure		 This template allows you to create a Site-to-Site VPN Connection using Virtual Network Gateways
Create a VNET to VNET connection across two regions

Deploy to Azure		 This template allows you to connect two VNETs in different regions using Virtual Network Gateways
Create three vNets to demonstrate transitive BGP connections

Deploy to Azure		 This template deploys three vNets connected using Virtual Network Gateways and BGP-enabled connections
Deploy HBase geo replication

Deploy to Azure		 This template allows you to configure an Azure environment for HBase replication across two different regions with VPN vnet-to-vnet connection.
Extend an existing Azure VNET to a Multi-VNET Configuration

Deploy to Azure		 This template allows you to extend an existing single VNET environment to a Multi-VNET environment that extends across two datacenter regions using VNET-to-VNET gateways
Site-to-Site VPN with active-active VPN Gateways with BGP

Deploy to Azure		 This template allows you to deploy a site-to-site VPN between two VNets with VPN Gateways in configuration active-active with BGP. Each Azure VPN Gateway resolves the FQDN of the remote peers to determine the public IP of the remote VPN Gateway. Template runs as expected in Azure regions with availability zones.
VPN Custom IPSec Policy

Deploy to Azure		 This custom IPSec Policy allows more granular configuration of the IKE Parameters. This allows you to deploy a site-to-site VPN Policy to support specific settings on your VPN Endpoit Device.

Terraform (AzAPI provider) resource definition

The connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/connections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/connections@2016-06-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      authorizationKey = "string"
      connectionStatus = "string"
      connectionType = "string"
      egressBytesTransferred = int
      enableBgp = bool
      ingressBytesTransferred = int
      localNetworkGateway2 = {
        etag = "string"
        id = "string"
        ___location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          gatewayIpAddress = "string"
          localNetworkAddressSpace = {
            addressPrefixes = [
              "string"
            ]
          }
          provisioningState = "string"
          resourceGuid = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      peer = {
        id = "string"
      }
      provisioningState = "string"
      resourceGuid = "string"
      routingWeight = int
      sharedKey = "string"
      virtualNetworkGateway1 = {
        etag = "string"
        id = "string"
        ___location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      virtualNetworkGateway2 = {
        etag = "string"
        id = "string"
        ___location = "string"
        properties = {
          activeActive = bool
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
    }
  }
}

Property Values

Microsoft.Network/connections

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
___location Resource ___location string
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties VirtualNetworkGatewayConnection properties VirtualNetworkGatewayConnectionPropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/connections@2016-06-01"

AddressSpace

Name Description Value
addressPrefixes Gets or sets list of address blocks reserved for this virtual network in CIDR notation string[]

BgpSettings

Name Description Value
asn Gets or sets this BGP speaker's ASN int
bgpPeeringAddress Gets or sets the BGP peering address and BGP identifier of this BGP speaker string
peerWeight Gets or sets the weight added to routes learned from this BGP speaker int

LocalNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
id Resource Id string
___location Resource ___location string
properties LocalNetworkGateway properties LocalNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

LocalNetworkGatewayPropertiesFormat

Name Description Value
bgpSettings Local network gateway's BGP speaker settings BgpSettings
gatewayIpAddress IP address of local network gateway. string
localNetworkAddressSpace Local network site Address space AddressSpace
provisioningState Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the LocalNetworkGateway resource string

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource Id string

VirtualNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
id Resource Id string
___location Resource ___location string
properties VirtualNetworkGateway properties VirtualNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

Name Description Value
authorizationKey The authorizationKey. string
connectionStatus Virtual network Gateway connection status 'Connected'
'Connecting'
'NotConnected'
'Unknown'
connectionType Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet 'ExpressRoute'
'IPsec'
'Vnet2Vnet'
'VPNClient'
egressBytesTransferred The Egress Bytes Transferred in this connection int
enableBgp EnableBgp Flag bool
ingressBytesTransferred The Ingress Bytes Transferred in this connection int
localNetworkGateway2 A common class for general resource information LocalNetworkGateway
peer The reference to peerings resource. SubResource
provisioningState Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource string
routingWeight The Routing weight. int
sharedKey The IPsec share key. string
virtualNetworkGateway1 A common class for general resource information VirtualNetworkGateway
virtualNetworkGateway2 A common class for general resource information VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of VirtualNetworkGatewayIPConfiguration VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

Name Description Value
privateIPAllocationMethod Gets or sets PrivateIP allocation method 'Dynamic'
'Static'
provisioningState Gets provisioning state of the PublicIP resource Updating/Deleting/Failed string
publicIPAddress Gets or sets the reference of the PublicIP resource SubResource
subnet Gets or sets the reference of the subnet resource SubResource

VirtualNetworkGatewayPropertiesFormat

Name Description Value
activeActive ActiveActive flag bool
bgpSettings Virtual network gateway's BGP speaker settings BgpSettings
enableBgp EnableBgp Flag bool
gatewayDefaultSite Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource
gatewayType The type of this virtual network gateway. 'ExpressRoute'
'Vpn'
ipConfigurations IpConfigurations for Virtual network gateway. VirtualNetworkGatewayIPConfiguration[]
provisioningState Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGateway resource string
sku Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. VirtualNetworkGatewaySku
vpnClientConfiguration Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration
vpnType The type of this virtual network gateway. 'PolicyBased'
'RouteBased'

VirtualNetworkGatewaySku

Name Description Value
capacity The capacity int
name Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance 'Basic'
'HighPerformance'
'Standard'
'UltraPerformance'
tier Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance 'Basic'
'HighPerformance'
'Standard'
'UltraPerformance'

VpnClientConfiguration

Name Description Value
vpnClientAddressPool Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. AddressSpace
vpnClientRevokedCertificates VpnClientRevokedCertificate for Virtual network gateway. VpnClientRevokedCertificate[]
vpnClientRootCertificates VpnClientRootCertificate for Virtual network gateway. VpnClientRootCertificate[]

VpnClientRevokedCertificate

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of the revoked VPN client certificate of virtual network gateway VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

Name Description Value
provisioningState Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed string
thumbprint Gets or sets the revoked Vpn client certificate thumbprint string

VpnClientRootCertificate

Name Description Value
etag A unique read-only string that changes whenever the resource is updated string
id Resource Id string
name Gets name of the resource that is unique within a resource group. This name can be used to access the resource string
properties Properties of SSL certificates of application gateway VpnClientRootCertificatePropertiesFormat

VpnClientRootCertificatePropertiesFormat

Name Description Value
provisioningState Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed string
publicCertData Gets or sets the certificate public data string

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Virtual Network Gateway Connection AVM Resource Module for Virtual Network Gateway Connection
  • Last updated on