Partager via

Espaces de noms Microsoft.NotificationHubs 2023-09-01

Définition de ressource Bicep

Le type de ressource d’espaces de noms peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.NotificationHubs/namespaces, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-09-01' = {
  location: 'string'
  name: 'string'
  properties: {
    dataCenter: 'string'
    namespaceType: 'string'
    networkAcls: {
      ipRules: [
        {
          ipMask: 'string'
          rights: [
            'string'
          ]
        }
      ]
      publicNetworkRule: {
        rights: [
          'string'
        ]
      }
    }
    pnsCredentials: {
      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'
        }
      }
      gcmCredential: {
        properties: {
          gcmEndpoint: 'string'
          googleApiKey: 'string'
        }
      }
      mpnsCredential: {
        properties: {
          certificateKey: 'string'
          mpnsCertificate: 'string'
          thumbprint: 'string'
        }
      }
      wnsCredential: {
        properties: {
          certificateKey: 'string'
          packageSid: 'string'
          secretKey: 'string'
          windowsLiveEndpoint: 'string'
          wnsCertificate: 'string'
        }
      }
      xiaomiCredential: {
        properties: {
          appSecret: 'string'
          endpoint: 'string'
        }
      }
    }
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    replicationRegion: 'string'
    scaleUnit: 'string'
    status: 'string'
    zoneRedundancy: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.NotificationHubs/espaces de noms

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 50
Modèle = ^[a-zA-Z][a-zA-Z0-9-]*$ (obligatoire)
Propriétés Représente les propriétés de l’espace de noms. NamespaceProperties
Sku Description de la référence SKU pour un espace de noms référence SKU (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

AdmCredential (en anglais seulement)

Nom Descriptif Valeur
Propriétés Description d’une notificationHub AdmCredential. AdmCredentialProperties (obligatoire)

AdmCredentialProperties

Nom Descriptif Valeur
authTokenUrl Obtient ou définit l’URL du jeton d’autorisation. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
clientId Obtient ou définit l’identificateur du client. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
clientSecret Obtient ou définit la clé d’accès au secret d’informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

ApnsCredential

Nom Descriptif Valeur
Propriétés Description d’un ApnsCredential NotificationHub. ApnsCredentialProperties (obligatoire)

ApnsCredentialProperties

Nom Descriptif Valeur
apnsCertificat Obtient ou définit le certificat APNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
identifiant de l'application Obtient ou définit la clé de revendication inscrite de l’émetteur (iss), dont la valeur est
votre ID d’équipe de 10 caractères, obtenu à partir de votre compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
nomappli Obtient ou définit le nom de l’application corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
certificateKey Obtient ou définit la clé de certificat. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
extrémité Obtient ou définit le point de terminaison de ces informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
keyId Obtient ou définit une clé d’identificateur de clé de 10 caractères (kid), obtenue à partir de
votre compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
Empreinte Obtient ou définit l’empreinte numérique du certificat APNS corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
jeton Obtient ou définit le jeton d’authentification du fournisseur, obtenu via votre
Compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

BaiduCredential

Nom Descriptif Valeur
Propriétés Description d’une notificationHub BaiduCredential. BaiduCredentialProperties (obligatoire)

BaiduCredentialProperties

Nom Descriptif Valeur
baiduApiKey Obtient ou définit la clé api baidu. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
baiduEndPoint Obtient ou définit le point de terminaison baidu. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
baiduSecretKey Obtient ou définit la clé secrète baidu corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

BrowserCredential

Nom Descriptif Valeur
Propriétés Description d’un BrowserCredential NotificationHub. BrowserCredentialProperties (obligatoire)

BrowserCredentialProperties

Nom Descriptif Valeur
Objet Obtient ou définit l’objet push web. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
vapidPrivateKey Obtient ou définit la clé privée VAPID. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
vapidPublicKey Obtient ou définit la clé publique VAPID. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

GcmCredential

Nom Descriptif Valeur
Propriétés Description d’un GcmCredential NotificationHub. GcmCredentialProperties (obligatoire)

GcmCredentialProperties

Nom Descriptif Valeur
gcmPoint de terminaison Obtient ou définit le point de terminaison GCM. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
googleApiKey Obtient ou définit la clé API Google. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

IpRule

Nom Descriptif Valeur
Masque d’ipMask Masque IP. corde

Contraintes:
Longueur minimale = 1 (obligatoire)
droits Liste des droits d’accès. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send' (obligatoire)

MpnsCredential

Nom Descriptif Valeur
Propriétés Description d’un MpnsCredential NotificationHub. MpnsCredentialProperties (obligatoire)

MpnsCredentialProperties

Nom Descriptif Valeur
certificateKey Obtient ou définit la clé de certificat pour ces informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
mpnsCertificat Obtient ou définit le certificat MPNS. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
Empreinte Obtient ou définit l’empreinte numérique du certificat MPNS corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

NamespaceProperties

Nom Descriptif Valeur
Centre de données Obsolescent. corde
espace de nomsType Définit des valeurs pour NamespaceType. 'Messagerie'
'NotificationHub'
networkAcls Collection de règles d’autorisation réseau. NetworkAcls
pnsRéférences Collection d’informations d’identification PNS de l’espace de noms Notification Hub ou Notification Hub. PnsRéférences
état de provisionnement Définit des valeurs pour OperationProvisioningState. 'Annulé'
'Désactivé'
'Échec'
'En cours'
'En attente'
'Réussi'
'Inconnu'
publicNetworkAccess Type d’accès au réseau public. 'Désactivé'
'Activé'
réplicationRégion Région de réplication autorisée 'AustralieEst '
'BrésilSouth'
Valeur par défaut
« Aucun »
« Europe du Nord »
'South AfricaNorth'
« Asie du Sud-Est »
'WestUs2'
scaleUnit Obtient ou définit scaleUnit où l’espace de noms est créé corde
statut État de l’espace de noms. 'Créé'
'Création'
'Suppression'
'Suspendu'
zoneRedondance Nom de la référence SKU de l’espace de noms. 'Désactivé'
'Activé'

NetworkAcls

Nom Descriptif Valeur
ipRules Liste des règles IP. IpRule []
publicNetworkRule Règle d’autorisation réseau (Internet public) par défaut, qui contient des droits si aucune autre règle réseau ne correspond. PublicInternetAuthorizationRule

PnsRéférences

Nom Descriptif Valeur
admCredential Description d’une notificationHub AdmCredential. AdmCredential
apnsInformations d’identification Description d’un ApnsCredential NotificationHub. ApnsCredential
baiduCredential Description d’une notificationHub BaiduCredential. BaiduCredential
browserCredential Description d’un BrowserCredential NotificationHub. BrowserCredential
gcmCredential Description d’un GcmCredential NotificationHub. GcmCredential
mpnsRéférence Description d’un MpnsCredential NotificationHub. MpnsCredential
wnsRéférence Description d’un notificationHub WnsCredential. WnsCredential
credential Description d’un NotificationHub SauvegardéCredential.

PublicInternetAuthorizationRule

Nom Descriptif Valeur
droits Liste des droits d’accès. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send' (obligatoire)

Sku

Nom Descriptif Valeur
capacité Obtient ou définit la capacité de la ressource Int
Famille Obtient ou définit la famille de références SKU corde
nom Nom de la référence SKU de l’espace de noms. 'De base'
« Gratuit »
'Standard' (obligatoire)
taille Obtient ou définit la taille de la référence SKU corde
niveau Obtient ou définit le niveau d’une référence SKU particulière corde

TrackedResourceTags

Nom Descriptif Valeur

WnsCredential

Nom Descriptif Valeur
Propriétés Description d’un notificationHub WnsCredential. WnsCredentialProperties (obligatoire)

WnsCredentialProperties

Nom Descriptif Valeur
certificateKey Ges ou définit la clé de certificat WNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
packageSid Obtient ou définit l’ID de package pour ces informations d’identification. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
secretKey Obtient ou définit la clé secrète. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
windowsLiveEndpoint Obtient ou définit le point de terminaison Windows Live. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
wnsCertificat Obtient ou définit le certificat WNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

SauvegardéCredential

Nom Descriptif Valeur
Propriétés Description d’un Objet NotificationHub SauvegardéCredentialProperties. DemandéeCredentialProperties (obligatoire)

SauvegardéCredentialProperties

Nom Descriptif Valeur
appSecret Obtient ou définit la clé secrète de l’application. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
extrémité Obtient ou définit le point de terminaison du service de configuration. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

Exemples d’utilisation

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
créer un Azure Notification Hub Crée un hub de notification Azure, modèle créé à l’origine par John Downs.

Définition de ressource de modèle ARM

Le type de ressource d’espaces de noms peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.NotificationHubs/namespaces, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.NotificationHubs/namespaces",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "properties": {
    "dataCenter": "string",
    "namespaceType": "string",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "string",
          "rights": [ "string" ]
        }
      ],
      "publicNetworkRule": {
        "rights": [ "string" ]
      }
    },
    "pnsCredentials": {
      "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"
        }
      },
      "gcmCredential": {
        "properties": {
          "gcmEndpoint": "string",
          "googleApiKey": "string"
        }
      },
      "mpnsCredential": {
        "properties": {
          "certificateKey": "string",
          "mpnsCertificate": "string",
          "thumbprint": "string"
        }
      },
      "wnsCredential": {
        "properties": {
          "certificateKey": "string",
          "packageSid": "string",
          "secretKey": "string",
          "windowsLiveEndpoint": "string",
          "wnsCertificate": "string"
        }
      },
      "xiaomiCredential": {
        "properties": {
          "appSecret": "string",
          "endpoint": "string"
        }
      }
    },
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "replicationRegion": "string",
    "scaleUnit": "string",
    "status": "string",
    "zoneRedundancy": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.NotificationHubs/espaces de noms

