Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Microsoft.Relay namespaces/hybridConnections

Bicep 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 Bicep to your template.

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

Property Values

Microsoft.Relay/namespaces/hybridConnections

Name Description Value
name The resource name string

Constraints:
Min length = 1 (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.		 Symbolic name for resource of type: namespaces
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

Usage Examples

Bicep Samples

A basic example of deploying Azure Relay Hybrid Connection.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource namespace 'Microsoft.Relay/namespaces@2017-04-01' = {
 name: resourceName
 location: location
 sku: {
 name: 'Standard'
 tier: 'Standard'
 }
 properties: {}
}

resource hybridConnection 'Microsoft.Relay/namespaces/hybridConnections@2017-04-01' = {
 name: resourceName
 parent: namespace
 properties: {
 requiresClientAuthorization: true
 userMetadata: 'metadatatest'
 }
}

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": "2024-01-01",
 "name": "string",
 "properties": {
 "requiresClientAuthorization": "bool",
 "userMetadata": "string"
 }
}

Property Values

Microsoft.Relay/namespaces/hybridConnections

Name Description Value
apiVersion The api version '2024-01-01'
name The resource name string

Constraints:
Min length = 1 (required)
properties Properties of the HybridConnection. HybridConnectionProperties
type The resource type 'Microsoft.Relay/namespaces/hybridConnections'

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

Usage Examples

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@2024-01-01"
 name = "string"
 parent_id = "string"
 body = {
 properties = {
 requiresClientAuthorization = bool
 userMetadata = "string"
 }
 }
}

Property Values

Microsoft.Relay/namespaces/hybridConnections

Name Description Value
name The resource name string

Constraints:
Min length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties Properties of the HybridConnection. HybridConnectionProperties
type The resource type "Microsoft.Relay/namespaces/hybridConnections@2024-01-01"

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

Usage Examples

Terraform Samples

A basic example of deploying Azure Relay Hybrid Connection.

terraform {
 required_providers {
 azapi = {
 source = "Azure/azapi"
 }
 }
}

provider "azapi" {
 skip_provider_registration = false
}

variable "resource_name" {
 type = string
 default = "acctest0001"
}

variable "location" {
 type = string
 default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
 type = "Microsoft.Resources/resourceGroups@2020-06-01"
 name = var.resource_name
 location = var.location
}

resource "azapi_resource" "namespace" {
 type = "Microsoft.Relay/namespaces@2017-04-01"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 properties = {
 }
 sku = {
 name = "Standard"
 tier = "Standard"
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

resource "azapi_resource" "hybridConnection" {
 type = "Microsoft.Relay/namespaces/hybridConnections@2017-04-01"
 parent_id = azapi_resource.namespace.id
 name = var.resource_name
 body = {
 properties = {
 requiresClientAuthorization = true
 userMetadata = "metadatatest"
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

Feedback

Was this page helpful?

Additional resources

  • Last updated on