Microsoft.Relay namespaces/hybridConnections template reference

Template format

To create a Microsoft.Relay/namespaces/hybridConnections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Relay/namespaces/hybridConnections",
  "apiVersion": "2017-04-01",
  "properties": {
    "requiresClientAuthorization": "boolean",
    "userMetadata": "string"
  },
  "resources": []
}

Property values

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

Microsoft.Relay/namespaces/hybridConnections object

Name Type Required Value
name string Yes The hybrid connection name.
type enum Yes hybridConnections
-or-
Microsoft.Relay/namespaces/hybridConnections

See Set name and type for child resources.
apiVersion enum Yes 2017-04-01
properties object Yes Properties of the HybridConnection. - HybridConnectionProperties object
resources array No authorizationRules

HybridConnectionProperties object

Name Type Required Value
requiresClientAuthorization boolean No Returns true if client authorization is needed for this hybrid connection; otherwise, false.
userMetadata string No The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Relay namespace with all resources

Deploy to Azure
This template enables you to deploy an Azure Relay namespace with standard SKU, a WCF Relay and a HybridConnection.
Create an Azure Relay namespace and HybridConnection

Deploy to Azure
This template enables you to deploy an Azure Relay namespace with standard SKU and a HybridConnection.
Create an Azure Relay namespace with SAS Policies

Deploy to Azure
This template enables you to deploy an Azure Relay namespace with standard SKU, a HybridConnection entity and authorization rules for both the namespace and HybridConnection.