Share via

Microsoft.NotificationHubs namespaces/notificationHubs

  • Article

Bicep resource definition

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.

Resource format

To create a Microsoft.NotificationHubs/namespaces/notificationHubs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: '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'
      }
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AdmCredential

Name Description Value
properties Description of a NotificationHub AdmCredential. AdmCredentialProperties (required)

AdmCredentialProperties

Name Description Value
authTokenUrl Gets or sets the URL of the authorization token. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
clientId Gets or sets the client identifier. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
clientSecret Gets or sets the credential secret access key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

ApnsCredential

Name Description Value
properties Description of a NotificationHub ApnsCredential. ApnsCredentialProperties (required)

ApnsCredentialProperties

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

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
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.

BaiduCredential

Name Description Value
properties Description of a NotificationHub BaiduCredential. BaiduCredentialProperties (required)

BaiduCredentialProperties

Name Description Value
baiduApiKey Gets or sets baidu Api Key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
baiduEndPoint Gets or sets baidu Endpoint. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
baiduSecretKey Gets or sets baidu Secret Key string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

BrowserCredential

Name Description Value
properties Description of a NotificationHub BrowserCredential. BrowserCredentialProperties (required)

BrowserCredentialProperties

Name Description Value
subject Gets or sets web push subject. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
vapidPrivateKey Gets or sets VAPID private key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
vapidPublicKey Gets or sets VAPID public key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

FcmV1Credential

Name Description Value
properties Description of a NotificationHub FcmV1Credential. FcmV1CredentialProperties (required)

FcmV1CredentialProperties

Name Description Value
clientEmail Gets or sets client email. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
privateKey Gets or sets private key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
projectId Gets or sets project id. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

GcmCredential

Name Description Value
properties Description of a NotificationHub GcmCredential. GcmCredentialProperties (required)

GcmCredentialProperties

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

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

Microsoft.NotificationHubs/namespaces/notificationHubs

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: namespaces
properties NotificationHub properties. NotificationHubProperties
sku The Sku description for a namespace Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

MpnsCredential

Name Description Value
properties Description of a NotificationHub MpnsCredential. MpnsCredentialProperties (required)

MpnsCredentialProperties

Name Description Value
certificateKey Gets or sets the certificate key for this credential. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
mpnsCertificate Gets or sets the MPNS certificate. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
thumbprint Gets or sets the MPNS certificate Thumbprint string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

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

Sku

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

TrackedResourceTags

Name Description Value

WnsCredential

Name Description Value
properties Description of a NotificationHub WnsCredential. WnsCredentialProperties (required)

WnsCredentialProperties

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.

XiaomiCredential

Name Description Value
properties Description of a NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (required)

XiaomiCredentialProperties

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.

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/notificationHubs 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.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",
  "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"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AdmCredential

Name Description Value
properties Description of a NotificationHub AdmCredential. AdmCredentialProperties (required)

AdmCredentialProperties

Name Description Value
authTokenUrl Gets or sets the URL of the authorization token. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
clientId Gets or sets the client identifier. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
clientSecret Gets or sets the credential secret access key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

ApnsCredential

Name Description Value
properties Description of a NotificationHub ApnsCredential. ApnsCredentialProperties (required)

ApnsCredentialProperties

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

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
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.

BaiduCredential

Name Description Value
properties Description of a NotificationHub BaiduCredential. BaiduCredentialProperties (required)

BaiduCredentialProperties

Name Description Value
baiduApiKey Gets or sets baidu Api Key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
baiduEndPoint Gets or sets baidu Endpoint. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
baiduSecretKey Gets or sets baidu Secret Key string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

BrowserCredential

Name Description Value
properties Description of a NotificationHub BrowserCredential. BrowserCredentialProperties (required)

BrowserCredentialProperties

Name Description Value
subject Gets or sets web push subject. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
vapidPrivateKey Gets or sets VAPID private key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
vapidPublicKey Gets or sets VAPID public key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

FcmV1Credential

Name Description Value
properties Description of a NotificationHub FcmV1Credential. FcmV1CredentialProperties (required)

FcmV1CredentialProperties

