Share via

Microsoft.NotificationHubs namespaces/notificationHubs 2016-03-01

  • 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@2016-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    admCredential: {
      properties: {
        authTokenUrl: 'string'
        clientId: 'string'
        clientSecret: 'string'
      }
    }
    apnsCredential: {
      properties: {
        apnsCertificate: 'string'
        certificateKey: 'string'
        endpoint: 'string'
        thumbprint: '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'
      }
    }
  }
}

Property values

namespaces/notificationHubs

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-260

Valid characters:
Alphanumerics, periods, hyphens, and underscores.

Start alphanumeric.
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
sku The sku of the created namespace Sku
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)

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

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. string
certificateKey The certificate key. string
endpoint The endpoint of this credential. string
thumbprint The APNS certificate Thumbprint string

SharedAccessAuthorizationRuleProperties

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

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 GCM endpoint. 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

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

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

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.

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": "2016-03-01",
  "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",
        "certificateKey": "string",
        "endpoint": "string",
        "thumbprint": "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"
      }
    }
  }
}

Property values

namespaces/notificationHubs

Name Description Value
type The resource type 'Microsoft.NotificationHubs/namespaces/notificationHubs'
apiVersion The resource api version '2016-03-01'
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 Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
sku The sku of the created namespace Sku
properties Properties of the NotificationHub. NotificationHubProperties (required)

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

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. string
certificateKey The certificate key. string
endpoint The endpoint of this credential. string
thumbprint The APNS certificate Thumbprint string

SharedAccessAuthorizationRuleProperties

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

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 GCM endpoint. 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

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

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

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@2016-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      admCredential = {
        properties = {
          authTokenUrl = "string"
          clientId = "string"
          clientSecret = "string"
        }
      }
      apnsCredential = {
        properties = {
          apnsCertificate = "string"
          certificateKey = "string"
          endpoint = "string"
          thumbprint = "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

namespaces/notificationHubs

Name Description Value
type The resource type "Microsoft.NotificationHubs/namespaces/notificationHubs@2016-03-01"
name The resource name string (required)

Character limit: 1-260

Valid characters:
Alphanumerics, periods, hyphens, and underscores.

Start alphanumeric.
location Resource location string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
tags Resource tags Dictionary of tag names and values.
sku The sku of the created namespace Sku
properties Properties of the NotificationHub. NotificationHubProperties (required)

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

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. string
certificateKey The certificate key. string
endpoint The endpoint of this credential. string
thumbprint The APNS certificate Thumbprint string

SharedAccessAuthorizationRuleProperties

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

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 GCM endpoint. 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

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

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