Share via

Microsoft.Web connectionGateways

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Web/connectionGateways@2016-06-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    backendUri: 'string'
    connectionGatewayInstallation: {
      id: 'string'
      location: 'string'
      name: 'string'
      type: 'string'
    }
    contactInformation: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    machineName: 'string'
    status: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ConnectionGatewayDefinitionProperties

Name Description Value
backendUri The URI of the backend string
connectionGatewayInstallation The gateway installation reference ConnectionGatewayReference
contactInformation The gateway admin string[]
description The gateway description string
displayName The gateway display name string
machineName The machine name of the gateway string
status The gateway status any

ConnectionGatewayReference

Name Description Value
id Resource reference id string
location Resource reference location string
name Resource reference name string
type Resource reference type string

Microsoft.Web/connectionGateways

Name Description Value
etag Resource ETag string
location Resource location string
name The resource name string (required)
properties ConnectionGatewayDefinitionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TagsDictionary

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.Web/connectionGateways",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "backendUri": "string",
    "connectionGatewayInstallation": {
      "id": "string",
      "location": "string",
      "name": "string",
      "type": "string"
    },
    "contactInformation": [ "string" ],
    "description": "string",
    "displayName": "string",
    "machineName": "string",
    "status": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ConnectionGatewayDefinitionProperties

Name Description Value
backendUri The URI of the backend string
connectionGatewayInstallation The gateway installation reference ConnectionGatewayReference
contactInformation The gateway admin string[]
description The gateway description string
displayName The gateway display name string
machineName The machine name of the gateway string
status The gateway status any

ConnectionGatewayReference

Name Description Value
id Resource reference id string
location Resource reference location string
name Resource reference name string
type Resource reference type string

Microsoft.Web/connectionGateways

Name Description Value
apiVersion The api version '2016-06-01'
etag Resource ETag string
location Resource location string
name The resource name string (required)
properties ConnectionGatewayDefinitionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Web/connectionGateways'

TagsDictionary

Name Description Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/connectionGateways@2016-06-01"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      backendUri = "string"
      connectionGatewayInstallation = {
        id = "string"
        location = "string"
        name = "string"
        type = "string"
      }
      contactInformation = [
        "string"
      ]
      description = "string"
      displayName = "string"
      machineName = "string"
      status = ?
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

ConnectionGatewayDefinitionProperties

Name Description Value
backendUri The URI of the backend string
connectionGatewayInstallation The gateway installation reference ConnectionGatewayReference
contactInformation The gateway admin string[]
description The gateway description string
displayName The gateway display name string
machineName The machine name of the gateway string
status The gateway status any

ConnectionGatewayReference

Name Description Value
id Resource reference id string
location Resource reference location string
name Resource reference name string
type Resource reference type string

Microsoft.Web/connectionGateways

Name Description Value
etag Resource ETag string
location Resource location string
name The resource name string (required)
properties ConnectionGatewayDefinitionProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/connectionGateways@2016-06-01"

TagsDictionary

Name Description Value