Name Description Value
clientEmail Gets or sets client email. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
privateKey Gets or sets private key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
projectId Gets or sets project id. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

GcmCredential

Name Description Value
properties Description of a NotificationHub GcmCredential. GcmCredentialProperties (required)

GcmCredentialProperties

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

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

Microsoft.NotificationHubs/namespaces/notificationHubs

Name Description Value
apiVersion The api version '2023-10-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (required)
properties NotificationHub properties. NotificationHubProperties
sku The Sku description for a namespace Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.NotificationHubs/namespaces/notificationHubs'

MpnsCredential

Name Description Value
properties Description of a NotificationHub MpnsCredential. MpnsCredentialProperties (required)

MpnsCredentialProperties

Name Description Value
certificateKey Gets or sets the certificate key for this credential. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
mpnsCertificate Gets or sets the MPNS certificate. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
thumbprint Gets or sets the MPNS certificate Thumbprint string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

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

Sku

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

TrackedResourceTags

Name Description Value

WnsCredential

Name Description Value
properties Description of a NotificationHub WnsCredential. WnsCredentialProperties (required)

WnsCredentialProperties

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.

XiaomiCredential

Name Description Value
properties Description of a NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (required)

XiaomiCredentialProperties

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.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Azure Notification Hub

Deploy to Azure		 Creates an Azure Notification Hub, Template originally authored by John Downs.
Provision a Mobile App with a SQL Database

Deploy to Azure		 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/notificationHubs 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/notificationHubs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
        }
      }
    }
  })
}

Property values

AdmCredential

Name Description Value
properties Description of a NotificationHub AdmCredential. AdmCredentialProperties (required)

AdmCredentialProperties

Name Description Value
authTokenUrl Gets or sets the URL of the authorization token. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
clientId Gets or sets the client identifier. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
clientSecret Gets or sets the credential secret access key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

ApnsCredential

Name Description Value
properties Description of a NotificationHub ApnsCredential. ApnsCredentialProperties (required)

ApnsCredentialProperties

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

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
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.

BaiduCredential

Name Description Value
properties Description of a NotificationHub BaiduCredential. BaiduCredentialProperties (required)

BaiduCredentialProperties

Name Description Value
baiduApiKey Gets or sets baidu Api Key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
baiduEndPoint Gets or sets baidu Endpoint. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
baiduSecretKey Gets or sets baidu Secret Key string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

BrowserCredential

Name Description Value
properties Description of a NotificationHub BrowserCredential. BrowserCredentialProperties (required)

BrowserCredentialProperties

Name Description Value
subject Gets or sets web push subject. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
vapidPrivateKey Gets or sets VAPID private key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
vapidPublicKey Gets or sets VAPID public key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

FcmV1Credential

Name Description Value
properties Description of a NotificationHub FcmV1Credential. FcmV1CredentialProperties (required)

FcmV1CredentialProperties

Name Description Value
clientEmail Gets or sets client email. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
privateKey Gets or sets private key. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
projectId Gets or sets project id. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

GcmCredential

Name Description Value
properties Description of a NotificationHub GcmCredential. GcmCredentialProperties (required)

GcmCredentialProperties

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

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

Microsoft.NotificationHubs/namespaces/notificationHubs

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z][a-zA-Z0-9-./_]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties NotificationHub properties. NotificationHubProperties
sku The Sku description for a namespace Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview"

MpnsCredential

Name Description Value
properties Description of a NotificationHub MpnsCredential. MpnsCredentialProperties (required)

MpnsCredentialProperties

Name Description Value
certificateKey Gets or sets the certificate key for this credential. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
mpnsCertificate Gets or sets the MPNS certificate. string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)
thumbprint Gets or sets the MPNS certificate Thumbprint string

Constraints:
Min length = 1
Sensitive value. Pass in as a secure parameter. (required)

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

Sku

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

TrackedResourceTags

Name Description Value

WnsCredential

Name Description Value
properties Description of a NotificationHub WnsCredential. WnsCredentialProperties (required)

WnsCredentialProperties

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.

XiaomiCredential

Name Description Value
properties Description of a NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (required)

XiaomiCredentialProperties

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.