Microsoft.Relay namespaces/wcfRelays
Bicep resource definition
The namespaces/wcfRelays 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/wcfRelays resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Relay/namespaces/wcfRelays@2021-11-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
relayType: 'string'
requiresClientAuthorization: bool
requiresTransportSecurity: bool
userMetadata: 'string'
}
}
Property values
namespaces/wcfRelays
| 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 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 |
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 and WCF |
This template enables you to deploy an Azure Relay namespace with standard SKU, a WcfRealy entity and authorization rules for both the namespace and WcfRealy. |
| Create an Azure Relay namespace with a WCF Relay |
This template enables you to deploy an Azure Relay namespace with standard SKU and a WCF Relay |
ARM template resource definition
The namespaces/wcfRelays 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/wcfRelays resource, add the following JSON to your template.
{
"type": "Microsoft.Relay/namespaces/wcfRelays",
"apiVersion": "2021-11-01",
"name": "string",
"properties": {
"relayType": "string",
"requiresClientAuthorization": "bool",
"requiresTransportSecurity": "bool",
"userMetadata": "string"
}
}
Property values
namespaces/wcfRelays
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Relay/namespaces/wcfRelays' |
| apiVersion | The resource api version | '2021-11-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 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 |
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 and WCF |
This template enables you to deploy an Azure Relay namespace with standard SKU, a WcfRealy entity and authorization rules for both the namespace and WcfRealy. |
| Create an Azure Relay namespace with a WCF Relay |
This template enables you to deploy an Azure Relay namespace with standard SKU and a WCF Relay |
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@2021-11-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
relayType = "string"
requiresClientAuthorization = bool
requiresTransportSecurity = bool
userMetadata = "string"
}
})
}
Property values
namespaces/wcfRelays
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Relay/namespaces/wcfRelays@2021-11-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 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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for