Freigeben über


Microsoft.NotificationHubs-Namespaces

Bicep-Ressourcendefinition

Der Namespaces-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.NotificationHubs/Namespaces-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
  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'
        }
      }
      fcmV1Credential: {
        properties: {
          clientEmail: 'string'
          privateKey: 'string'
          projectId: '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'
  }
}

Eigenschaftswerte

AdmCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub AdmCredential. AdmCredentialProperties- (erforderlich)

AdmCredentialProperties

Name Beschreibung Wert
authTokenUrl Ruft die URL des Autorisierungstokens ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
clientId Dient zum Abrufen oder Festlegen des Clientbezeichners. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
clientSecret Dient zum Abrufen oder Festlegen des geheimen Zugriffsschlüssels für Anmeldeinformationen. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

ApnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub-ApnsCredential. ApnsCredentialProperties (erforderlich)

ApnsCredentialProperties

Name Beschreibung Wert
apnsCertificate Ruft das APNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
appId Ruft den registrierten Anspruchsschlüssel des Ausstellers (iss) ab, dessen Wert
Ihre 10-stellige Team-ID aus Ihrem Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
appName Dient zum Abrufen oder Festlegen des Namens der Anwendung. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
certificateKey Dient zum Abrufen oder Festlegen des Zertifikatschlüssels. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Endpunkt Ruft den Endpunkt dieser Anmeldeinformationen ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
keyId Dient zum Abrufen oder Festlegen eines 10-stelligen Schlüsselbezeichners (Kid)-Schlüssels, der von
Ihr Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Fingerabdruck Ruft den APNS-Zertifikatfingerabdruck ab oder legt diesen fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Zeichen Ruft das anbieterauthentifizierungstoken ab oder legt es fest, das über Ihre
Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

BaiduCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub BaiduCredential. BaiduCredentialProperties (erforderlich)

BaiduCredentialProperties

Name Beschreibung Wert
baiduApiKey Dient zum Abrufen oder Festlegen des baidu-API-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
baiduEndPoint Ruft baidu Endpoint ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
baiduSecretKey Ruft den baidu Secret Key ab oder legt den geheimen Schlüssel fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

BrowserAnmeldeinformationen

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub-Browseranmeldeinformationen. BrowserCredentialProperties (erforderlich)

BrowserCredentialProperties

Name Beschreibung Wert
Betreff Ruft den Web-Push-Betreff ab oder legt ihn fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
vapidPrivateKey Dient zum Abrufen oder Festlegen des privaten VAPID-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
vapidPublicKey Dient zum Abrufen oder Festlegen des öffentlichen VAPID-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

FcmV1Credential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub FcmV1Credential. FcmV1CredentialProperties (erforderlich)

FcmV1CredentialProperties

Name Beschreibung Wert
clientEmail Dient zum Abrufen oder Festlegen der Client-E-Mail. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
privateKey Dient zum Abrufen oder Festlegen eines privaten Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
projectId Ruft die Projekt-ID ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

GcmCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub GcmCredential. GcmCredentialProperties (erforderlich)

GcmCredentialProperties

Name Beschreibung Wert
gcmEndpoint Dient zum Abrufen oder Festlegen des GCM-Endpunkts. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
googleApiKey Ruft den Google-API-Schlüssel ab oder legt den Schlüssel fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

IpRule

Name Beschreibung Wert
ipMask IP-Maske. Schnur

Zwänge:
Min. Länge = 1 (erforderlich)
Rechte Liste der Zugriffsrechte. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Lauschen"
"Verwalten"
"Senden" (erforderlich)

Microsoft.NotificationHubs/Namespaces

