Share via

Microsoft.NotificationHubs namespaces/notificationHubs 2017-04-01

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@2017-04-01' = {
  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'
      }
    }
    authorizationRules: [
      {
        rights: [
          'string'
        ]
      }
    ]
    baiduCredential: {
      properties: {
        baiduApiKey: 'string'
        baiduEndPoint: 'string'
        baiduSecretKey: 'string'
      }
    }
    gcmCredential: {
      properties: {
        gcmEndpoint: 'string'
        googleApiKey: 'string'
      }
    }
    mpnsCredential: {
      properties: {
        certificateKey: 'string'
        mpnsCertificate: 'string'
        thumbprint: 'string'
      }
    }
    name: 'string'
    registrationTtl: 'string'
    wnsCredential: {
      properties: {
        packageSid: 'string'
        secretKey: 'string'
        windowsLiveEndpoint: 'string'
      }
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.NotificationHubs/namespaces/notificationHubs

Name Description Value
location Resource location string
name The resource name string (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 Properties of the NotificationHub. NotificationHubProperties (required)
sku The sku of the created namespace Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

AdmCredential

Name Description Value
properties Properties of NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

Name Description Value
authTokenUrl The URL of the authorization token. string
clientId The client identifier. string
clientSecret The credential secret access key. string

ApnsCredential

Name Description Value
properties Properties of NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Name Description Value
apnsCertificate The APNS certificate. Specify if using Certificate Authentication Mode. string
appId The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode. string
appName The name of the application or BundleId. Specify if using Token Authentication Mode. string
certificateKey The APNS certificate password if it exists. string
endpoint The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'. string
keyId A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode. string
thumbprint The APNS certificate thumbprint. Specify if using Certificate Authentication Mode. string
token Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode. string

BaiduCredential

Name Description Value
properties Properties of NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

Name Description Value
baiduApiKey Baidu Api Key. string
baiduEndPoint Baidu Endpoint. string
baiduSecretKey Baidu Secret Key string

GcmCredential

Name Description Value
properties Properties of NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Name Description Value
gcmEndpoint The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send' string
googleApiKey The Google API key. string

MpnsCredential

Name Description Value
properties Properties of NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Name Description Value
certificateKey The certificate key for this credential. string
mpnsCertificate The MPNS certificate. string
thumbprint The MPNS certificate Thumbprint string

NotificationHubProperties

Name Description Value
admCredential The AdmCredential of the created NotificationHub AdmCredential
apnsCredential The ApnsCredential of the created NotificationHub ApnsCredential
authorizationRules The AuthorizationRules of the created NotificationHub SharedAccessAuthorizationRuleProperties[]
baiduCredential The BaiduCredential of the created NotificationHub BaiduCredential
gcmCredential The GcmCredential of the created NotificationHub GcmCredential
mpnsCredential The MpnsCredential of the created NotificationHub MpnsCredential
name The NotificationHub name. string
registrationTtl The RegistrationTtl of the created NotificationHub string
wnsCredential The WnsCredential of the created NotificationHub WnsCredential

ResourceTags

Name Description Value

SharedAccessAuthorizationRuleProperties

Name Description Value
rights The rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send'

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

WnsCredential

Name Description Value
properties Properties of NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Name Description Value
packageSid The package ID for this credential. string
secretKey The secret key. string
windowsLiveEndpoint The Windows Live endpoint. string

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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": "2017-04-01",
  "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"
      }
    },
    "authorizationRules": [
      {
        "rights": [ "string" ]
      }
    ],
    "baiduCredential": {
      "properties": {
        "baiduApiKey": "string",
        "baiduEndPoint": "string",
        "baiduSecretKey": "string"
      }
    },
    "gcmCredential": {
      "properties": {
        "gcmEndpoint": "string",
        "googleApiKey": "string"
      }
    },
    "mpnsCredential": {
      "properties": {
        "certificateKey": "string",
        "mpnsCertificate": "string",
        "thumbprint": "string"
      }
    },
    "name": "string",
    "registrationTtl": "string",
    "wnsCredential": {
      "properties": {
        "packageSid": "string",
        "secretKey": "string",
        "windowsLiveEndpoint": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.NotificationHubs/namespaces/notificationHubs

Name Description Value
apiVersion The api version '2017-04-01'
location Resource location string
name The resource name string (required)
properties Properties of the NotificationHub. NotificationHubProperties (required)
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/notificationHubs'

AdmCredential

Name Description Value
properties Properties of NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

Name Description Value
authTokenUrl The URL of the authorization token. string
clientId The client identifier. string
clientSecret The credential secret access key. string

ApnsCredential

Name Description Value
properties Properties of NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Name Description Value
apnsCertificate The APNS certificate. Specify if using Certificate Authentication Mode. string
appId The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode. string
appName The name of the application or BundleId. Specify if using Token Authentication Mode. string
certificateKey The APNS certificate password if it exists. string
endpoint The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'. string
keyId A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode. string
thumbprint The APNS certificate thumbprint. Specify if using Certificate Authentication Mode. string
token Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode. string

BaiduCredential

Name Description Value
properties Properties of NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

Name Description Value
baiduApiKey Baidu Api Key. string
baiduEndPoint Baidu Endpoint. string
baiduSecretKey Baidu Secret Key string

GcmCredential

Name Description Value
properties Properties of NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Name Description Value
gcmEndpoint The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send' string
googleApiKey The Google API key. string

MpnsCredential

Name Description Value
properties Properties of NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Name Description Value
certificateKey The certificate key for this credential. string
mpnsCertificate The MPNS certificate. string
thumbprint The MPNS certificate Thumbprint string

NotificationHubProperties

Name Description Value
admCredential The AdmCredential of the created NotificationHub AdmCredential
apnsCredential The ApnsCredential of the created NotificationHub ApnsCredential
authorizationRules The AuthorizationRules of the created NotificationHub SharedAccessAuthorizationRuleProperties[]
baiduCredential The BaiduCredential of the created NotificationHub BaiduCredential
gcmCredential The GcmCredential of the created NotificationHub GcmCredential
mpnsCredential The MpnsCredential of the created NotificationHub MpnsCredential
name The NotificationHub name. string
registrationTtl The RegistrationTtl of the created NotificationHub string
wnsCredential The WnsCredential of the created NotificationHub WnsCredential

ResourceTags

Name Description Value

SharedAccessAuthorizationRuleProperties

Name Description Value
rights The rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send'

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

WnsCredential

Name Description Value
properties Properties of NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Name Description Value
packageSid The package ID for this credential. string
secretKey The secret key. string
windowsLiveEndpoint The Windows Live endpoint. string

Usage Examples

Azure Quickstart Templates

The following Azure 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@2017-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
        }
      }
      authorizationRules = [
        {
          rights = [
            "string"
          ]
        }
      ]
      baiduCredential = {
        properties = {
          baiduApiKey = "string"
          baiduEndPoint = "string"
          baiduSecretKey = "string"
        }
      }
      gcmCredential = {
        properties = {
          gcmEndpoint = "string"
          googleApiKey = "string"
        }
      }
      mpnsCredential = {
        properties = {
          certificateKey = "string"
          mpnsCertificate = "string"
          thumbprint = "string"
        }
      }
      name = "string"
      registrationTtl = "string"
      wnsCredential = {
        properties = {
          packageSid = "string"
          secretKey = "string"
          windowsLiveEndpoint = "string"
        }
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.NotificationHubs/namespaces/notificationHubs

Name Description Value
location Resource location string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties Properties of the NotificationHub. NotificationHubProperties (required)
sku The sku of the created namespace Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01"

AdmCredential

Name Description Value
properties Properties of NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

Name Description Value
authTokenUrl The URL of the authorization token. string
clientId The client identifier. string
clientSecret The credential secret access key. string

ApnsCredential

Name Description Value
properties Properties of NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Name Description Value
apnsCertificate The APNS certificate. Specify if using Certificate Authentication Mode. string
appId The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode. string
appName The name of the application or BundleId. Specify if using Token Authentication Mode. string
certificateKey The APNS certificate password if it exists. string
endpoint The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'. string
keyId A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode. string
thumbprint The APNS certificate thumbprint. Specify if using Certificate Authentication Mode. string
token Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode. string

BaiduCredential

Name Description Value
properties Properties of NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

Name Description Value
baiduApiKey Baidu Api Key. string
baiduEndPoint Baidu Endpoint. string
baiduSecretKey Baidu Secret Key string

GcmCredential

Name Description Value
properties Properties of NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Name Description Value
gcmEndpoint The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send' string
googleApiKey The Google API key. string

MpnsCredential

Name Description Value
properties Properties of NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Name Description Value
certificateKey The certificate key for this credential. string
mpnsCertificate The MPNS certificate. string
thumbprint The MPNS certificate Thumbprint string

NotificationHubProperties

Name Description Value
admCredential The AdmCredential of the created NotificationHub AdmCredential
apnsCredential The ApnsCredential of the created NotificationHub ApnsCredential
authorizationRules The AuthorizationRules of the created NotificationHub SharedAccessAuthorizationRuleProperties[]
baiduCredential The BaiduCredential of the created NotificationHub BaiduCredential
gcmCredential The GcmCredential of the created NotificationHub GcmCredential
mpnsCredential The MpnsCredential of the created NotificationHub MpnsCredential
name The NotificationHub name. string
registrationTtl The RegistrationTtl of the created NotificationHub string
wnsCredential The WnsCredential of the created NotificationHub WnsCredential

ResourceTags

Name Description Value

SharedAccessAuthorizationRuleProperties

Name Description Value
rights The rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send'

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

WnsCredential

Name Description Value
properties Properties of NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Name Description Value
packageSid The package ID for this credential. string
secretKey The secret key. string
windowsLiveEndpoint The Windows Live endpoint. string