Microsoft.NotificationHubs namespaces/notificationHubs 2014-09-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@2014-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    admCredential: {
      properties: {
        authTokenUrl: 'string'
        clientId: 'string'
        clientSecret: 'string'
      }
    }
    apnsCredential: {
      properties: {
        apnsCertificate: 'string'
        certificateKey: 'string'
        endpoint: 'string'
        thumbprint: 'string'
      }
    }
    authorizationRules: [
      {
        claimType: 'string'
        claimValue: 'string'
        createdTime: 'string'
        keyName: 'string'
        modifiedTime: 'string'
        primaryKey: 'string'
        revision: int
        rights: [
          'string'
        ]
        secondaryKey: '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 Gets or sets NotificationHub data center location. string (required)
tags Gets or sets NotificationHub tags. Dictionary of tag names and values. See Tags in templates
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 Gets or sets 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 Gets or sets properties of NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

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

ApnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Name Description Value
apnsCertificate Gets or sets the APNS certificate. string
certificateKey Gets or sets the certificate key. string
endpoint Gets or sets the endpoint of this credential. string
thumbprint Gets or sets the Apns certificate Thumbprint string

SharedAccessAuthorizationRuleProperties

Name Description Value
claimType The type of the claim. string
claimValue The value of the claim. string
createdTime The time at which the authorization rule was created. string
keyName The name of the key that was used. string
modifiedTime The most recent time the rule was updated. string
primaryKey The primary key that was used. string
revision The revision number for the rule. int
rights The rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send'
secondaryKey The secondary key that was used. string

BaiduCredential

Name Description Value
properties Gets or sets properties of NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

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

GcmCredential

Name Description Value
properties Gets or sets properties of NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Name Description Value
gcmEndpoint Gets or sets the GCM endpoint. string
googleApiKey Gets or sets the Google API key. string

MpnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Name Description Value
certificateKey Gets or sets the certificate key for this credential. string
mpnsCertificate Gets or sets the MPNS certificate. string
thumbprint Gets or sets the Mpns certificate Thumbprint string

WnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Name Description Value
packageSid Gets or sets the package ID for this credential. string
secretKey Gets or sets the secret key. string
windowsLiveEndpoint Gets or sets the Windows Live endpoint. 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": "2014-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "admCredential": {
      "properties": {
        "authTokenUrl": "string",
        "clientId": "string",
        "clientSecret": "string"
      }
    },
    "apnsCredential": {
      "properties": {
        "apnsCertificate": "string",
        "certificateKey": "string",
        "endpoint": "string",
        "thumbprint": "string"
      }
    },
    "authorizationRules": [
      {
        "claimType": "string",
        "claimValue": "string",
        "createdTime": "string",
        "keyName": "string",
        "modifiedTime": "string",
        "primaryKey": "string",
        "revision": "int",
        "rights": [ "string" ],
        "secondaryKey": "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 '2014-09-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 Gets or sets NotificationHub data center location. string (required)
tags Gets or sets NotificationHub tags. Dictionary of tag names and values. See Tags in templates
properties Gets or sets 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 Gets or sets properties of NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

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

ApnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Name Description Value
apnsCertificate Gets or sets the APNS certificate. string
certificateKey Gets or sets the certificate key. string
endpoint Gets or sets the endpoint of this credential. string
thumbprint Gets or sets the Apns certificate Thumbprint string

SharedAccessAuthorizationRuleProperties

Name Description Value
claimType The type of the claim. string
claimValue The value of the claim. string
createdTime The time at which the authorization rule was created. string
keyName The name of the key that was used. string
modifiedTime The most recent time the rule was updated. string
primaryKey The primary key that was used. string
revision The revision number for the rule. int
rights The rights associated with the rule. String array containing any of:
'Listen'
'Manage'
'Send'
secondaryKey The secondary key that was used. string

BaiduCredential

Name Description Value
properties Gets or sets properties of NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

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

GcmCredential

Name Description Value
properties Gets or sets properties of NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Name Description Value
gcmEndpoint Gets or sets the GCM endpoint. string
googleApiKey Gets or sets the Google API key. string

MpnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Name Description Value
certificateKey Gets or sets the certificate key for this credential. string
mpnsCertificate Gets or sets the MPNS certificate. string
thumbprint Gets or sets the Mpns certificate Thumbprint string

WnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Name Description Value
packageSid Gets or sets the package ID for this credential. string
secretKey Gets or sets the secret key. string
windowsLiveEndpoint Gets or sets the Windows Live endpoint. 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@2014-09-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 = [
        {
          claimType = "string"
          claimValue = "string"
          createdTime = "string"
          keyName = "string"
          modifiedTime = "string"
          primaryKey = "string"
          revision = int
          rights = [
            "string"
          ]
          secondaryKey = "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@2014-09-01"
name The resource name string (required)

Character limit: 1-260

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

Start alphanumeric.
location Gets or sets NotificationHub data center location. string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
tags Gets or sets NotificationHub tags. Dictionary of tag names and values.
properties Gets or sets 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 Gets or sets properties of NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

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

ApnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Name Description Value
apnsCertificate Gets or sets the APNS certificate. string
certificateKey Gets or sets the certificate key. string
endpoint Gets or sets the endpoint of this credential. string
thumbprint Gets or sets the Apns certificate Thumbprint string

SharedAccessAuthorizationRuleProperties

Name Description Value
claimType The type of the claim. string
claimValue The value of the claim. string
createdTime The time at which the authorization rule was created. string
keyName The name of the key that was used. string
modifiedTime The most recent time the rule was updated. string
primaryKey The primary key that was used. string
revision The revision number for the rule. int
rights The rights associated with the rule. String array containing any of:
"Listen"
"Manage"
"Send"
secondaryKey The secondary key that was used. string

BaiduCredential

Name Description Value
properties Gets or sets properties of NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

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

GcmCredential

Name Description Value
properties Gets or sets properties of NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Name Description Value
gcmEndpoint Gets or sets the GCM endpoint. string
googleApiKey Gets or sets the Google API key. string

MpnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Name Description Value
certificateKey Gets or sets the certificate key for this credential. string
mpnsCertificate Gets or sets the MPNS certificate. string
thumbprint Gets or sets the Mpns certificate Thumbprint string

WnsCredential

Name Description Value
properties Gets or sets properties of NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Name Description Value
packageSid Gets or sets the package ID for this credential. string
secretKey Gets or sets the secret key. string
windowsLiveEndpoint Gets or sets the Windows Live endpoint. string