Share via


Microsoft.Relay namespaces 2018-01-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.Relay/namespaces@2018-01-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {}
  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

RelayNamespaceProperties

Name Description Value

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:

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": "2018-01-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Relay/namespaces

Name Description Value
apiVersion The api version '2018-01-01-preview'
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'

RelayNamespaceProperties

Name Description Value

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

Deploy to Azure
This template deploys Azure Cloud Shell resources into an Azure virtual network.
Create an Azure Relay namespace

Deploy to Azure
This template enables you to deploy an Azure Relay namespace with a Standard SKU.
Create an Azure Relay namespace and HybridConnection

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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@2018-01-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
    }
    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@2018-01-01-preview"

RelayNamespaceProperties

Name Description Value

Sku

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

TrackedResourceTags

Name Description Value