Espaces de noms Microsoft.NotificationHubs/notificationHubs

Article
12/20/2024

Définition de ressource Bicep

Les espaces de noms/type de ressource notificationHubs peuvent être déployés avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de 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/notificationHubs, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    admCredential: {
      properties: {
        authTokenUrl: 'string'
        clientId: 'string'
        clientSecret: 'string'
      }
    }
    apnsCredential: {
      properties: {
        apnsCertificate: 'string'
        appId: 'string'
        appName: 'string'
        certificateKey: 'string'
        endpoint: 'string'
        keyId: 'string'
        thumbprint: 'string'
        token: 'string'
      }
    }
    baiduCredential: {
      properties: {
        baiduApiKey: 'string'
        baiduEndPoint: 'string'
        baiduSecretKey: 'string'
      }
    }
    browserCredential: {
      properties: {
        subject: 'string'
        vapidPrivateKey: 'string'
        vapidPublicKey: 'string'
      }
    }
    fcmV1Credential: {
      properties: {
        clientEmail: 'string'
        privateKey: 'string'
        projectId: 'string'
      }
    }
    gcmCredential: {
      properties: {
        gcmEndpoint: 'string'
        googleApiKey: 'string'
      }
    }
    mpnsCredential: {
      properties: {
        certificateKey: 'string'
        mpnsCertificate: 'string'
        thumbprint: 'string'
      }
    }
    name: 'string'
    registrationTtl: 'string'
    wnsCredential: {
      properties: {
        certificateKey: 'string'
        packageSid: 'string'
        secretKey: 'string'
        windowsLiveEndpoint: 'string'
        wnsCertificate: 'string'
      }
    }
    xiaomiCredential: {
      properties: {
        appSecret: 'string'
        endpoint: 'string'
      }
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

AdmCredential

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

AdmCredentialProperties

Nom	Description	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	Description	Valeur
Propriétés	Description d’un ApnsCredential NotificationHub.	ApnsCredentialProperties (obligatoire)

ApnsCredentialProperties

Nom	Description	Valeur
apnsCertificate	Obtient ou définit le certificat APNS.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
appId	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é.
appName	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	Description	Valeur
Propriétés	Description d’une notificationHub BaiduCredential.	BaiduCredentialProperties (obligatoire)

BaiduCredentialProperties

Nom	Description	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	Description	Valeur
Propriétés	Description d’un BrowserCredential NotificationHub.	BrowserCredentialProperties (obligatoire)

BrowserCredentialProperties

Nom	Description	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)

FcmV1Credential

Nom	Description	Valeur
Propriétés	Description d’une notificationHub FcmV1Credential.	FcmV1CredentialProperties (obligatoire)

FcmV1CredentialProperties

Nom	Description	Valeur
clientEmail	Obtient ou définit l’e-mail du client.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
privateKey	Obtient ou définit une clé privée.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
projectId	Obtient ou définit l’ID de projet.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

GcmCredential

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

GcmCredentialProperties

Nom	Description	Valeur
gcmEndpoint	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)

Microsoft.NotificationHubs/namespaces/notificationHubs

Nom	Description	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 = 1 Modèle = `^[a-zA-Z][a-zA-Z0-9-./_]*$` (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : espaces de noms
Propriétés	Propriétés notificationHub.	NotificationHubProperties
Sku	Description de la référence SKU pour un espace de noms	référence SKU
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

MpnsCredential

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

MpnsCredentialProperties

Nom	Description	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)
mpnsCertificate	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)

NotificationHubProperties

Nom	Description	Valeur
admCredential	Description d’une notificationHub AdmCredential.	AdmCredential
apnsCredential	Description d’un ApnsCredential NotificationHub.	ApnsCredential
baiduCredential	Description d’une notificationHub BaiduCredential.	BaiduCredential
browserCredential	Description d’un BrowserCredential NotificationHub.	BrowserCredential
fcmV1Credential	Description d’une notificationHub FcmV1Credential.	FcmV1Credential
gcmCredential	Description d’un GcmCredential NotificationHub.	GcmCredential
mpnsCredential	Description d’un MpnsCredential NotificationHub.	MpnsCredential
nom	Obtient ou définit le nom de NotificationHub.	corde
registrationTtl	Obtient ou définit l’EnregistrementTtl du NotificationHub créé	corde
wnsCredential	Description d’un notificationHub WnsCredential.	WnsCredential
credential	Description d’un NotificationHub SauvegardéCredential.