Nom Descriptif Valeur
apiVersion Version de l’API '2023-09-01'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 50
Modèle = ^[a-zA-Z][a-zA-Z0-9-]*$ (obligatoire)
Propriétés Représente les propriétés de l’espace de noms. NamespaceProperties
Sku Description de la référence SKU pour un espace de noms référence SKU (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.NotificationHubs/espaces de noms'

AdmCredential (en anglais seulement)

Nom Descriptif Valeur
Propriétés Description d’une notificationHub AdmCredential. AdmCredentialProperties (obligatoire)

AdmCredentialProperties

Nom Descriptif Valeur
authTokenUrl Obtient ou définit l’URL du jeton d’autorisation. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
clientId Obtient ou définit l’identificateur du client. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
clientSecret Obtient ou définit la clé d’accès au secret d’informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

ApnsCredential

Nom Descriptif Valeur
Propriétés Description d’un ApnsCredential NotificationHub. ApnsCredentialProperties (obligatoire)

ApnsCredentialProperties

Nom Descriptif Valeur
apnsCertificat Obtient ou définit le certificat APNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
identifiant de l'application Obtient ou définit la clé de revendication inscrite de l’émetteur (iss), dont la valeur est
votre ID d’équipe de 10 caractères, obtenu à partir de votre compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
nomappli Obtient ou définit le nom de l’application corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
certificateKey Obtient ou définit la clé de certificat. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
extrémité Obtient ou définit le point de terminaison de ces informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
keyId Obtient ou définit une clé d’identificateur de clé de 10 caractères (kid), obtenue à partir de
votre compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
Empreinte Obtient ou définit l’empreinte numérique du certificat APNS corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
jeton Obtient ou définit le jeton d’authentification du fournisseur, obtenu via votre
Compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

BaiduCredential

Nom Descriptif Valeur
Propriétés Description d’une notificationHub BaiduCredential. BaiduCredentialProperties (obligatoire)

BaiduCredentialProperties

Nom Descriptif Valeur
baiduApiKey Obtient ou définit la clé api baidu. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
baiduEndPoint Obtient ou définit le point de terminaison baidu. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
baiduSecretKey Obtient ou définit la clé secrète baidu corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

BrowserCredential

Nom Descriptif Valeur
Propriétés Description d’un BrowserCredential NotificationHub. BrowserCredentialProperties (obligatoire)

BrowserCredentialProperties

Nom Descriptif Valeur
Objet Obtient ou définit l’objet push web. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
vapidPrivateKey Obtient ou définit la clé privée VAPID. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
vapidPublicKey Obtient ou définit la clé publique VAPID. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

GcmCredential

Nom Descriptif Valeur
Propriétés Description d’un GcmCredential NotificationHub. GcmCredentialProperties (obligatoire)

GcmCredentialProperties

Nom Descriptif Valeur
gcmPoint de terminaison Obtient ou définit le point de terminaison GCM. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
googleApiKey Obtient ou définit la clé API Google. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

IpRule

Nom Descriptif Valeur
Masque d’ipMask Masque IP. corde

Contraintes:
Longueur minimale = 1 (obligatoire)
droits Liste des droits d’accès. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send' (obligatoire)

MpnsCredential

Nom Descriptif Valeur
Propriétés Description d’un MpnsCredential NotificationHub. MpnsCredentialProperties (obligatoire)

MpnsCredentialProperties

Nom Descriptif Valeur
certificateKey Obtient ou définit la clé de certificat pour ces informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
mpnsCertificat Obtient ou définit le certificat MPNS. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
Empreinte Obtient ou définit l’empreinte numérique du certificat MPNS corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

NamespaceProperties

Nom Descriptif Valeur
Centre de données Obsolescent. corde
espace de nomsType Définit des valeurs pour NamespaceType. 'Messagerie'
'NotificationHub'
networkAcls Collection de règles d’autorisation réseau. NetworkAcls
pnsRéférences Collection d’informations d’identification PNS de l’espace de noms Notification Hub ou Notification Hub. PnsRéférences
état de provisionnement Définit des valeurs pour OperationProvisioningState. 'Annulé'
'Désactivé'
'Échec'
'En cours'
'En attente'
'Réussi'
'Inconnu'
publicNetworkAccess Type d’accès au réseau public. 'Désactivé'
'Activé'
réplicationRégion Région de réplication autorisée 'AustralieEst '
'BrésilSouth'
Valeur par défaut
« Aucun »
« Europe du Nord »
'South AfricaNorth'
« Asie du Sud-Est »
'WestUs2'
scaleUnit Obtient ou définit scaleUnit où l’espace de noms est créé corde
statut État de l’espace de noms. 'Créé'
'Création'
'Suppression'
'Suspendu'
zoneRedondance Nom de la référence SKU de l’espace de noms. 'Désactivé'
'Activé'

NetworkAcls

Nom Descriptif Valeur
ipRules Liste des règles IP. IpRule []
publicNetworkRule Règle d’autorisation réseau (Internet public) par défaut, qui contient des droits si aucune autre règle réseau ne correspond. PublicInternetAuthorizationRule

PnsRéférences

Nom Descriptif Valeur
admCredential Description d’une notificationHub AdmCredential. AdmCredential
apnsInformations d’identification Description d’un ApnsCredential NotificationHub. ApnsCredential
baiduCredential Description d’une notificationHub BaiduCredential. BaiduCredential
browserCredential Description d’un BrowserCredential NotificationHub. BrowserCredential
gcmCredential Description d’un GcmCredential NotificationHub. GcmCredential
mpnsRéférence Description d’un MpnsCredential NotificationHub. MpnsCredential
wnsRéférence Description d’un notificationHub WnsCredential. WnsCredential
credential Description d’un NotificationHub SauvegardéCredential.

PublicInternetAuthorizationRule

Nom Descriptif Valeur
droits Liste des droits d’accès. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send' (obligatoire)

Sku

Nom Descriptif Valeur
capacité Obtient ou définit la capacité de la ressource Int
Famille Obtient ou définit la famille de références SKU corde
nom Nom de la référence SKU de l’espace de noms. 'De base'
« Gratuit »
'Standard' (obligatoire)
taille Obtient ou définit la taille de la référence SKU corde
niveau Obtient ou définit le niveau d’une référence SKU particulière corde

TrackedResourceTags

Nom Descriptif Valeur

WnsCredential

Nom Descriptif Valeur
Propriétés Description d’un notificationHub WnsCredential. WnsCredentialProperties (obligatoire)

WnsCredentialProperties

Nom Descriptif Valeur
certificateKey Ges ou définit la clé de certificat WNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
packageSid Obtient ou définit l’ID de package pour ces informations d’identification. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
secretKey Obtient ou définit la clé secrète. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
windowsLiveEndpoint Obtient ou définit le point de terminaison Windows Live. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
wnsCertificat Obtient ou définit le certificat WNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

SauvegardéCredential

Nom Descriptif Valeur
Propriétés Description d’un Objet NotificationHub SauvegardéCredentialProperties. DemandéeCredentialProperties (obligatoire)

SauvegardéCredentialProperties

Nom Descriptif Valeur
appSecret Obtient ou définit la clé secrète de l’application. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
extrémité Obtient ou définit le point de terminaison du service de configuration. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

Exemples d’utilisation

Modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
créer un Azure Notification Hub

Déployer sur Azure 		Crée un hub de notification Azure, modèle créé à l’origine par John Downs.
provisionner une application mobile avec un SQL Database

Déployer sur Azure 		Ce modèle provisionne une application mobile, une base de données SQL et un hub de notification. Il configure une chaîne de connexion dans l’application mobile pour la base de données et le hub de notification.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource d’espaces de noms peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.NotificationHubs/namespaces, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2023-09-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      dataCenter = "string"
      namespaceType = "string"
      networkAcls = {
        ipRules = [
          {
            ipMask = "string"
            rights = [
              "string"
            ]
          }
        ]
        publicNetworkRule = {
          rights = [
            "string"
          ]
        }
      }
      pnsCredentials = {
        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"
          }
        }
        gcmCredential = {
          properties = {
            gcmEndpoint = "string"
            googleApiKey = "string"
          }
        }
        mpnsCredential = {
          properties = {
            certificateKey = "string"
            mpnsCertificate = "string"
            thumbprint = "string"
          }
        }
        wnsCredential = {
          properties = {
            certificateKey = "string"
            packageSid = "string"
            secretKey = "string"
            windowsLiveEndpoint = "string"
            wnsCertificate = "string"
          }
        }
        xiaomiCredential = {
          properties = {
            appSecret = "string"
            endpoint = "string"
          }
        }
      }
      provisioningState = "string"
      publicNetworkAccess = "string"
      replicationRegion = "string"
      scaleUnit = "string"
      status = "string"
      zoneRedundancy = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

