Partager via

Espaces de noms Microsoft.NotificationHubs/notificationHubs 2017-04-01

  • Article

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    admCredential: {
      properties: {
        authTokenUrl: 'string'
        clientId: 'string'
        clientSecret: 'string'
      }
    }
    apnsCredential: {
      properties: {
        apnsCertificate: 'string'
        appId: 'string'
        appName: 'string'
        certificateKey: 'string'
        endpoint: 'string'
        keyId: 'string'
        thumbprint: 'string'
        token: 'string'
      }
    }
    authorizationRules: [
      {
        rights: [
          'string'
        ]
      }
    ]
    baiduCredential: {
      properties: {
        baiduApiKey: 'string'
        baiduEndPoint: 'string'
        baiduSecretKey: 'string'
      }
    }
    gcmCredential: {
      properties: {
        gcmEndpoint: 'string'
        googleApiKey: 'string'
      }
    }
    mpnsCredential: {
      properties: {
        certificateKey: 'string'
        mpnsCertificate: 'string'
        thumbprint: 'string'
      }
    }
    name: 'string'
    registrationTtl: 'string'
    wnsCredential: {
      properties: {
        packageSid: 'string'
        secretKey: 'string'
        windowsLiveEndpoint: 'string'
      }
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

AdmCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

Nom Description Valeur
authTokenUrl URL du jeton d’autorisation. corde
clientId Identificateur du client. corde
clientSecret Clé d’accès au secret d’informations d’identification. corde

ApnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Nom Description Valeur
apnsCertificate Certificat APNS. Spécifiez si vous utilisez le mode d’authentification par certificat. corde
appId Clé de revendication inscrite de l’émetteur (iss). La valeur est un TeamId de 10 caractères, obtenu à partir de votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
appName Nom de l’application ou bundleId. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
certificateKey Mot de passe du certificat APNS s’il existe. corde
extrémité Point de terminaison APNS de ces informations d’identification. Si vous utilisez le mode d’authentification par certificat et le bac à sable , spécifiez « gateway.sandbox.push.apple.com ». Si vous utilisez le mode d’authentification par certificat et la production, spécifiez « gateway.push.apple.com ». Si vous utilisez le mode d’authentification par jeton et le bac à sable , spécifiez «https://api.development.push.apple.com:443/3/device». Si vous utilisez le mode d’authentification par jeton et la production, spécifiez «https://api.push.apple.com:443/3/device». corde
keyId Une clé d’identificateur de clé de 10 caractères (enfant), obtenue à partir de votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
Empreinte Empreinte numérique du certificat APNS. Spécifiez si vous utilisez le mode d’authentification par certificat. corde
jeton Jeton d’authentification du fournisseur, obtenu via votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde

BaiduCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

Nom Description Valeur
baiduApiKey Clé api Baidu. corde
baiduEndPoint Point de terminaison Baidu. corde
baiduSecretKey Clé secrète Baidu corde

GcmCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Nom Description Valeur
gcmEndpoint Point de terminaison hérité FCM. La valeur par défaut est 'https://fcm.googleapis.com/fcm/send' corde
googleApiKey Clé API Google. corde

Microsoft.NotificationHubs/namespaces/notificationHubs

Nom Description Valeur
emplacement Emplacement des ressources corde
nom Nom de la ressource chaîne (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 de NotificationHub. NotificationHubProperties (obligatoire)
Sku Référence SKU de l’espace de noms créé 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 Propriétés de NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Nom Description Valeur
certificateKey Clé de certificat pour ces informations d’identification. corde
mpnsCertificate Certificat MPNS. corde
Empreinte Empreinte numérique du certificat MPNS corde

NotificationHubProperties

Nom Description Valeur
admCredential AdmCredential du notificationHub créé AdmCredential
apnsCredential ApnsCredential du notificationHub créé ApnsCredential
authorizationRules AuthorizationRules du NotificationHub créé SharedAccessAuthorizationRuleProperties[]
baiduCredential BaiduCredential du notificationHub créé BaiduCredential
gcmCredential GcmCredential du NotificationHub créé GcmCredential
mpnsCredential MpnsCredential de notificationHub créé MpnsCredential
nom Nom de NotificationHub. corde
registrationTtl RegistrationTtl du NotificationHub créé corde
wnsCredential WnsCredential du notificationHub créé WnsCredential

ResourceTags

Nom Description Valeur

SharedAccessAuthorizationRuleProperties

Nom Description Valeur
droits Droits associés à la règle. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send'

Sku

Nom Description Valeur
capacité Capacité de la ressource Int
Famille La famille de références SKU corde
nom Nom de la référence SKU du hub de notification 'De base'
'Free'
'Standard' (obligatoire)
taille Taille de la référence SKU corde
niveau Niveau de référence sku particulier corde

WnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Nom Description Valeur
packageSid ID de package pour ces informations d’identification. corde
secretKey Clé secrète. corde
windowsLiveEndpoint Point de terminaison Windows Live. corde

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 :

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": "2017-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "admCredential": {
      "properties": {
        "authTokenUrl": "string",
        "clientId": "string",
        "clientSecret": "string"
      }
    },
    "apnsCredential": {
      "properties": {
        "apnsCertificate": "string",
        "appId": "string",
        "appName": "string",
        "certificateKey": "string",
        "endpoint": "string",
        "keyId": "string",
        "thumbprint": "string",
        "token": "string"
      }
    },
    "authorizationRules": [
      {
        "rights": [ "string" ]
      }
    ],
    "baiduCredential": {
      "properties": {
        "baiduApiKey": "string",
        "baiduEndPoint": "string",
        "baiduSecretKey": "string"
      }
    },
    "gcmCredential": {
      "properties": {
        "gcmEndpoint": "string",
        "googleApiKey": "string"
      }
    },
    "mpnsCredential": {
      "properties": {
        "certificateKey": "string",
        "mpnsCertificate": "string",
        "thumbprint": "string"
      }
    },
    "name": "string",
    "registrationTtl": "string",
    "wnsCredential": {
      "properties": {
        "packageSid": "string",
        "secretKey": "string",
        "windowsLiveEndpoint": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

AdmCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

Nom Description Valeur
authTokenUrl URL du jeton d’autorisation. corde
clientId Identificateur du client. corde
clientSecret Clé d’accès au secret d’informations d’identification. corde

ApnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Nom Description Valeur
apnsCertificate Certificat APNS. Spécifiez si vous utilisez le mode d’authentification par certificat. corde
appId Clé de revendication inscrite de l’émetteur (iss). La valeur est un TeamId de 10 caractères, obtenu à partir de votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
appName Nom de l’application ou bundleId. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
certificateKey Mot de passe du certificat APNS s’il existe. corde
extrémité Point de terminaison APNS de ces informations d’identification. Si vous utilisez le mode d’authentification par certificat et le bac à sable , spécifiez « gateway.sandbox.push.apple.com ». Si vous utilisez le mode d’authentification par certificat et la production, spécifiez « gateway.push.apple.com ». Si vous utilisez le mode d’authentification par jeton et le bac à sable , spécifiez «https://api.development.push.apple.com:443/3/device». Si vous utilisez le mode d’authentification par jeton et la production, spécifiez «https://api.push.apple.com:443/3/device». corde
keyId Une clé d’identificateur de clé de 10 caractères (enfant), obtenue à partir de votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
Empreinte Empreinte numérique du certificat APNS. Spécifiez si vous utilisez le mode d’authentification par certificat. corde
jeton Jeton d’authentification du fournisseur, obtenu via votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde

BaiduCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

Nom Description Valeur
baiduApiKey Clé api Baidu. corde
baiduEndPoint Point de terminaison Baidu. corde
baiduSecretKey Clé secrète Baidu corde

GcmCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Nom Description Valeur
gcmEndpoint Point de terminaison hérité FCM. La valeur par défaut est 'https://fcm.googleapis.com/fcm/send' corde
googleApiKey Clé API Google. corde

Microsoft.NotificationHubs/namespaces/notificationHubs

Nom Description Valeur
apiVersion Version de l’API '2017-04-01'
emplacement Emplacement des ressources corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de NotificationHub. NotificationHubProperties (obligatoire)
Sku Référence SKU de l’espace de noms créé 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 Propriétés de NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Nom Description Valeur
certificateKey Clé de certificat pour ces informations d’identification. corde
mpnsCertificate Certificat MPNS. corde
Empreinte Empreinte numérique du certificat MPNS corde

NotificationHubProperties

Nom Description Valeur
admCredential AdmCredential du notificationHub créé AdmCredential
apnsCredential ApnsCredential du notificationHub créé ApnsCredential
authorizationRules AuthorizationRules du NotificationHub créé SharedAccessAuthorizationRuleProperties[]
baiduCredential BaiduCredential du notificationHub créé BaiduCredential
gcmCredential GcmCredential du NotificationHub créé GcmCredential
mpnsCredential MpnsCredential de notificationHub créé MpnsCredential
nom Nom de NotificationHub. corde
registrationTtl RegistrationTtl du NotificationHub créé corde
wnsCredential WnsCredential du notificationHub créé WnsCredential

ResourceTags

Nom Description Valeur

SharedAccessAuthorizationRuleProperties

Nom Description Valeur
droits Droits associés à la règle. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send'

Sku

Nom Description Valeur
capacité Capacité de la ressource Int
Famille La famille de références SKU corde
nom Nom de la référence SKU du hub de notification 'De base'
'Free'
'Standard' (obligatoire)
taille Taille de la référence SKU corde
niveau Niveau de référence sku particulier corde

WnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Nom Description Valeur
packageSid ID de package pour ces informations d’identification. corde
secretKey Clé secrète. corde
windowsLiveEndpoint Point de terminaison Windows Live. corde

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

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)

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@2017-04-01"
  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"
        }
      }
      authorizationRules = [
        {
          rights = [
            "string"
          ]
        }
      ]
      baiduCredential = {
        properties = {
          baiduApiKey = "string"
          baiduEndPoint = "string"
          baiduSecretKey = "string"
        }
      }
      gcmCredential = {
        properties = {
          gcmEndpoint = "string"
          googleApiKey = "string"
        }
      }
      mpnsCredential = {
        properties = {
          certificateKey = "string"
          mpnsCertificate = "string"
          thumbprint = "string"
        }
      }
      name = "string"
      registrationTtl = "string"
      wnsCredential = {
        properties = {
          packageSid = "string"
          secretKey = "string"
          windowsLiveEndpoint = "string"
        }
      }
    }
  })
}

