Microsoft.Relay namespaces/hybridConnections

• Latest
• 2024-01-01
• 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@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

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": "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