Microsoft.NotificationHubs namespaces 2017-04-01

• Latest
• 2023-10-01-preview
• 2023-09-01
• 2023-01-01-preview
• 2017-04-01
• 2016-03-01
• 2014-09-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.NotificationHubs/namespaces resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2017-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  properties: {
    createdAt: 'string'
    critical: bool
    dataCenter: 'string'
    enabled: bool
    name: 'string'
    namespaceType: 'string'
    provisioningState: 'string'
    region: 'string'
    scaleUnit: 'string'
    serviceBusEndpoint: 'string'
    status: 'string'
    subscriptionId: 'string'
    updatedAt: 'string'
  }
}

Property values

namespaces

Name	Description	Value
name	The resource name	string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens Start with letter. End with alphanumeric. Resource name must be unique across Azure.
location	Resource location	string
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
sku	The sku of the created namespace	Sku
properties	Properties of the Namespace.	NamespaceProperties

NamespaceProperties

Name	Description	Value
createdAt	The time the namespace was created.	string
critical	Whether or not the namespace is set as Critical.	bool
dataCenter	Data center for the namespace	string
enabled	Whether or not the namespace is currently enabled.	bool
name	The name of the namespace.	string
namespaceType	The namespace type.	'Messaging' 'NotificationHub'
provisioningState	Provisioning state of the Namespace.	string
region	Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe	string
scaleUnit	ScaleUnit where the namespace gets created	string
serviceBusEndpoint	Endpoint you can use to perform NotificationHub operations.	string
status	Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting	string
subscriptionId	The Id of the Azure subscription associated with the namespace.	string
updatedAt	The time the namespace was updated.	string

Sku

Name	Description	Value
capacity	The capacity of the resource	int
family	The Sku Family	string
name	Name of the notification hub sku	'Basic' 'Free' 'Standard' (required)
size	The Sku size	string
tier	The tier of particular sku	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Azure Notification Hub	Creates an Azure Notification Hub, Template originally authored by John Downs.
Provision a Mobile App with a SQL Database	This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub.

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.NotificationHubs/namespaces resource, add the following JSON to your template.

{
  "type": "Microsoft.NotificationHubs/namespaces",
  "apiVersion": "2017-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "createdAt": "string",
    "critical": "bool",
    "dataCenter": "string",
    "enabled": "bool",
    "name": "string",
    "namespaceType": "string",
    "provisioningState": "string",
    "region": "string",
    "scaleUnit": "string",
    "serviceBusEndpoint": "string",
    "status": "string",
    "subscriptionId": "string",
    "updatedAt": "string"
  }
}

Property values

namespaces

Name	Description	Value
type	The resource type	'Microsoft.NotificationHubs/namespaces'
apiVersion	The resource api version	'2017-04-01'
name	The resource name	string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens Start with letter. End with alphanumeric. Resource name must be unique across Azure.
location	Resource location	string
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
sku	The sku of the created namespace	Sku
properties	Properties of the Namespace.	NamespaceProperties

NamespaceProperties

Name	Description	Value
createdAt	The time the namespace was created.	string
critical	Whether or not the namespace is set as Critical.	bool
dataCenter	Data center for the namespace	string
enabled	Whether or not the namespace is currently enabled.	bool
name	The name of the namespace.	string
namespaceType	The namespace type.	'Messaging' 'NotificationHub'
provisioningState	Provisioning state of the Namespace.	string
region	Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe	string
scaleUnit	ScaleUnit where the namespace gets created	string
serviceBusEndpoint	Endpoint you can use to perform NotificationHub operations.	string
status	Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting	string
subscriptionId	The Id of the Azure subscription associated with the namespace.	string
updatedAt	The time the namespace was updated.	string

Sku

Name	Description	Value
capacity	The capacity of the resource	int
family	The Sku Family	string
name	Name of the notification hub sku	'Basic' 'Free' 'Standard' (required)
size	The Sku size	string
tier	The tier of particular sku	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Azure Notification Hub	Creates an Azure Notification Hub, Template originally authored by John Downs.
Provision a Mobile App with a SQL Database	This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub.

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.NotificationHubs/namespaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2017-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      createdAt = "string"
      critical = bool
      dataCenter = "string"
      enabled = bool
      name = "string"
      namespaceType = "string"
      provisioningState = "string"
      region = "string"
      scaleUnit = "string"
      serviceBusEndpoint = "string"
      status = "string"
      subscriptionId = "string"
      updatedAt = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

Property values

namespaces

Name	Description	Value
type	The resource type	"Microsoft.NotificationHubs/namespaces@2017-04-01"
name	The resource name	string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens Start with letter. End with alphanumeric. Resource name must be unique across Azure.
location	Resource location	string
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	The sku of the created namespace	Sku
properties	Properties of the Namespace.	NamespaceProperties

NamespaceProperties

Name	Description	Value
createdAt	The time the namespace was created.	string
critical	Whether or not the namespace is set as Critical.	bool
dataCenter	Data center for the namespace	string
enabled	Whether or not the namespace is currently enabled.	bool
name	The name of the namespace.	string
namespaceType	The namespace type.	"Messaging" "NotificationHub"
provisioningState	Provisioning state of the Namespace.	string
region	Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe	string
scaleUnit	ScaleUnit where the namespace gets created	string
serviceBusEndpoint	Endpoint you can use to perform NotificationHub operations.	string
status	Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting	string
subscriptionId	The Id of the Azure subscription associated with the namespace.	string
updatedAt	The time the namespace was updated.	string

Sku

Name	Description	Value
capacity	The capacity of the resource	int
family	The Sku Family	string
name	Name of the notification hub sku	"Basic" "Free" "Standard" (required)
size	The Sku size	string
tier	The tier of particular sku	string