Name Beschreibung Wert
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[a-zA-Z][a-zA-Z0-9-]*$ (erforderlich)
Eigenschaften Stellt Namespaceeigenschaften dar. NamespaceProperties-
Sku Die Sku-Beschreibung für einen Namespace Sku- (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

MpnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub MpnsCredential. MpnsCredentialProperties (erforderlich)

MpnsCredentialProperties

Name Beschreibung Wert
certificateKey Ruft den Zertifikatschlüssel für diese Anmeldeinformationen ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
mpnsCertificate Ruft das MPNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
Fingerabdruck Ruft den MPNS-Zertifikatfingerabdruck ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

NamespaceProperties

Name Beschreibung Wert
DataCenter Veraltet. Schnur
namespaceType Definiert Werte für NamespaceType. "Messaging"
'NotificationHub'
networkAcls Eine Sammlung von Netzwerkautorisierungsregeln. NetworkAcls-
pnsCredentials Sammlung der PNS-Anmeldeinformationen des Benachrichtigungshub- oder Benachrichtigungshub-Namespaces. PnsCredentials-
provisioningState Definiert Werte für OperationProvisioningState. 'Abgebrochen'
"Deaktiviert"
'Fehler'
"InProgress"
"Ausstehend"
"Erfolgreich"
"Unbekannt"
publicNetworkAccess Typ des öffentlichen Netzwerkzugriffs. "Deaktiviert"
"Aktiviert"
replicationRegion Zulässige Replikationsregion "AustralienEast"
"BrazilSouth"
'Standard'
'None'
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
'WestUs2'
scaleUnit Ruft scaleUnit ab, wo der Namespace erstellt wird, oder legt diese fest. Schnur
Status Namespacestatus. "Erstellt"
"Erstellen"
"Löschen"
"Angehalten"
zoneRedundancy Namespace-SKU-Name. "Deaktiviert"
"Aktiviert"

NetworkAcls

Name Beschreibung Wert
ipRules Liste der IP-Regeln. IpRule-[]
publicNetworkRule Eine Standardmäßige (öffentliche Internet)-Netzwerkautorisierungsregel, die Rechte enthält, wenn keine andere Netzwerkregel übereinstimmt. PublicInternetAuthorizationRule-

PnsCredentials

Name Beschreibung Wert
admCredential Beschreibung einer NotificationHub AdmCredential. AdmCredential-
apnsCredential Beschreibung einer NotificationHub-ApnsCredential. ApnsCredential-
baiduCredential Beschreibung eines NotificationHub BaiduCredential. BaiduCredential-
browserCredential Beschreibung einer NotificationHub-Browseranmeldeinformationen. BrowserCredential-
fcmV1Credential Beschreibung eines NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beschreibung einer NotificationHub GcmCredential. GcmCredential-
mpnsCredential Beschreibung einer NotificationHub MpnsCredential. MpnsCredential-
wnsCredential Beschreibung eines NotificationHub WnsCredential. WnsCredential-
xiaomiCredential Beschreibung eines NotificationHub XiaomiCredential. XiaomiCredential

PublicInternetAuthorizationRule

Name Beschreibung Wert
Rechte Liste der Zugriffsrechte. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Lauschen"
"Verwalten"
"Senden" (erforderlich)

Sku

Name Beschreibung Wert
Fassungsvermögen Ruft die Kapazität der Ressource ab oder legt sie fest. Int
Familie Ruft die Sku-Familie ab oder legt sie fest Schnur
Name Namespace-SKU-Name. "Einfach"
"Kostenlos"
"Standard" (erforderlich)
Größe Ruft die Größe der Sku ab oder legt sie fest. Schnur
Rang Ruft die Ebene einer bestimmten SKU ab oder legt sie fest. Schnur

TrackedResourceTags

Name Beschreibung Wert

WnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub WnsCredential. WnsCredentialProperties- (erforderlich)

WnsCredentialProperties

Name Beschreibung Wert
certificateKey Ges oder legt den WNS-Zertifikatschlüssel fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
packageSid Ruft die Paket-ID für diese Anmeldeinformationen ab oder legt sie fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
secretKey Dient zum Abrufen oder Festlegen des geheimen Schlüssels. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
windowsLiveEndpoint Ruft den Windows Live-Endpunkt ab oder legt den Endpunkt fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
wnsCertificate Ruft das WNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

XiaomiCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (erforderlich)

XiaomiCredentialProperties

Name Beschreibung Wert
appSecret Ruft den geheimen App-Schlüssel ab oder legt den geheimen App-Schlüssel fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Endpunkt Ruft den Xiaomi-Dienstendpunkt ab oder legt den Endpunkt fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei Beschreibung
Erstellen von Azure Notification Hub- Erstellt einen Azure Notification Hub, die ursprünglich von John Downs verfasste Vorlage.

ARM-Vorlagenressourcendefinition

Der Namespaces-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.NotificationHubs/Namespaces-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.NotificationHubs/namespaces",
  "apiVersion": "2023-10-01-preview",
  "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"
        }
      },
      "fcmV1Credential": {
        "properties": {
          "clientEmail": "string",
          "privateKey": "string",
          "projectId": "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"
  }
}

