Microsoft.Relay namespaces/HybridConnections 2016-07-01

• Latest
• 2021-11-01
• 2017-04-01
• 2016-07-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Relay/namespaces/HybridConnections@2016-07-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    requiresClientAuthorization: bool
    userMetadata: 'string'
  }
}

Property values

namespaces/HybridConnections

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required) Character limit: 1-260 Valid characters: Alphanumerics, periods, hyphens, underscores, and slashes. Start and end with alphanumeric.
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.	Symbolic name for resource of type: namespaces
properties	Properties of HybridConnection	HybridConnectionProperties

HybridConnectionProperties

Name	Description	Value
requiresClientAuthorization	true if client authorization is needed for this HybridConnection; otherwise, false.	bool
userMetadata	usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as 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	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	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	This template enables you to deploy an Azure Relay namespace with standard SKU and a HybridConnection.

ARM template resource definition

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

{
  "type": "Microsoft.Relay/namespaces/HybridConnections",
  "apiVersion": "2016-07-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	'2016-07-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 HybridConnection	HybridConnectionProperties

HybridConnectionProperties

Name	Description	Value
requiresClientAuthorization	true if client authorization is needed for this HybridConnection; otherwise, false.	bool
userMetadata	usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as 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	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	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	This template enables you to deploy an Azure Relay namespace with standard SKU and a HybridConnection.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Relay/namespaces/HybridConnections@2016-07-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      requiresClientAuthorization = bool
      userMetadata = "string"
    }
  })
}

Property values

namespaces/HybridConnections

Name	Description	Value
type	The resource type	"Microsoft.Relay/namespaces/HybridConnections@2016-07-01"
name	The resource name	string (required) Character limit: 1-260 Valid characters: Alphanumerics, periods, hyphens, underscores, and slashes. Start and end with alphanumeric.
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: namespaces
properties	Properties of HybridConnection	HybridConnectionProperties

HybridConnectionProperties

Name	Description	Value
requiresClientAuthorization	true if client authorization is needed for this HybridConnection; otherwise, false.	bool
userMetadata	usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.	string