Share via

Microsoft.Network connections 2015-05-01-preview

  • Article

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@2015-05-01-preview' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    connectionStatus: 'string'
    connectionType: 'string'
    egressBytesTransferred: int
    ingressBytesTransferred: int
    localNetworkGateway2: {
      etag: 'string'
      location: 'string'
      properties: {
        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'
      location: 'string'
      properties: {
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAddress: 'string'
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    virtualNetworkGateway2: {
      etag: 'string'
      location: 'string'
      properties: {
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAddress: 'string'
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AddressSpace

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

LocalNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
location Resource location string (required)
properties LocalNetworkGateway properties LocalNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

LocalNetworkGatewayPropertiesFormat

Name Description Value
gatewayIpAddress IP address of local network gateway. string
localNetworkAddressSpace Local network site Address space AddressSpace
provisioningState Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the LocalNetworkGateway resource string

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 (required)
name The resource name string (required)
properties VirtualNetworkGatewayConnection properties VirtualNetworkGatewayConnectionPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates

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
location Resource location string (required)
properties VirtualNetworkGateway properties VirtualNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

Name Description Value
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
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 or sets 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
privateIPAddress Gets or sets the privateIPAddress of the Network Interface IP Configuration string
privateIPAllocationMethod Gets or sets PrivateIP allocation method (Static/Dynamic) 'Dynamic'
'Static'
provisioningState Gets or sets 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
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 or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGateway resource string
vpnType The type of this virtual network gateway. 'PolicyBased'
'RouteBased'

Quickstart samples

The following quickstart samples deploy 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": "2015-05-01-preview",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "connectionStatus": "string",
    "connectionType": "string",
    "egressBytesTransferred": "int",
    "ingressBytesTransferred": "int",
    "localNetworkGateway2": {
      "etag": "string",
      "location": "string",
      "properties": {
        "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",
      "location": "string",
      "properties": {
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAddress": "string",
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "virtualNetworkGateway2": {
      "etag": "string",
      "location": "string",
      "properties": {
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAddress": "string",
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AddressSpace

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

LocalNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
location Resource location string (required)
properties LocalNetworkGateway properties LocalNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

LocalNetworkGatewayPropertiesFormat

Name Description Value
gatewayIpAddress IP address of local network gateway. string
localNetworkAddressSpace Local network site Address space AddressSpace
provisioningState Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the LocalNetworkGateway resource string

Microsoft.Network/connections

Name Description Value
apiVersion The api version '2015-05-01-preview'
etag Gets a unique read-only string that changes whenever the resource is updated string
location Resource location string (required)
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'

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
location Resource location string (required)
properties VirtualNetworkGateway properties VirtualNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

Name Description Value
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
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 or sets 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
privateIPAddress Gets or sets the privateIPAddress of the Network Interface IP Configuration string
privateIPAllocationMethod Gets or sets PrivateIP allocation method (Static/Dynamic) 'Dynamic'
'Static'
provisioningState Gets or sets 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
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 or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGateway resource string
vpnType The type of this virtual network gateway. 'PolicyBased'
'RouteBased'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
BOSH CF Cross Region

Deploy to Azure		 This template helps you setup the resources needed to deploy BOSH and Cloud Foundry across two regions on Azure.
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:

  • Resource groups

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@2015-05-01-preview"
  name = "string"
  etag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      connectionStatus = "string"
      connectionType = "string"
      egressBytesTransferred = int
      ingressBytesTransferred = int
      localNetworkGateway2 = {
        etag = "string"
        location = "string"
        properties = {
          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"
        location = "string"
        properties = {
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAddress = "string"
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      virtualNetworkGateway2 = {
        etag = "string"
        location = "string"
        properties = {
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAddress = "string"
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
    }
  })
}

Property values

AddressSpace

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

LocalNetworkGateway

Name Description Value
etag Gets a unique read-only string that changes whenever the resource is updated string
location Resource location string (required)
properties LocalNetworkGateway properties LocalNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

LocalNetworkGatewayPropertiesFormat

Name Description Value
gatewayIpAddress IP address of local network gateway. string
localNetworkAddressSpace Local network site Address space AddressSpace
provisioningState Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the LocalNetworkGateway resource string

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 (required)
name The resource name string (required)
properties VirtualNetworkGatewayConnection properties VirtualNetworkGatewayConnectionPropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/connections@2015-05-01-preview"

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
location Resource location string (required)
properties VirtualNetworkGateway properties VirtualNetworkGatewayPropertiesFormat
tags Resource tags ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

Name Description Value
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
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 or sets 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
privateIPAddress Gets or sets the privateIPAddress of the Network Interface IP Configuration string
privateIPAllocationMethod Gets or sets PrivateIP allocation method (Static/Dynamic) 'Dynamic'
'Static'
provisioningState Gets or sets 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
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 or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed string
resourceGuid Gets or sets resource guid property of the VirtualNetworkGateway resource string
vpnType The type of this virtual network gateway. 'PolicyBased'
'RouteBased'