Eigenschaftswerte

AdmCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub AdmCredential. AdmCredentialProperties- (erforderlich)

AdmCredentialProperties

Name Beschreibung Wert
authTokenUrl Ruft die URL des Autorisierungstokens ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
clientId Dient zum Abrufen oder Festlegen des Clientbezeichners. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
clientSecret Dient zum Abrufen oder Festlegen des geheimen Zugriffsschlüssels für Anmeldeinformationen. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

ApnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub-ApnsCredential. ApnsCredentialProperties (erforderlich)

ApnsCredentialProperties

Name Beschreibung Wert
apnsCertificate Ruft das APNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
appId Ruft den registrierten Anspruchsschlüssel des Ausstellers (iss) ab, dessen Wert
Ihre 10-stellige Team-ID aus Ihrem Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
appName Dient zum Abrufen oder Festlegen des Namens der Anwendung. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
certificateKey Dient zum Abrufen oder Festlegen des Zertifikatschlüssels. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Endpunkt Ruft den Endpunkt dieser Anmeldeinformationen ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
keyId Dient zum Abrufen oder Festlegen eines 10-stelligen Schlüsselbezeichners (Kid)-Schlüssels, der von
Ihr Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Fingerabdruck Ruft den APNS-Zertifikatfingerabdruck ab oder legt diesen fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Zeichen Ruft das anbieterauthentifizierungstoken ab oder legt es fest, das über Ihre
Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

BaiduCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub BaiduCredential. BaiduCredentialProperties (erforderlich)

BaiduCredentialProperties

Name Beschreibung Wert
baiduApiKey Dient zum Abrufen oder Festlegen des baidu-API-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
baiduEndPoint Ruft baidu Endpoint ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
baiduSecretKey Ruft den baidu Secret Key ab oder legt den geheimen Schlüssel fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

BrowserAnmeldeinformationen

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub-Browseranmeldeinformationen. BrowserCredentialProperties (erforderlich)

BrowserCredentialProperties

Name Beschreibung Wert
Betreff Ruft den Web-Push-Betreff ab oder legt ihn fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
vapidPrivateKey Dient zum Abrufen oder Festlegen des privaten VAPID-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
vapidPublicKey Dient zum Abrufen oder Festlegen des öffentlichen VAPID-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

FcmV1Credential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub FcmV1Credential. FcmV1CredentialProperties (erforderlich)

FcmV1CredentialProperties

Name Beschreibung Wert
clientEmail Dient zum Abrufen oder Festlegen der Client-E-Mail. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
privateKey Dient zum Abrufen oder Festlegen eines privaten Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
projectId Ruft die Projekt-ID ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

GcmCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub GcmCredential. GcmCredentialProperties (erforderlich)

GcmCredentialProperties

Name Beschreibung Wert
gcmEndpoint Dient zum Abrufen oder Festlegen des GCM-Endpunkts. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
googleApiKey Ruft den Google-API-Schlüssel ab oder legt den Schlüssel fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

IpRule

Name Beschreibung Wert
ipMask IP-Maske. Schnur

Zwänge:
Min. Länge = 1 (erforderlich)
Rechte Liste der Zugriffsrechte. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Lauschen"
"Verwalten"
"Senden" (erforderlich)

Microsoft.NotificationHubs/Namespaces