Valeurs de propriété

Microsoft.NotificationHubs/espaces de noms

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 50
Modèle = ^[a-zA-Z][a-zA-Z0-9-]*$ (obligatoire)
Propriétés Représente les propriétés de l’espace de noms. NamespaceProperties
Sku Description de la référence SKU pour un espace de noms référence SKU (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.NotificationHubs/namespaces@2023-09-01 »

AdmCredential (en anglais seulement)

Nom Descriptif Valeur
Propriétés Description d’une notificationHub AdmCredential. AdmCredentialProperties (obligatoire)

AdmCredentialProperties

Nom Descriptif Valeur
authTokenUrl Obtient ou définit l’URL du jeton d’autorisation. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
clientId Obtient ou définit l’identificateur du client. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
clientSecret Obtient ou définit la clé d’accès au secret d’informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

ApnsCredential

Nom Descriptif Valeur
Propriétés Description d’un ApnsCredential NotificationHub. ApnsCredentialProperties (obligatoire)

ApnsCredentialProperties

Nom Descriptif Valeur
apnsCertificat Obtient ou définit le certificat APNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
identifiant de l'application Obtient ou définit la clé de revendication inscrite de l’émetteur (iss), dont la valeur est
votre ID d’équipe de 10 caractères, obtenu à partir de votre compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
nomappli Obtient ou définit le nom de l’application corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
certificateKey Obtient ou définit la clé de certificat. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
extrémité Obtient ou définit le point de terminaison de ces informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
keyId Obtient ou définit une clé d’identificateur de clé de 10 caractères (kid), obtenue à partir de
votre compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
Empreinte Obtient ou définit l’empreinte numérique du certificat APNS corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
jeton Obtient ou définit le jeton d’authentification du fournisseur, obtenu via votre
Compte de développeur		 corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

BaiduCredential

Nom Descriptif Valeur
Propriétés Description d’une notificationHub BaiduCredential. BaiduCredentialProperties (obligatoire)

BaiduCredentialProperties

Nom Descriptif Valeur
baiduApiKey Obtient ou définit la clé api baidu. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
baiduEndPoint Obtient ou définit le point de terminaison baidu. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
baiduSecretKey Obtient ou définit la clé secrète baidu corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

BrowserCredential

Nom Descriptif Valeur
Propriétés Description d’un BrowserCredential NotificationHub. BrowserCredentialProperties (obligatoire)

BrowserCredentialProperties

Nom Descriptif Valeur
Objet Obtient ou définit l’objet push web. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
vapidPrivateKey Obtient ou définit la clé privée VAPID. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
vapidPublicKey Obtient ou définit la clé publique VAPID. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

GcmCredential

Nom Descriptif Valeur
Propriétés Description d’un GcmCredential NotificationHub. GcmCredentialProperties (obligatoire)

GcmCredentialProperties

Nom Descriptif Valeur
gcmPoint de terminaison Obtient ou définit le point de terminaison GCM. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
googleApiKey Obtient ou définit la clé API Google. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

IpRule

Nom Descriptif Valeur
Masque d’ipMask Masque IP. corde

Contraintes:
Longueur minimale = 1 (obligatoire)
droits Liste des droits d’accès. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send' (obligatoire)

MpnsCredential

Nom Descriptif Valeur
Propriétés Description d’un MpnsCredential NotificationHub. MpnsCredentialProperties (obligatoire)

MpnsCredentialProperties

Nom Descriptif Valeur
certificateKey Obtient ou définit la clé de certificat pour ces informations d’identification. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
mpnsCertificat Obtient ou définit le certificat MPNS. corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
Empreinte Obtient ou définit l’empreinte numérique du certificat MPNS corde

Contraintes:
Longueur minimale = 1
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

NamespaceProperties

Nom Descriptif Valeur
Centre de données Obsolescent. corde
espace de nomsType Définit des valeurs pour NamespaceType. 'Messagerie'
'NotificationHub'
networkAcls Collection de règles d’autorisation réseau. NetworkAcls
pnsRéférences Collection d’informations d’identification PNS de l’espace de noms Notification Hub ou Notification Hub. PnsRéférences
état de provisionnement Définit des valeurs pour OperationProvisioningState. 'Annulé'
'Désactivé'
'Échec'
'En cours'
'En attente'
'Réussi'
'Inconnu'
publicNetworkAccess Type d’accès au réseau public. 'Désactivé'
'Activé'
réplicationRégion Région de réplication autorisée 'AustralieEst '
'BrésilSouth'
Valeur par défaut
« Aucun »
« Europe du Nord »
'South AfricaNorth'
« Asie du Sud-Est »
'WestUs2'
scaleUnit Obtient ou définit scaleUnit où l’espace de noms est créé corde
statut État de l’espace de noms. 'Créé'
'Création'
'Suppression'
'Suspendu'
zoneRedondance Nom de la référence SKU de l’espace de noms. 'Désactivé'
'Activé'

NetworkAcls

Nom Descriptif Valeur
ipRules Liste des règles IP. IpRule []
publicNetworkRule Règle d’autorisation réseau (Internet public) par défaut, qui contient des droits si aucune autre règle réseau ne correspond. PublicInternetAuthorizationRule

PnsRéférences

Nom Descriptif Valeur
admCredential Description d’une notificationHub AdmCredential. AdmCredential
apnsInformations d’identification Description d’un ApnsCredential NotificationHub. ApnsCredential
baiduCredential Description d’une notificationHub BaiduCredential. BaiduCredential
browserCredential Description d’un BrowserCredential NotificationHub. BrowserCredential
gcmCredential Description d’un GcmCredential NotificationHub. GcmCredential
mpnsRéférence Description d’un MpnsCredential NotificationHub. MpnsCredential
wnsRéférence Description d’un notificationHub WnsCredential. WnsCredential
credential Description d’un NotificationHub SauvegardéCredential.

PublicInternetAuthorizationRule

Nom Descriptif Valeur
droits Liste des droits d’accès. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send' (obligatoire)

Sku

Nom Descriptif Valeur
capacité Obtient ou définit la capacité de la ressource Int
Famille Obtient ou définit la famille de références SKU corde
nom Nom de la référence SKU de l’espace de noms. 'De base'
« Gratuit »
'Standard' (obligatoire)
taille Obtient ou définit la taille de la référence SKU corde
niveau Obtient ou définit le niveau d’une référence SKU particulière corde

TrackedResourceTags

Nom Descriptif Valeur

WnsCredential

Nom Descriptif Valeur
Propriétés Description d’un notificationHub WnsCredential. WnsCredentialProperties (obligatoire)

WnsCredentialProperties

Nom Descriptif Valeur
certificateKey Ges ou définit la clé de certificat WNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
packageSid Obtient ou définit l’ID de package pour ces informations d’identification. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
secretKey Obtient ou définit la clé secrète. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
windowsLiveEndpoint Obtient ou définit le point de terminaison Windows Live. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
wnsCertificat Obtient ou définit le certificat WNS. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.

SauvegardéCredential

Nom Descriptif Valeur
Propriétés Description d’un Objet NotificationHub SauvegardéCredentialProperties. DemandéeCredentialProperties (obligatoire)

SauvegardéCredentialProperties

Nom Descriptif Valeur
appSecret Obtient ou définit la clé secrète de l’application. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.
extrémité Obtient ou définit le point de terminaison du service de configuration. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé.