The namespaces/notificationHubs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.NotificationHubs/namespaces/notificationHubs resource, add the following JSON to your template.
{
"type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
"apiVersion": "2023-10-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"properties": {
"admCredential": {
"properties": {
"authTokenUrl": "string",
"clientId": "string",
"clientSecret": "string"
}
},
"apnsCredential": {
"properties": {
"apnsCertificate": "string",
"appId": "string",
"appName": "string",
"certificateKey": "string",
"endpoint": "string",
"keyId": "string",
"thumbprint": "string",
"token": "string"
}
},
"baiduCredential": {
"properties": {
"baiduApiKey": "string",
"baiduEndPoint": "string",
"baiduSecretKey": "string"
}
},
"browserCredential": {
"properties": {
"subject": "string",
"vapidPrivateKey": "string",
"vapidPublicKey": "string"
}
},
"fcmV1Credential": {
"properties": {
"clientEmail": "string",
"privateKey": "string",
"projectId": "string"
}
},
"gcmCredential": {
"properties": {
"gcmEndpoint": "string",
"googleApiKey": "string"
}
},
"mpnsCredential": {
"properties": {
"certificateKey": "string",
"mpnsCertificate": "string",
"thumbprint": "string"
}
},
"name": "string",
"registrationTtl": "string",
"wnsCredential": {
"properties": {
"certificateKey": "string",
"packageSid": "string",
"secretKey": "string",
"windowsLiveEndpoint": "string",
"wnsCertificate": "string"
}
},
"xiaomiCredential": {
"properties": {
"appSecret": "string",
"endpoint": "string"
}
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.NotificationHubs/namespaces/notificationHubs' |
apiVersion | The resource api version | '2023-10-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-260 Valid characters: Alphanumerics, periods, hyphens, and underscores. Start alphanumeric. |
location | The geo-location where the resource lives | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
sku | The Sku description for a namespace | Sku |
properties | NotificationHub properties. | NotificationHubProperties |
Name | Description | Value |
---|---|---|
admCredential | Description of a NotificationHub AdmCredential. | AdmCredential |
apnsCredential | Description of a NotificationHub ApnsCredential. | ApnsCredential |
baiduCredential | Description of a NotificationHub BaiduCredential. | BaiduCredential |
browserCredential | Description of a NotificationHub BrowserCredential. | BrowserCredential |
fcmV1Credential | Description of a NotificationHub FcmV1Credential. | FcmV1Credential |
gcmCredential | Description of a NotificationHub GcmCredential. | GcmCredential |
mpnsCredential | Description of a NotificationHub MpnsCredential. | MpnsCredential |
name | Gets or sets the NotificationHub name. | string |
registrationTtl | Gets or sets the RegistrationTtl of the created NotificationHub | string |
wnsCredential | Description of a NotificationHub WnsCredential. | WnsCredential |
xiaomiCredential | Description of a NotificationHub XiaomiCredential. | XiaomiCredential |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub AdmCredential. | AdmCredentialProperties (required) |
Name | Description | Value |
---|---|---|
authTokenUrl | Gets or sets the URL of the authorization token. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
clientId | Gets or sets the client identifier. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
clientSecret | Gets or sets the credential secret access key. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub ApnsCredential. | ApnsCredentialProperties (required) |
Name | Description | Value |
---|---|---|
apnsCertificate | Gets or sets the APNS certificate. | string Constraints: Sensitive value. Pass in as a secure parameter. |
appId | Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account |
string Constraints: Sensitive value. Pass in as a secure parameter. |
appName | Gets or sets the name of the application | string Constraints: Sensitive value. Pass in as a secure parameter. |
certificateKey | Gets or sets the certificate key. | string Constraints: Sensitive value. Pass in as a secure parameter. |
endpoint | Gets or sets the endpoint of this credential. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
keyId | Gets or sets a 10-character key identifier (kid) key, obtained from your developer account |
string Constraints: Sensitive value. Pass in as a secure parameter. |
thumbprint | Gets or sets the APNS certificate Thumbprint | string Constraints: Sensitive value. Pass in as a secure parameter. |
token | Gets or sets provider Authentication Token, obtained through your developer account |
string Constraints: Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub BaiduCredential. | BaiduCredentialProperties (required) |
Name | Description | Value |
---|---|---|
baiduApiKey | Gets or sets baidu Api Key. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
baiduEndPoint | Gets or sets baidu Endpoint. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
baiduSecretKey | Gets or sets baidu Secret Key | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub BrowserCredential. | BrowserCredentialProperties (required) |
Name | Description | Value |
---|---|---|
subject | Gets or sets web push subject. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
vapidPrivateKey | Gets or sets VAPID private key. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
vapidPublicKey | Gets or sets VAPID public key. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub FcmV1Credential. | FcmV1CredentialProperties (required) |
Name | Description | Value |
---|---|---|
clientEmail | Gets or sets client email. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
privateKey | Gets or sets private key. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
projectId | Gets or sets project id. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub GcmCredential. | GcmCredentialProperties (required) |
Name | Description | Value |
---|---|---|
gcmEndpoint | Gets or sets the GCM endpoint. | string Constraints: Sensitive value. Pass in as a secure parameter. |
googleApiKey | Gets or sets the Google API key. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub MpnsCredential. | MpnsCredentialProperties (required) |
Name | Description | Value |
---|---|---|
certificateKey | Gets or sets the certificate key for this credential. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
mpnsCertificate | Gets or sets the MPNS certificate. | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
thumbprint | Gets or sets the MPNS certificate Thumbprint | string (required) Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub WnsCredential. | WnsCredentialProperties (required) |
Name | Description | Value |
---|---|---|
certificateKey | Ges or sets the WNS Certificate Key. | string Constraints: Sensitive value. Pass in as a secure parameter. |
packageSid | Gets or sets the package ID for this credential. | string Constraints: Sensitive value. Pass in as a secure parameter. |
secretKey | Gets or sets the secret key. | string Constraints: Sensitive value. Pass in as a secure parameter. |
windowsLiveEndpoint | Gets or sets the Windows Live endpoint. | string Constraints: Sensitive value. Pass in as a secure parameter. |
wnsCertificate | Gets or sets the WNS Certificate. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
properties | Description of a NotificationHub XiaomiCredentialProperties. | XiaomiCredentialProperties (required) |
Name | Description | Value |
---|---|---|
appSecret | Gets or sets app secret. | string Constraints: Sensitive value. Pass in as a secure parameter. |
endpoint | Gets or sets xiaomi service endpoint. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Name | Description | Value |
---|---|---|
capacity | Gets or sets the capacity of the resource | int |
family | Gets or sets the Sku Family | string |
name | Namespace SKU name. | 'Basic' 'Free' 'Standard' (required) |
size | Gets or sets the Sku size | string |
tier | Gets or sets the tier of particular sku | string |
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. |