Name Beschreibung Wert
apiVersion Die API-Version "2023-10-01-preview"
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[a-zA-Z][a-zA-Z0-9-]*$ (erforderlich)
Eigenschaften Stellt Namespaceeigenschaften dar. NamespaceProperties-
Sku Die Sku-Beschreibung für einen Namespace Sku- (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.NotificationHubs/namespaces"

MpnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub MpnsCredential. MpnsCredentialProperties (erforderlich)

MpnsCredentialProperties

Name Beschreibung Wert
certificateKey Ruft den Zertifikatschlüssel für diese Anmeldeinformationen ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
mpnsCertificate Ruft das MPNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
Fingerabdruck Ruft den MPNS-Zertifikatfingerabdruck ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

NamespaceProperties

Name Beschreibung Wert
DataCenter Veraltet. Schnur
namespaceType Definiert Werte für NamespaceType. "Messaging"
'NotificationHub'
networkAcls Eine Sammlung von Netzwerkautorisierungsregeln. NetworkAcls-
pnsCredentials Sammlung der PNS-Anmeldeinformationen des Benachrichtigungshub- oder Benachrichtigungshub-Namespaces. PnsCredentials-
provisioningState Definiert Werte für OperationProvisioningState. 'Abgebrochen'
"Deaktiviert"
'Fehler'
"InProgress"
"Ausstehend"
"Erfolgreich"
"Unbekannt"
publicNetworkAccess Typ des öffentlichen Netzwerkzugriffs. "Deaktiviert"
"Aktiviert"
replicationRegion Zulässige Replikationsregion "AustralienEast"
"BrazilSouth"
'Standard'
'None'
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
'WestUs2'
scaleUnit Ruft scaleUnit ab, wo der Namespace erstellt wird, oder legt diese fest. Schnur
Status Namespacestatus. "Erstellt"
"Erstellen"
"Löschen"
"Angehalten"
zoneRedundancy Namespace-SKU-Name. "Deaktiviert"
"Aktiviert"

NetworkAcls

Name Beschreibung Wert
ipRules Liste der IP-Regeln. IpRule-[]
publicNetworkRule Eine Standardmäßige (öffentliche Internet)-Netzwerkautorisierungsregel, die Rechte enthält, wenn keine andere Netzwerkregel übereinstimmt. PublicInternetAuthorizationRule-

PnsCredentials

Name Beschreibung Wert
admCredential Beschreibung einer NotificationHub AdmCredential. AdmCredential-
apnsCredential Beschreibung einer NotificationHub-ApnsCredential. ApnsCredential-
baiduCredential Beschreibung eines NotificationHub BaiduCredential. BaiduCredential-
browserCredential Beschreibung einer NotificationHub-Browseranmeldeinformationen. BrowserCredential-
fcmV1Credential Beschreibung eines NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beschreibung einer NotificationHub GcmCredential. GcmCredential-
mpnsCredential Beschreibung einer NotificationHub MpnsCredential. MpnsCredential-
wnsCredential Beschreibung eines NotificationHub WnsCredential. WnsCredential-
xiaomiCredential Beschreibung eines NotificationHub XiaomiCredential. XiaomiCredential

PublicInternetAuthorizationRule

Name Beschreibung Wert
Rechte Liste der Zugriffsrechte. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Lauschen"
"Verwalten"
"Senden" (erforderlich)

Sku

Name Beschreibung Wert
Fassungsvermögen Ruft die Kapazität der Ressource ab oder legt sie fest. Int
Familie Ruft die Sku-Familie ab oder legt sie fest Schnur
Name Namespace-SKU-Name. "Einfach"
"Kostenlos"
"Standard" (erforderlich)
Größe Ruft die Größe der Sku ab oder legt sie fest. Schnur
Rang Ruft die Ebene einer bestimmten SKU ab oder legt sie fest. Schnur

TrackedResourceTags

Name Beschreibung Wert

WnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub WnsCredential. WnsCredentialProperties- (erforderlich)

WnsCredentialProperties

Name Beschreibung Wert
certificateKey Ges oder legt den WNS-Zertifikatschlüssel fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
packageSid Ruft die Paket-ID für diese Anmeldeinformationen ab oder legt sie fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
secretKey Dient zum Abrufen oder Festlegen des geheimen Schlüssels. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
windowsLiveEndpoint Ruft den Windows Live-Endpunkt ab oder legt den Endpunkt fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
wnsCertificate Ruft das WNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

XiaomiCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (erforderlich)

XiaomiCredentialProperties

Name Beschreibung Wert
appSecret Ruft den geheimen App-Schlüssel ab oder legt den geheimen App-Schlüssel fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Endpunkt Ruft den Xiaomi-Dienstendpunkt ab oder legt den Endpunkt fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Erstellen von Azure Notification Hub-

Bereitstellen in Azure
Erstellt einen Azure Notification Hub, die ursprünglich von John Downs verfasste Vorlage.
Bereitstellen einer mobilen App mit einer SQL-Datenbank

Bereitstellen in Azure
Diese Vorlage stellt eine mobile App, SQL-Datenbank und einen Benachrichtigungshub zur Anwendung. Sie konfiguriert eine Verbindungszeichenfolge in der mobilen App für die Datenbank und den Benachrichtigungshub.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Namespaces-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.NotificationHubs/Namespaces-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@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 = {
      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"
          }
        }
        fcmV1Credential = {
          properties = {
            clientEmail = "string"
            privateKey = "string"
            projectId = "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"
    }
  })
}

