Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-01-01
- 2024-10-01
- 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:
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' = {
scope: resourceSymbolicName or scope
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
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 |
| 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[] |
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 |
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' |
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": "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
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' |
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 |
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' |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
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:
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"
parent_id = "string"
___location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "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"
}
}
}
}
}
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 (required) |
| 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@2015-05-01-preview" |
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 |
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' |
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 |