Share via

Microsoft.Web sites/virtualNetworkConnections/gateways 2015-08-01

  • Article

Bicep resource definition

The sites/virtualNetworkConnections/gateways 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.Web/sites/virtualNetworkConnections/gateways resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/virtualNetworkConnections/gateways@2015-08-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    vnetName: 'string'
    vpnPackageUri: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections/gateways

Name Description Value
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: sites/virtualNetworkConnections
properties VnetGatewayProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

VnetGatewayProperties

Name Description Value
vnetName The VNET name. string
vpnPackageUri The URI where the Vpn package can be downloaded string

ARM template resource definition

The sites/virtualNetworkConnections/gateways 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.Web/sites/virtualNetworkConnections/gateways resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/virtualNetworkConnections/gateways",
  "apiVersion": "2015-08-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "vnetName": "string",
    "vpnPackageUri": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections/gateways

Name Description Value
apiVersion The api version '2015-08-01'
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
properties VnetGatewayProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Web/sites/virtualNetworkConnections/gateways'

ResourceTags

Name Description Value

VnetGatewayProperties

Name Description Value
vnetName The VNET name. string
vpnPackageUri The URI where the Vpn package can be downloaded string

Terraform (AzAPI provider) resource definition

The sites/virtualNetworkConnections/gateways 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.Web/sites/virtualNetworkConnections/gateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/virtualNetworkConnections/gateways@2015-08-01"
  name = "string"
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      vnetName = "string"
      vpnPackageUri = "string"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections/gateways

Name Description Value
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/virtualNetworkConnections
properties VnetGatewayProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/sites/virtualNetworkConnections/gateways@2015-08-01"

ResourceTags

Name Description Value

VnetGatewayProperties

Name Description Value
vnetName The VNET name. string
vpnPackageUri The URI where the Vpn package can be downloaded string