Sku

Nom	Description	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' 'Free' '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	Description	Valeur

WnsCredential

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

WnsCredentialProperties

Nom	Description	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é.
wnsCertificate	Obtient ou définit le certificat WNS.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

SauvegardéCredential

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

SauvegardéCredentialProperties

Nom	Description	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 de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
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

Les espaces de noms/type de ressource notificationHubs peuvent être déployés avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de 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/notificationHubs, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "admCredential": {
      "properties": {
        "authTokenUrl": "string",
        "clientId": "string",
        "clientSecret": "string"
      }
    },
    "apnsCredential": {
      "properties": {
        "apnsCertificate": "string",
        "appId": "string",
        "appName": "string",
        "certificateKey": "string",
        "endpoint": "string",
        "keyId": "string",
        "thumbprint": "string",
        "token": "string"
      }
    },
    "baiduCredential": {
      "properties": {
        "baiduApiKey": "string",
        "baiduEndPoint": "string",
        "baiduSecretKey": "string"
      }
    },
    "browserCredential": {
      "properties": {
        "subject": "string",
        "vapidPrivateKey": "string",
        "vapidPublicKey": "string"
      }
    },
    "fcmV1Credential": {
      "properties": {
        "clientEmail": "string",
        "privateKey": "string",
        "projectId": "string"
      }
    },
    "gcmCredential": {
      "properties": {
        "gcmEndpoint": "string",
        "googleApiKey": "string"
      }
    },
    "mpnsCredential": {
      "properties": {
        "certificateKey": "string",
        "mpnsCertificate": "string",
        "thumbprint": "string"
      }
    },
    "name": "string",
    "registrationTtl": "string",
    "wnsCredential": {
      "properties": {
        "certificateKey": "string",
        "packageSid": "string",
        "secretKey": "string",
        "windowsLiveEndpoint": "string",
        "wnsCertificate": "string"
      }
    },
    "xiaomiCredential": {
      "properties": {
        "appSecret": "string",
        "endpoint": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AdmCredential

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

AdmCredentialProperties

Nom	Description	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	Description	Valeur
Propriétés	Description d’un ApnsCredential NotificationHub.	ApnsCredentialProperties (obligatoire)

ApnsCredentialProperties

Nom	Description	Valeur
apnsCertificate	Obtient ou définit le certificat APNS.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
appId	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é.
appName	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	Description	Valeur
Propriétés	Description d’une notificationHub BaiduCredential.	BaiduCredentialProperties (obligatoire)

BaiduCredentialProperties

Nom	Description	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	Description	Valeur
Propriétés	Description d’un BrowserCredential NotificationHub.	BrowserCredentialProperties (obligatoire)

BrowserCredentialProperties

Nom	Description	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)

FcmV1Credential

Nom	Description	Valeur
Propriétés	Description d’une notificationHub FcmV1Credential.	FcmV1CredentialProperties (obligatoire)

FcmV1CredentialProperties

Nom	Description	Valeur
clientEmail	Obtient ou définit l’e-mail du client.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
privateKey	Obtient ou définit une clé privée.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
projectId	Obtient ou définit l’ID de projet.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

GcmCredential

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

GcmCredentialProperties

Nom	Description	Valeur
gcmEndpoint	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)

Microsoft.NotificationHubs/namespaces/notificationHubs

Nom	Description	Valeur
apiVersion	Version de l’API	'2023-10-01-preview'
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = `^[a-zA-Z][a-zA-Z0-9-./_]*$` (obligatoire)
Propriétés	Propriétés notificationHub.	NotificationHubProperties
Sku	Description de la référence SKU pour un espace de noms	référence SKU
é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/namespaces/notificationHubs'

MpnsCredential

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

MpnsCredentialProperties

Nom	Description	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)
mpnsCertificate	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)

NotificationHubProperties

Nom	Description	Valeur
admCredential	Description d’une notificationHub AdmCredential.	AdmCredential
apnsCredential	Description d’un ApnsCredential NotificationHub.	ApnsCredential
baiduCredential	Description d’une notificationHub BaiduCredential.	BaiduCredential
browserCredential	Description d’un BrowserCredential NotificationHub.	BrowserCredential
fcmV1Credential	Description d’une notificationHub FcmV1Credential.	FcmV1Credential
gcmCredential	Description d’un GcmCredential NotificationHub.	GcmCredential
mpnsCredential	Description d’un MpnsCredential NotificationHub.	MpnsCredential
nom	Obtient ou définit le nom de NotificationHub.	corde
registrationTtl	Obtient ou définit l’EnregistrementTtl du NotificationHub créé	corde
wnsCredential	Description d’un notificationHub WnsCredential.	WnsCredential
credential	Description d’un NotificationHub SauvegardéCredential.

Sku

Nom	Description	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' 'Free' '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	Description	Valeur

WnsCredential

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

WnsCredentialProperties

Nom	Description	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é.
wnsCertificate	Obtient ou définit le certificat WNS.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

SauvegardéCredential

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

SauvegardéCredentialProperties

Nom	Description	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é.

Modèles de démarrage rapide

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

Modèle	Description
créer un Azure Notification Hub	Crée un hub de notification Azure, modèle créé à l’origine par John Downs.
provisionner une application mobile avec un SQL Database	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)

Les espaces de noms/type de ressource notificationHubs peuvent être déployés 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/notificationHubs, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      admCredential = {
        properties = {
          authTokenUrl = "string"
          clientId = "string"
          clientSecret = "string"
        }
      }
      apnsCredential = {
        properties = {
          apnsCertificate = "string"
          appId = "string"
          appName = "string"
          certificateKey = "string"
          endpoint = "string"
          keyId = "string"
          thumbprint = "string"
          token = "string"
        }
      }
      baiduCredential = {
        properties = {
          baiduApiKey = "string"
          baiduEndPoint = "string"
          baiduSecretKey = "string"
        }
      }
      browserCredential = {
        properties = {
          subject = "string"
          vapidPrivateKey = "string"
          vapidPublicKey = "string"
        }
      }
      fcmV1Credential = {
        properties = {
          clientEmail = "string"
          privateKey = "string"
          projectId = "string"
        }
      }
      gcmCredential = {
        properties = {
          gcmEndpoint = "string"
          googleApiKey = "string"
        }
      }
      mpnsCredential = {
        properties = {
          certificateKey = "string"
          mpnsCertificate = "string"
          thumbprint = "string"
        }
      }
      name = "string"
      registrationTtl = "string"
      wnsCredential = {
        properties = {
          certificateKey = "string"
          packageSid = "string"
          secretKey = "string"
          windowsLiveEndpoint = "string"
          wnsCertificate = "string"
        }
      }
      xiaomiCredential = {
        properties = {
          appSecret = "string"
          endpoint = "string"
        }
      }
    }
  })
}

Valeurs de propriété

AdmCredential

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

AdmCredentialProperties

Nom	Description	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	Description	Valeur
Propriétés	Description d’un ApnsCredential NotificationHub.	ApnsCredentialProperties (obligatoire)

ApnsCredentialProperties

Nom	Description	Valeur
apnsCertificate	Obtient ou définit le certificat APNS.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
appId	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é.
appName	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	Description	Valeur
Propriétés	Description d’une notificationHub BaiduCredential.	BaiduCredentialProperties (obligatoire)

BaiduCredentialProperties

Nom	Description	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	Description	Valeur
Propriétés	Description d’un BrowserCredential NotificationHub.	BrowserCredentialProperties (obligatoire)

