Share via

Microsoft.Web sites/virtualNetworkConnections/gateways 2023-12-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@2023-12-01' = {
  kind: 'string'
  name: 'string'
  properties: {
    vnetName: 'string'
    vpnPackageUri: 'string'
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections/gateways

Name Description Value
kind Kind of resource. string
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 VnetGateway resource specific properties VnetGatewayProperties

VnetGatewayProperties

Name Description Value
vnetName The Virtual Network name. string
vpnPackageUri The URI where the VPN package can be downloaded. string (required)

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": "2023-12-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "vnetName": "string",
    "vpnPackageUri": "string"
  }
}

Property values

Microsoft.Web/sites/virtualNetworkConnections/gateways

Name Description Value
apiVersion The api version '2023-12-01'
kind Kind of resource. string
name The resource name string (required)
properties VnetGateway resource specific properties VnetGatewayProperties
type The resource type 'Microsoft.Web/sites/virtualNetworkConnections/gateways'

VnetGatewayProperties

Name Description Value
vnetName The Virtual Network name. string
vpnPackageUri The URI where the VPN package can be downloaded. string (required)

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@2023-12-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      vnetName = "string"
      vpnPackageUri = "string"
    }
  })
}

Property values

Microsoft.Web/sites/virtualNetworkConnections/gateways

Name Description Value
kind Kind of resource. string
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 VnetGateway resource specific properties VnetGatewayProperties
type The resource type "Microsoft.Web/sites/virtualNetworkConnections/gateways@2023-12-01"

VnetGatewayProperties

Name Description Value
vnetName The Virtual Network name. string
vpnPackageUri The URI where the VPN package can be downloaded. string (required)