Microsoft.Relay namespaces/wcfRelays

Bicep resource definition

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

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

Property Values

Microsoft.Relay/namespaces/wcfRelays

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 WCF relay. WcfRelayProperties

WcfRelayProperties

Name Description Value
relayType WCF relay type. 'Http'
'NetTcp'
requiresClientAuthorization Returns true if client authorization is needed for this relay; otherwise, false. bool
requiresTransportSecurity Returns true if transport security is needed for this relay; otherwise, false. bool
userMetadata The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, 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

ARM template resource definition

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

{
  "type": "Microsoft.Relay/namespaces/wcfRelays",
  "apiVersion": "2024-01-01",
  "name": "string",
  "properties": {
    "relayType": "string",
    "requiresClientAuthorization": "bool",
    "requiresTransportSecurity": "bool",
    "userMetadata": "string"
  }
}

Property Values

Microsoft.Relay/namespaces/wcfRelays

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

Constraints:
Min length = 1 (required)
properties Properties of the WCF relay. WcfRelayProperties
type The resource type 'Microsoft.Relay/namespaces/wcfRelays'

WcfRelayProperties

Name Description Value
relayType WCF relay type. 'Http'
'NetTcp'
requiresClientAuthorization Returns true if client authorization is needed for this relay; otherwise, false. bool
requiresTransportSecurity Returns true if transport security is needed for this relay; otherwise, false. bool
userMetadata The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, 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

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Relay/namespaces/wcfRelays@2024-01-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      relayType = "string"
      requiresClientAuthorization = bool
      requiresTransportSecurity = bool
      userMetadata = "string"
    }
  }
}

Property Values

Microsoft.Relay/namespaces/wcfRelays

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 WCF relay. WcfRelayProperties
type The resource type "Microsoft.Relay/namespaces/wcfRelays@2024-01-01"

WcfRelayProperties

Name Description Value
relayType WCF relay type. 'Http'
'NetTcp'
requiresClientAuthorization Returns true if client authorization is needed for this relay; otherwise, false. bool
requiresTransportSecurity Returns true if transport security is needed for this relay; otherwise, false. bool
userMetadata The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, 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
  • Last updated on