Microsoft.Web serverfarms/virtualNetworkConnections/gateways

  • Article

Bicep resource definition

The serverfarms/virtualNetworkConnections/gateways resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/serverfarms/virtualNetworkConnections/gateways resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2022-03-01' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    vnetName: 'string'
    vpnPackageUri: 'string'
  }
}

Property values

serverfarms/virtualNetworkConnections/gateways

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
kind Kind of resource. string
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: 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 serverfarms/virtualNetworkConnections/gateways resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/serverfarms/virtualNetworkConnections/gateways resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways",
  "apiVersion": "2022-03-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "vnetName": "string",
    "vpnPackageUri": "string"
  }
}

Property values

serverfarms/virtualNetworkConnections/gateways

Name Description Value
type The resource type 'Microsoft.Web/serverfarms/virtualNetworkConnections/gateways'
apiVersion The resource api version '2022-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
kind Kind of resource. string
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)

Terraform (AzAPI provider) resource definition

The serverfarms/virtualNetworkConnections/gateways resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/serverfarms/virtualNetworkConnections/gateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2022-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      vnetName = "string"
      vpnPackageUri = "string"
    }
    kind = "string"
  })
}

Property values

serverfarms/virtualNetworkConnections/gateways

Name Description Value
type The resource type "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2022-03-01"
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: virtualNetworkConnections
kind Kind of resource. string
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)