Microsoft.Network connections 2015-06-15

• Latest
• 2024-07-01
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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-06-15' = {
  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: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        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'
        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: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        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'
        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
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AddressSpace

Name	Description	Value
addressPrefixes	A 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 Identifier.	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 or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed	string
resourceGuid	The 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 Identifier.	string

VirtualNetworkGateway

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated.	string
id	Resource Identifier.	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. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.	'Connected' 'Connecting' 'NotConnected' 'Unknown'
connectionType	Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.	'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	The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the VirtualNetworkGatewayConnection resource.	string
routingWeight	The routing weight.	int
sharedKey	The IPSec shared 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 Identifier.	string
name	The 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 IP Configuration	string
privateIPAllocationMethod	The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.	'Dynamic' 'Static'
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
publicIPAddress	The reference of the public IP resource.	SubResource
subnet	The reference of the subnet resource.	SubResource

VirtualNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Virtual network gateway's BGP speaker settings.	BgpSettings
enableBgp	Whether BGP is enabled for this virtual network gateway or not.	bool
gatewayDefaultSite	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. Possible values are: 'Vpn' and 'ExpressRoute'.	'ExpressRoute' 'Vpn'
ipConfigurations	IP configurations for virtual network gateway.	VirtualNetworkGatewayIPConfiguration[]
provisioningState	The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the VirtualNetworkGateway resource.	string
sku	The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.	VirtualNetworkGatewaySku
vpnClientConfiguration	The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.	VpnClientConfiguration
vpnType	The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

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

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 Identifier.	string
name	The 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	The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
thumbprint	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 Identifier.	string
name	The 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	The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and '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:

• Resource groups - See resource group deployment commands

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-06-15",
  "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": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "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",
        "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": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "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",
        "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	'2015-06-15'
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	A 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 Identifier.	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 or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed	string
resourceGuid	The 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 Identifier.	string

VirtualNetworkGateway

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated.	string
id	Resource Identifier.	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. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.	'Connected' 'Connecting' 'NotConnected' 'Unknown'
connectionType	Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.	'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	The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the VirtualNetworkGatewayConnection resource.	string
routingWeight	The routing weight.	int
sharedKey	The IPSec shared 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 Identifier.	string
name	The 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 IP Configuration	string
privateIPAllocationMethod	The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.	'Dynamic' 'Static'
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
publicIPAddress	The reference of the public IP resource.	SubResource
subnet	The reference of the subnet resource.	SubResource

VirtualNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Virtual network gateway's BGP speaker settings.	BgpSettings
enableBgp	Whether BGP is enabled for this virtual network gateway or not.	bool
gatewayDefaultSite	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. Possible values are: 'Vpn' and 'ExpressRoute'.	'ExpressRoute' 'Vpn'
ipConfigurations	IP configurations for virtual network gateway.	VirtualNetworkGatewayIPConfiguration[]
provisioningState	The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the VirtualNetworkGateway resource.	string
sku	The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.	VirtualNetworkGatewaySku
vpnClientConfiguration	The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.	VpnClientConfiguration
vpnType	The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

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

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 Identifier.	string
name	The 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	The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
thumbprint	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 Identifier.	string
name	The 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	The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and '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
BOSH CF Cross Region	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	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	This template allows you to connect two VNETs using Virtual Network Gateways and BGP
Create a Site-to-Site VPN Connection	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	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	This template allows you to connect two VNETs in different regions using Virtual Network Gateways
Create three vNets to demonstrate transitive BGP connections	This template deploys three vNets connected using Virtual Network Gateways and BGP-enabled connections
Deploy HBase geo replication	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	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	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	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-06-15"
  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 = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          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"
          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 = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          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"
          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)
properties	VirtualNetworkGatewayConnection properties	VirtualNetworkGatewayConnectionPropertiesFormat
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Network/connections@2015-06-15"

AddressSpace

Name	Description	Value
addressPrefixes	A 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 Identifier.	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 or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed	string
resourceGuid	The 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 Identifier.	string

VirtualNetworkGateway

Name	Description	Value
etag	Gets a unique read-only string that changes whenever the resource is updated.	string
id	Resource Identifier.	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. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.	'Connected' 'Connecting' 'NotConnected' 'Unknown'
connectionType	Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.	'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	The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the VirtualNetworkGatewayConnection resource.	string
routingWeight	The routing weight.	int
sharedKey	The IPSec shared 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 Identifier.	string
name	The 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 IP Configuration	string
privateIPAllocationMethod	The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.	'Dynamic' 'Static'
provisioningState	The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
publicIPAddress	The reference of the public IP resource.	SubResource
subnet	The reference of the subnet resource.	SubResource

VirtualNetworkGatewayPropertiesFormat

Name	Description	Value
bgpSettings	Virtual network gateway's BGP speaker settings.	BgpSettings
enableBgp	Whether BGP is enabled for this virtual network gateway or not.	bool
gatewayDefaultSite	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. Possible values are: 'Vpn' and 'ExpressRoute'.	'ExpressRoute' 'Vpn'
ipConfigurations	IP configurations for virtual network gateway.	VirtualNetworkGatewayIPConfiguration[]
provisioningState	The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
resourceGuid	The resource GUID property of the VirtualNetworkGateway resource.	string
sku	The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.	VirtualNetworkGatewaySku
vpnClientConfiguration	The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.	VpnClientConfiguration
vpnType	The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

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

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 Identifier.	string
name	The 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	The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
thumbprint	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 Identifier.	string
name	The 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	The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and '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