Eigenschaftswerte

AdmCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub AdmCredential. AdmCredentialProperties- (erforderlich)

AdmCredentialProperties

Name Beschreibung Wert
authTokenUrl Ruft die URL des Autorisierungstokens ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
clientId Dient zum Abrufen oder Festlegen des Clientbezeichners. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
clientSecret Dient zum Abrufen oder Festlegen des geheimen Zugriffsschlüssels für Anmeldeinformationen. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

ApnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub-ApnsCredential. ApnsCredentialProperties (erforderlich)

ApnsCredentialProperties

Name Beschreibung Wert
apnsCertificate Ruft das APNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
appId Ruft den registrierten Anspruchsschlüssel des Ausstellers (iss) ab, dessen Wert
Ihre 10-stellige Team-ID aus Ihrem Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
appName Dient zum Abrufen oder Festlegen des Namens der Anwendung. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
certificateKey Dient zum Abrufen oder Festlegen des Zertifikatschlüssels. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Endpunkt Ruft den Endpunkt dieser Anmeldeinformationen ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
keyId Dient zum Abrufen oder Festlegen eines 10-stelligen Schlüsselbezeichners (Kid)-Schlüssels, der von
Ihr Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Fingerabdruck Ruft den APNS-Zertifikatfingerabdruck ab oder legt diesen fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Zeichen Ruft das anbieterauthentifizierungstoken ab oder legt es fest, das über Ihre
Entwicklerkonto
Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

BaiduCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub BaiduCredential. BaiduCredentialProperties (erforderlich)

BaiduCredentialProperties

Name Beschreibung Wert
baiduApiKey Dient zum Abrufen oder Festlegen des baidu-API-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
baiduEndPoint Ruft baidu Endpoint ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
baiduSecretKey Ruft den baidu Secret Key ab oder legt den geheimen Schlüssel fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

BrowserAnmeldeinformationen

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub-Browseranmeldeinformationen. BrowserCredentialProperties (erforderlich)

BrowserCredentialProperties

Name Beschreibung Wert
Betreff Ruft den Web-Push-Betreff ab oder legt ihn fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
vapidPrivateKey Dient zum Abrufen oder Festlegen des privaten VAPID-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
vapidPublicKey Dient zum Abrufen oder Festlegen des öffentlichen VAPID-Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

FcmV1Credential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub FcmV1Credential. FcmV1CredentialProperties (erforderlich)

FcmV1CredentialProperties

Name Beschreibung Wert
clientEmail Dient zum Abrufen oder Festlegen der Client-E-Mail. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
privateKey Dient zum Abrufen oder Festlegen eines privaten Schlüssels. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
projectId Ruft die Projekt-ID ab oder legt sie fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

GcmCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub GcmCredential. GcmCredentialProperties (erforderlich)

GcmCredentialProperties

Name Beschreibung Wert
gcmEndpoint Dient zum Abrufen oder Festlegen des GCM-Endpunkts. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
googleApiKey Ruft den Google-API-Schlüssel ab oder legt den Schlüssel fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

IpRule

Name Beschreibung Wert
ipMask IP-Maske. Schnur

Zwänge:
Min. Länge = 1 (erforderlich)
Rechte Liste der Zugriffsrechte. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Lauschen"
"Verwalten"
"Senden" (erforderlich)

Microsoft.NotificationHubs/Namespaces

Name Beschreibung Wert
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[a-zA-Z][a-zA-Z0-9-]*$ (erforderlich)
Eigenschaften Stellt Namespaceeigenschaften dar. NamespaceProperties-
Sku Die Sku-Beschreibung für einen Namespace Sku- (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"

MpnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung einer NotificationHub MpnsCredential. MpnsCredentialProperties (erforderlich)

MpnsCredentialProperties

Name Beschreibung Wert
certificateKey Ruft den Zertifikatschlüssel für diese Anmeldeinformationen ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
mpnsCertificate Ruft das MPNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)
Fingerabdruck Ruft den MPNS-Zertifikatfingerabdruck ab oder legt diesen fest. Schnur