BrowserCredentialProperties

Nom	Description	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)

FcmV1Credential

Nom	Description	Valeur
Propriétés	Description d’une notificationHub FcmV1Credential.	FcmV1CredentialProperties (obligatoire)

FcmV1CredentialProperties

Nom	Description	Valeur
clientEmail	Obtient ou définit l’e-mail du client.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
privateKey	Obtient ou définit une clé privée.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
projectId	Obtient ou définit l’ID de projet.	corde Contraintes: Longueur minimale = 1 Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

GcmCredential

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

GcmCredentialProperties

Nom	Description	Valeur
gcmEndpoint	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)

Microsoft.NotificationHubs/namespaces/notificationHubs

Nom	Description	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 = 1 Modèle = `^[a-zA-Z][a-zA-Z0-9-./_]*$` (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : espaces de noms
Propriétés	Propriétés notificationHub.	NotificationHubProperties
Sku	Description de la référence SKU pour un espace de noms	référence SKU
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.NotificationHubs/namespaces/notificationHubs@2023-10-01-preview »

MpnsCredential

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

MpnsCredentialProperties

Nom	Description	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)
mpnsCertificate	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)

NotificationHubProperties

Nom	Description	Valeur
admCredential	Description d’une notificationHub AdmCredential.	AdmCredential
apnsCredential	Description d’un ApnsCredential NotificationHub.	ApnsCredential
baiduCredential	Description d’une notificationHub BaiduCredential.	BaiduCredential
browserCredential	Description d’un BrowserCredential NotificationHub.	BrowserCredential
fcmV1Credential	Description d’une notificationHub FcmV1Credential.	FcmV1Credential
gcmCredential	Description d’un GcmCredential NotificationHub.	GcmCredential
mpnsCredential	Description d’un MpnsCredential NotificationHub.	MpnsCredential
nom	Obtient ou définit le nom de NotificationHub.	corde
registrationTtl	Obtient ou définit l’EnregistrementTtl du NotificationHub créé	corde
wnsCredential	Description d’un notificationHub WnsCredential.	WnsCredential
credential	Description d’un NotificationHub SauvegardéCredential.

Sku

Nom	Description	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' 'Free' '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	Description	Valeur

WnsCredential

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

WnsCredentialProperties

Nom	Description	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é.
wnsCertificate	Obtient ou définit le certificat WNS.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.

SauvegardéCredential

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

SauvegardéCredentialProperties

Nom	Description	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é.

Partager via

Espaces de noms Microsoft.NotificationHubs/notificationHubs

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

BaiduCredential

BaiduCredentialProperties

BrowserCredential

BrowserCredentialProperties

FcmV1Credential

FcmV1CredentialProperties

GcmCredential

GcmCredentialProperties

Microsoft.NotificationHubs/namespaces/notificationHubs

MpnsCredential

MpnsCredentialProperties

NotificationHubProperties

Sku

TrackedResourceTags

WnsCredential

WnsCredentialProperties

SauvegardéCredential

SauvegardéCredentialProperties

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

BaiduCredential

BaiduCredentialProperties

BrowserCredential

BrowserCredentialProperties

FcmV1Credential

FcmV1CredentialProperties

GcmCredential

GcmCredentialProperties

Microsoft.NotificationHubs/namespaces/notificationHubs

MpnsCredential

MpnsCredentialProperties

NotificationHubProperties

Sku

TrackedResourceTags

WnsCredential

WnsCredentialProperties

SauvegardéCredential

SauvegardéCredentialProperties

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

BaiduCredential

BaiduCredentialProperties

BrowserCredential

BrowserCredentialProperties

FcmV1Credential

FcmV1CredentialProperties

GcmCredential

GcmCredentialProperties

Microsoft.NotificationHubs/namespaces/notificationHubs

MpnsCredential

MpnsCredentialProperties

NotificationHubProperties

Sku

TrackedResourceTags

WnsCredential

WnsCredentialProperties

SauvegardéCredential

SauvegardéCredentialProperties

Commentaires