Valeurs de propriété

AdmCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub AdmCredential. AdmCredentialProperties

AdmCredentialProperties

Nom Description Valeur
authTokenUrl URL du jeton d’autorisation. corde
clientId Identificateur du client. corde
clientSecret Clé d’accès au secret d’informations d’identification. corde

ApnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub ApnsCredential. ApnsCredentialProperties

ApnsCredentialProperties

Nom Description Valeur
apnsCertificate Certificat APNS. Spécifiez si vous utilisez le mode d’authentification par certificat. corde
appId Clé de revendication inscrite de l’émetteur (iss). La valeur est un TeamId de 10 caractères, obtenu à partir de votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
appName Nom de l’application ou bundleId. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
certificateKey Mot de passe du certificat APNS s’il existe. corde
extrémité Point de terminaison APNS de ces informations d’identification. Si vous utilisez le mode d’authentification par certificat et le bac à sable , spécifiez « gateway.sandbox.push.apple.com ». Si vous utilisez le mode d’authentification par certificat et la production, spécifiez « gateway.push.apple.com ». Si vous utilisez le mode d’authentification par jeton et le bac à sable , spécifiez «https://api.development.push.apple.com:443/3/device». Si vous utilisez le mode d’authentification par jeton et la production, spécifiez «https://api.push.apple.com:443/3/device». corde
keyId Une clé d’identificateur de clé de 10 caractères (enfant), obtenue à partir de votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde
Empreinte Empreinte numérique du certificat APNS. Spécifiez si vous utilisez le mode d’authentification par certificat. corde
jeton Jeton d’authentification du fournisseur, obtenu via votre compte de développeur. Spécifiez si vous utilisez le mode d’authentification par jeton. corde

BaiduCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub BaiduCredential. BaiduCredentialProperties

BaiduCredentialProperties

Nom Description Valeur
baiduApiKey Clé api Baidu. corde
baiduEndPoint Point de terminaison Baidu. corde
baiduSecretKey Clé secrète Baidu corde

GcmCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub GcmCredential. GcmCredentialProperties

GcmCredentialProperties

Nom Description Valeur
gcmEndpoint Point de terminaison hérité FCM. La valeur par défaut est 'https://fcm.googleapis.com/fcm/send' corde
googleApiKey Clé API Google. corde

Microsoft.NotificationHubs/namespaces/notificationHubs

Nom Description Valeur
emplacement Emplacement des ressources corde
nom Nom de la ressource chaîne (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 de NotificationHub. NotificationHubProperties (obligatoire)
Sku Référence SKU de l’espace de noms créé référence SKU
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01 »

MpnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub MpnsCredential. MpnsCredentialProperties

MpnsCredentialProperties

Nom Description Valeur
certificateKey Clé de certificat pour ces informations d’identification. corde
mpnsCertificate Certificat MPNS. corde
Empreinte Empreinte numérique du certificat MPNS corde

NotificationHubProperties

Nom Description Valeur
admCredential AdmCredential du notificationHub créé AdmCredential
apnsCredential ApnsCredential du notificationHub créé ApnsCredential
authorizationRules AuthorizationRules du NotificationHub créé SharedAccessAuthorizationRuleProperties[]
baiduCredential BaiduCredential du notificationHub créé BaiduCredential
gcmCredential GcmCredential du NotificationHub créé GcmCredential
mpnsCredential MpnsCredential de notificationHub créé MpnsCredential
nom Nom de NotificationHub. corde
registrationTtl RegistrationTtl du NotificationHub créé corde
wnsCredential WnsCredential du notificationHub créé WnsCredential

ResourceTags

Nom Description Valeur

SharedAccessAuthorizationRuleProperties

Nom Description Valeur
droits Droits associés à la règle. Tableau de chaînes contenant l’un des éléments suivants :
'Écouter'
'Gérer'
'Send'

Sku

Nom Description Valeur
capacité Capacité de la ressource Int
Famille La famille de références SKU corde
nom Nom de la référence SKU du hub de notification 'De base'
'Free'
'Standard' (obligatoire)
taille Taille de la référence SKU corde
niveau Niveau de référence sku particulier corde

WnsCredential

Nom Description Valeur
Propriétés Propriétés de NotificationHub WnsCredential. WnsCredentialProperties

WnsCredentialProperties

Nom Description Valeur
packageSid ID de package pour ces informations d’identification. corde
secretKey Clé secrète. corde
windowsLiveEndpoint Point de terminaison Windows Live. corde