Zwänge:
Min. Länge = 1
Vertraulicher Wert. Übergeben Als sicherer Parameter. (erforderlich)

NamespaceProperties

Name Beschreibung Wert
DataCenter Veraltet. Schnur
namespaceType Definiert Werte für NamespaceType. "Messaging"
'NotificationHub'
networkAcls Eine Sammlung von Netzwerkautorisierungsregeln. NetworkAcls-
pnsCredentials Sammlung der PNS-Anmeldeinformationen des Benachrichtigungshub- oder Benachrichtigungshub-Namespaces. PnsCredentials-
provisioningState Definiert Werte für OperationProvisioningState. 'Abgebrochen'
"Deaktiviert"
'Fehler'
"InProgress"
"Ausstehend"
"Erfolgreich"
"Unbekannt"
publicNetworkAccess Typ des öffentlichen Netzwerkzugriffs. "Deaktiviert"
"Aktiviert"
replicationRegion Zulässige Replikationsregion "AustralienEast"
"BrazilSouth"
'Standard'
'None'
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
'WestUs2'
scaleUnit Ruft scaleUnit ab, wo der Namespace erstellt wird, oder legt diese fest. Schnur
Status Namespacestatus. "Erstellt"
"Erstellen"
"Löschen"
"Angehalten"
zoneRedundancy Namespace-SKU-Name. "Deaktiviert"
"Aktiviert"

NetworkAcls

Name Beschreibung Wert
ipRules Liste der IP-Regeln. IpRule-[]
publicNetworkRule Eine Standardmäßige (öffentliche Internet)-Netzwerkautorisierungsregel, die Rechte enthält, wenn keine andere Netzwerkregel übereinstimmt. PublicInternetAuthorizationRule-

PnsCredentials

Name Beschreibung Wert
admCredential Beschreibung einer NotificationHub AdmCredential. AdmCredential-
apnsCredential Beschreibung einer NotificationHub-ApnsCredential. ApnsCredential-
baiduCredential Beschreibung eines NotificationHub BaiduCredential. BaiduCredential-
browserCredential Beschreibung einer NotificationHub-Browseranmeldeinformationen. BrowserCredential-
fcmV1Credential Beschreibung eines NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beschreibung einer NotificationHub GcmCredential. GcmCredential-
mpnsCredential Beschreibung einer NotificationHub MpnsCredential. MpnsCredential-
wnsCredential Beschreibung eines NotificationHub WnsCredential. WnsCredential-
xiaomiCredential Beschreibung eines NotificationHub XiaomiCredential. XiaomiCredential

PublicInternetAuthorizationRule

Name Beschreibung Wert
Rechte Liste der Zugriffsrechte. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
"Lauschen"
"Verwalten"
"Senden" (erforderlich)

Sku

Name Beschreibung Wert
Fassungsvermögen Ruft die Kapazität der Ressource ab oder legt sie fest. Int
Familie Ruft die Sku-Familie ab oder legt sie fest Schnur
Name Namespace-SKU-Name. "Einfach"
"Kostenlos"
"Standard" (erforderlich)
Größe Ruft die Größe der Sku ab oder legt sie fest. Schnur
Rang Ruft die Ebene einer bestimmten SKU ab oder legt sie fest. Schnur

TrackedResourceTags

Name Beschreibung Wert

WnsCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub WnsCredential. WnsCredentialProperties- (erforderlich)

WnsCredentialProperties

Name Beschreibung Wert
certificateKey Ges oder legt den WNS-Zertifikatschlüssel fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
packageSid Ruft die Paket-ID für diese Anmeldeinformationen ab oder legt sie fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
secretKey Dient zum Abrufen oder Festlegen des geheimen Schlüssels. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
windowsLiveEndpoint Ruft den Windows Live-Endpunkt ab oder legt den Endpunkt fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
wnsCertificate Ruft das WNS-Zertifikat ab oder legt es fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.

XiaomiCredential

Name Beschreibung Wert
Eigenschaften Beschreibung eines NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (erforderlich)

XiaomiCredentialProperties

Name Beschreibung Wert
appSecret Ruft den geheimen App-Schlüssel ab oder legt den geheimen App-Schlüssel fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
Endpunkt Ruft den Xiaomi-Dienstendpunkt ab oder legt den Endpunkt fest. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.