Microsoft.Relay namespaces
Bicep resource definition
The namespaces 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Relay/namespaces@2021-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'Standard'
tier: 'Standard'
}
properties: {
privateEndpointConnections: [
{
properties: {
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
]
publicNetworkAccess: 'string'
}
}
Property values
namespaces
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with a letter. End with a letter or number. Resource name must be unique across Azure. |
| location | Resource location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | SKU of the namespace. | Sku |
| properties | Description of Relay namespace | RelayNamespaceProperties |
RelayNamespaceProperties
| Name | Description | Value |
|---|---|---|
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection[] |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| properties | Properties of the PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The Private Endpoint resource for this Connection. | PrivateEndpoint |
| privateLinkServiceConnectionState | Details about the state of the connection. | ConnectionState |
| provisioningState | Provisioning state of the Private Endpoint Connection. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Name of this SKU. | 'Standard' (required) |
| tier | The tier of this SKU. | 'Standard' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure Cloud Shell - VNet |
This template deploys Azure Cloud Shell resources into an Azure virtual network. |
| 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 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 and HybridConnection |
This template enables you to deploy an Azure Relay namespace with standard SKU and a HybridConnection. |
| Create an Azure Relay namespace |
This template enables you to deploy an Azure Relay namespace with a Standard SKU. |
| 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 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Relay/namespaces",
"apiVersion": "2021-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "Standard",
"tier": "Standard"
},
"properties": {
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"description": "string",
"status": "string"
},
"provisioningState": "string"
}
}
],
"publicNetworkAccess": "string"
}
}
Property values
namespaces
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Relay/namespaces' |
| apiVersion | The resource api version | '2021-11-01' |
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with a letter. End with a letter or number. Resource name must be unique across Azure. |
| location | Resource location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | SKU of the namespace. | Sku |
| properties | Description of Relay namespace | RelayNamespaceProperties |
RelayNamespaceProperties
| Name | Description | Value |
|---|---|---|
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection[] |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| properties | Properties of the PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The Private Endpoint resource for this Connection. | PrivateEndpoint |
| privateLinkServiceConnectionState | Details about the state of the connection. | ConnectionState |
| provisioningState | Provisioning state of the Private Endpoint Connection. | 'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Name of this SKU. | 'Standard' (required) |
| tier | The tier of this SKU. | 'Standard' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Azure Cloud Shell - VNet |
This template deploys Azure Cloud Shell resources into an Azure virtual network. |
| 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 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 and HybridConnection |
This template enables you to deploy an Azure Relay namespace with standard SKU and a HybridConnection. |
| Create an Azure Relay namespace |
This template enables you to deploy an Azure Relay namespace with a Standard SKU. |
| 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 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Relay/namespaces@2021-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
}
sku = {
name = "Standard"
tier = "Standard"
}
})
}
Property values
namespaces
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Relay/namespaces@2021-11-01" |
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with a letter. End with a letter or number. Resource name must be unique across Azure. |
| location | Resource location. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | SKU of the namespace. | Sku |
| properties | Description of Relay namespace | RelayNamespaceProperties |
RelayNamespaceProperties
| Name | Description | Value |
|---|---|---|
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection[] |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | "Disabled" "Enabled" "SecuredByPerimeter" |
PrivateEndpointConnection
| Name | Description | Value |
|---|---|---|
| properties | Properties of the PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateEndpoint | The Private Endpoint resource for this Connection. | PrivateEndpoint |
| privateLinkServiceConnectionState | Details about the state of the connection. | ConnectionState |
| provisioningState | Provisioning state of the Private Endpoint Connection. | "Canceled" "Creating" "Deleting" "Failed" "Succeeded" "Updating" |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | "Approved" "Disconnected" "Pending" "Rejected" |
Sku
| Name | Description | Value |
|---|---|---|
| name | Name of this SKU. | "Standard" (required) |
| tier | The tier of this SKU. | "Standard" |
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