Microsoft.Relay namespaces 2016-07-01

• Latest
• 2021-11-01
• 2018-01-01-preview
• 2017-04-01
• 2016-07-01

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@2016-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'Standard'
    tier: 'Standard'
  }
  properties: {}
}

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

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name	Description	Value
name	Name of this Sku	'Standard' (required)
tier	The tier of this particular SKU	'Standard' (required)

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": "2016-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "properties": {}
}

Property values

namespaces

Name	Description	Value
type	The resource type	'Microsoft.Relay/namespaces'
apiVersion	The resource api version	'2016-07-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

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name	Description	Value
name	Name of this Sku	'Standard' (required)
tier	The tier of this particular SKU	'Standard' (required)

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@2016-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {}
    sku = {
      name = "Standard"
      tier = "Standard"
    }
  })
}

Property values

namespaces

Name	Description	Value
type	The resource type	"Microsoft.Relay/namespaces@2016-07-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

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name	Description	Value
name	Name of this Sku	"Standard" (required)
tier	The tier of this particular SKU	"Standard" (required)