Microsoft.NotificationHubs namespaces 2016-03-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@2016-03-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'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.NotificationHubs/namespaces
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the Namespace. | NamespaceProperties |
| sku | The sku of the created namespace | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 | 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 |
ResourceTags
| Name | Description | Value |
|---|
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 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": "2016-03-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"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.NotificationHubs/namespaces
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2016-03-01' |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the Namespace. | NamespaceProperties |
| sku | The sku of the created namespace | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NotificationHubs/namespaces' |
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 | 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 |
ResourceTags
| Name | Description | Value |
|---|
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@2016-03-01"
name = "string"
location = "string"
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "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 | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the Namespace. | NamespaceProperties |
| sku | The sku of the created namespace | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NotificationHubs/namespaces@2016-03-01" |
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 | 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 |
ResourceTags
| Name | Description | Value |
|---|
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 |