Microsoft.Web connectionGateways 2016-06-01
Bicep resource definition
The connectionGateways resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
etag: 'string'
properties: {
backendUri: 'string'
connectionGatewayInstallation: {
id: 'string'
location: 'string'
name: 'string'
type: 'string'
}
contactInformation: [
'string'
]
description: 'string'
displayName: 'string'
machineName: 'string'
status: any()
}
}
Property values
connectionGateways
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
location | Resource location | string |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
etag | Resource ETag | string |
properties | ConnectionGatewayDefinitionProperties |
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 | For Bicep, you can use the any() function. |
ConnectionGatewayReference
Name | Description | Value |
---|---|---|
id | Resource reference id | string |
location | Resource reference location | string |
name | Resource reference name | string |
type | Resource reference type | string |
ARM template resource definition
The connectionGateways resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"etag": "string",
"properties": {
"backendUri": "string",
"connectionGatewayInstallation": {
"id": "string",
"location": "string",
"name": "string",
"type": "string"
},
"contactInformation": [ "string" ],
"description": "string",
"displayName": "string",
"machineName": "string",
"status": {}
}
}
Property values
connectionGateways
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Web/connectionGateways' |
apiVersion | The resource api version | '2016-06-01' |
name | The resource name | string (required) |
location | Resource location | string |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
etag | Resource ETag | string |
properties | ConnectionGatewayDefinitionProperties |
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 |
ConnectionGatewayReference
Name | Description | Value |
---|---|---|
id | Resource reference id | string |
location | Resource reference location | string |
name | Resource reference name | string |
type | Resource reference type | string |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
backendUri = "string"
connectionGatewayInstallation = {
id = "string"
location = "string"
name = "string"
type = "string"
}
contactInformation = [
"string"
]
description = "string"
displayName = "string"
machineName = "string"
}
etag = "string"
})
}
Property values
connectionGateways
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Web/connectionGateways@2016-06-01" |
name | The resource name | string (required) |
location | Resource location | string |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Resource tags | Dictionary of tag names and values. |
etag | Resource ETag | string |
properties | ConnectionGatewayDefinitionProperties |
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 |
ConnectionGatewayReference
Name | Description | Value |
---|---|---|
id | Resource reference id | string |
location | Resource reference location | string |
name | Resource reference name | string |
type | Resource reference type | string |