Microsoft.Relay namespaces/hybridConnections

ARM template resource definition

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

{
  "type": "Microsoft.Relay/namespaces/hybridConnections",
  "apiVersion": "2021-11-01",
  "name": "string",
  "properties": {
    "requiresClientAuthorization": "bool",
    "userMetadata": "string"
  }
}

Property values

namespaces/hybridConnections

Name Description Value
type The resource type 'Microsoft.Relay/namespaces/hybridConnections'
apiVersion The resource api version '2021-11-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-260

Valid characters:
Alphanumerics, periods, hyphens, underscores, and slashes.

Start and end with alphanumeric.
properties Properties of the HybridConnection. HybridConnectionProperties

HybridConnectionProperties

Name Description Value
requiresClientAuthorization Returns true if client authorization is needed for this hybrid connection; otherwise, false. bool
userMetadata 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. string

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 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.
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.