Microsoft.NotificationHubs namespaces 2014-09-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@2014-09-01' = {
  location: 'string'
  name: 'string'
  properties: {
    createdAt: 'string'
    critical: bool
    enabled: bool
    name: 'string'
    namespaceType: 'string'
    provisioningState: 'string'
    region: 'string'
    scaleUnit: 'string'
    serviceBusEndpoint: 'string'
    status: 'string'
    subscriptionId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.NotificationHubs/namespaces

Name	Description	Value
location	Gets or sets Namespace data center location.	string (required)
name	The resource name	string (required)
properties	Gets or sets properties of the Namespace.	NamespaceProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

NamespaceCreateOrUpdateParametersTags

Name	Description	Value

NamespaceProperties

Name	Description	Value
createdAt	The time the namespace was created.	string
critical	Whether or not the namespace is set as Critical.	bool
enabled	Whether or not the namespace is currently enabled.	bool
name	The name of the namespace.	string
namespaceType	Gets or sets the namespace type.	'Messaging' 'NotificationHub'
provisioningState	Gets or sets 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

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create Azure Notification Hub	Creates an Azure Notification Hub, Template originally authored by John Downs.

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": "2014-09-01",
  "name": "string",
  "location": "string",
  "properties": {
    "createdAt": "string",
    "critical": "bool",
    "enabled": "bool",
    "name": "string",
    "namespaceType": "string",
    "provisioningState": "string",
    "region": "string",
    "scaleUnit": "string",
    "serviceBusEndpoint": "string",
    "status": "string",
    "subscriptionId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.NotificationHubs/namespaces

Name	Description	Value
apiVersion	The api version	'2014-09-01'
location	Gets or sets Namespace data center location.	string (required)
name	The resource name	string (required)
properties	Gets or sets properties of the Namespace.	NamespaceProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.NotificationHubs/namespaces'

NamespaceCreateOrUpdateParametersTags

Name	Description	Value

NamespaceProperties

Name	Description	Value
createdAt	The time the namespace was created.	string
critical	Whether or not the namespace is set as Critical.	bool
enabled	Whether or not the namespace is currently enabled.	bool
name	The name of the namespace.	string
namespaceType	Gets or sets the namespace type.	'Messaging' 'NotificationHub'
provisioningState	Gets or sets 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

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@2014-09-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createdAt = "string"
      critical = bool
      enabled = bool
      name = "string"
      namespaceType = "string"
      provisioningState = "string"
      region = "string"
      scaleUnit = "string"
      serviceBusEndpoint = "string"
      status = "string"
      subscriptionId = "string"
    }
  })
}

Property values

Microsoft.NotificationHubs/namespaces

Name	Description	Value
location	Gets or sets Namespace data center location.	string (required)
name	The resource name	string (required)
properties	Gets or sets properties of the Namespace.	NamespaceProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.NotificationHubs/namespaces@2014-09-01"

NamespaceCreateOrUpdateParametersTags

Name	Description	Value

NamespaceProperties

Name	Description	Value
createdAt	The time the namespace was created.	string
critical	Whether or not the namespace is set as Critical.	bool
enabled	Whether or not the namespace is currently enabled.	bool
name	The name of the namespace.	string
namespaceType	Gets or sets the namespace type.	'Messaging' 'NotificationHub'
provisioningState	Gets or sets 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