Microsoft.Web sites/hybridconnection 2020-10-01

Template format

To create a Microsoft.Web/sites/hybridconnection resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.Web/sites/hybridconnection",
  "apiVersion": "2020-10-01",
  "kind": "string",
  "systemData": {
    "createdBy": "string",
    "createdByType": "string",
    "lastModifiedAt": "string"
  "properties": {
    "entityName": "string",
    "entityConnectionString": "string",
    "resourceType": "string",
    "resourceConnectionString": "string",
    "hostname": "string",
    "port": "integer",
    "biztalkUri": "string"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Web/sites/hybridconnection object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the hybrid connection configuration.
type enum Yes For JSON -hybridconnection

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-10-01
kind string No Kind of resource.
systemData object No The system metadata relating to this resource. - SystemData object
properties object Yes RelayServiceConnectionEntity resource specific properties - RelayServiceConnectionEntityProperties object

SystemData object

Name Type Required Value
createdBy string No The identity that created the resource.
createdByType enum No The type of identity that created the resource. - User, Application, ManagedIdentity, Key
lastModifiedAt string No The timestamp of resource last modification (UTC)

RelayServiceConnectionEntityProperties object

Name Type Required Value
entityName string No
entityConnectionString string No
resourceType string No
resourceConnectionString string No
hostname string No
port integer No
biztalkUri string No