Microsoft.Relay namespaces/hybridConnections

The namespaces/hybridConnections resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Relay/namespaces/hybridConnections resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Relay/namespaces/hybridConnections@2017-04-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    requiresClientAuthorization: bool
    userMetadata: 'string'
  }
}

Property values

namespaces/hybridConnections

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Relay/namespaces/hybridConnections'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-04-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
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.