Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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' = {
location: 'string'
name: 'string'
properties: {
privateEndpointConnections: [
{
properties: {
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
]
publicNetworkAccess: 'string'
}
sku: {
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Relay/namespaces
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| properties | Description of Relay namespace | RelayNamespaceProperties |
| sku | SKU of the namespace. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
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' |
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' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Name of this SKU. | 'Standard' (required) |
| tier | The tier of this SKU. | 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Relay Namespace | AVM Resource Module for Relay Namespace |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Azure Cloud Shell - VNet | This template deploys Azure Cloud Shell resources into an Azure virtual network. |
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",
"properties": {
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"description": "string",
"status": "string"
},
"provisioningState": "string"
}
}
],
"publicNetworkAccess": "string"
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Relay/namespaces
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-11-01' |
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| properties | Description of Relay namespace | RelayNamespaceProperties |
| sku | SKU of the namespace. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Relay/namespaces' |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
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' |
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' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Name of this SKU. | 'Standard' (required) |
| tier | The tier of this SKU. | 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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 |
This template enables you to deploy an Azure Relay namespace with a Standard SKU. |
| 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 with a WCF Relay |
This template enables you to deploy an Azure Relay namespace with standard SKU and a WCF Relay |
| 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. |
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"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
}
sku = {
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Relay/namespaces
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| properties | Description of Relay namespace | RelayNamespaceProperties |
| sku | SKU of the namespace. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Relay/namespaces@2021-11-01" |
ConnectionState
| Name | Description | Value |
|---|---|---|
| description | Description of the connection state. | string |
| status | Status of the connection. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
PrivateEndpoint
| Name | Description | Value |
|---|---|---|
| id | The ARM identifier for Private Endpoint. | string |
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' |
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' |
Sku
| Name | Description | Value |
|---|---|---|
| name | Name of this SKU. | 'Standard' (required) |
| tier | The tier of this SKU. | 'Standard' |
TrackedResourceTags
| Name | Description | Value |
|---|