Delen via

Microsoft.NotificationHubs-naamruimten

  • Artikel

Bicep-resourcedefinitie

Het resourcetype naamruimten kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.NotificationHubs/naamruimten wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: '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'
  }
}

Eigenschapswaarden

Naamruimten

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 6-50

Geldige tekens:
Alfanumerieken en afbreekstreepjes

Begin met letter. Eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku De SKU-beschrijving voor een naamruimte SKU (vereist)
properties Vertegenwoordigt naamruimteeigenschappen. NaamruimteEigenschappen

NaamruimteEigenschappen

Naam Description Waarde
Datacenter Afgeschaft. tekenreeks
namespaceType Definieert waarden voor NamespaceType. 'Berichten'
NotificationHub
networkAcls Een verzameling netwerkautorisatieregels. NetworkAcls
pnsCredentials Verzameling van PNS-referenties voor Notification Hub of Notification Hub-naamruimte. PnsCredentials
provisioningState Definieert waarden voor OperationProvisioningState. 'Geannuleerd'
'Uitgeschakeld'
'Mislukt'
'InProgress'
'In behandeling'
'Geslaagd'
'Onbekend'
publicNetworkAccess Type openbare netwerktoegang. 'Uitgeschakeld'
Ingeschakeld
replicationRegion Toegestane replicatieregio 'AustraliaEast'
'BrazilSouth'
'Standaard'
'Geen'
'Noord-Europa'
'SouthAfricaNorth'
'SouthEastAsia'
'WestUs2'
scaleUnit Hiermee wordt scaleUnit opgehaald of ingesteld waar de naamruimte wordt gemaakt tekenreeks
status Naamruimtestatus. 'Gemaakt'
'Maken'
'Verwijderen'
'Opgeschort'
zoneRedundancy Naamruimte-SKU-naam. 'Uitgeschakeld'
Ingeschakeld

NetworkAcls

Naam Description Waarde
ipRules Lijst met IP-regels. IpRule[]
publicNetworkRule Een standaardregel voor netwerkautorisatie (openbaar internet), die rechten bevat als er geen andere netwerkregel overeenkomt. PublicInternetAuthorizationRule

IpRule

Naam Description Waarde
ipMask IP-masker. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Rechten Lijst met toegangsrechten. Tekenreeksmatrix met een van de volgende waarden:
'Luister'
'Beheren'
Verzenden (vereist)

PublicInternetAuthorizationRule

Naam Description Waarde
Rechten Lijst met toegangsrechten. Tekenreeksmatrix met een van de volgende waarden:
'Luister'
'Beheren'
Verzenden (vereist)

PnsCredentials

Naam Description Waarde
admCredential Beschrijving van een NotificationHub AdmCredential. AdmCredential
apnsCredential Beschrijving van een NotificationHub ApnsCredential. ApnsCredential
baiduCredential Beschrijving van een NotificationHub BaiduCredential. BaiduCredential
browserCredential Beschrijving van een NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Beschrijving van een NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beschrijving van een NotificationHub GcmCredential. GcmCredential
mpnsCredential Beschrijving van een NotificationHub MpnsCredential. MpnsCredential
wnsCredential Beschrijving van een NotificationHub WnsCredential. WnsCredential
xiaomiCredential Beschrijving van een NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub AdmCredential. AdmCredentialProperties (vereist)

AdmCredentialProperties

Naam Description Waarde
authTokenUrl Hiermee wordt de URL van het autorisatietoken opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
clientId Hiermee wordt de client-id opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
clientSecret Hiermee wordt de geheime toegangssleutel voor referenties opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

ApnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub ApnsCredential. ApnsCredentialProperties (vereist)

ApnsCredentialProperties

Naam Description Waarde
apnsCertificate Hiermee wordt het APNS-certificaat opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
appId Hiermee wordt de geregistreerde claimsleutel van de verlener (iss) opgehaald of ingesteld, waarvan de waarde is
uw team-id van 10 tekens, verkregen uit uw ontwikkelaarsaccount		 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Appname De naam van de toepassing ophalen of instellen tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
certificateKey Hiermee wordt de certificaatsleutel opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
endpoint Hiermee wordt het eindpunt van deze referentie opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
keyId Hiermee wordt een sleutel-id van 10 tekens (kid) opgehaald of ingesteld, verkregen van
uw ontwikkelaarsaccount		 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Vingerafdruk De vingerafdruk van het APNS-certificaat ophalen of instellen tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
token Hiermee wordt het verificatietoken van de provider opgehaald of ingesteld, verkregen via uw
ontwikkelaarsaccount
 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

BaiduCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub BaiduCredential. BaiduCredentialProperties (vereist)

BaiduCredentialProperties

Naam Description Waarde
baiduApiKey Hiermee wordt de baidu-API-sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
baiduEndPoint Hiermee wordt baidu-eindpunt opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
baiduSecretKey Hiermee wordt een geheime baidu-sleutel opgehaald of ingesteld tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

BrowserCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub BrowserCredential. BrowserCredentialProperties (vereist)

BrowserCredentialProperties

Naam Description Waarde
onderwerp Hiermee wordt webpushonderwerp opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
vapidPrivateKey Hiermee wordt de persoonlijke sleutel voor VAPID opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
vapidPublicKey Hiermee wordt de openbare sleutel VOOR VAPID opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

FcmV1Credential

Naam Description Waarde
properties Beschrijving van een NotificationHub FcmV1Credential. FcmV1CredentialProperties (vereist)

FcmV1CredentialProperties

Naam Description Waarde
clientEmail Hiermee wordt client-e-mail opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
privateKey Hiermee wordt een persoonlijke sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
projectId Hiermee wordt de project-id opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

GcmCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub GcmCredential. GcmCredentialProperties (vereist)

GcmCredentialProperties

Naam Description Waarde
gcmEndpoint Hiermee wordt het GCM-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
googleApiKey Hiermee wordt de Google API-sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

MpnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub MpnsCredential. MpnsCredentialProperties (vereist)

MpnsCredentialProperties

Naam Description Waarde
certificateKey Hiermee wordt de certificaatsleutel voor deze referentie opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
mpnsCertificate Hiermee wordt het MPNS-certificaat opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Vingerafdruk De vingerafdruk van het MPNS-certificaat ophalen of instellen tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

WnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub WnsCredential. WnsCredentialProperties (vereist)

WnsCredentialProperties

Naam Description Waarde
certificateKey Ges of stelt de WNS-certificaatsleutel in. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
packageSid Hiermee wordt de pakket-id voor deze referentie opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
secretKey Hiermee wordt de geheime sleutel opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
windowsLiveEndpoint Hiermee wordt het Windows Live-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
wnsCertificate Hiermee wordt het WNS-certificaat opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

XiaomiCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (vereist)

XiaomiCredentialProperties

Naam Description Waarde
appSecret Hiermee wordt het app-geheim opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
endpoint Hiermee wordt het xiaomi-service-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

Sku

Naam Description Waarde
capacity Hiermee wordt de capaciteit van de resource opgehaald of ingesteld int
gezin Hiermee wordt de SKU-familie opgehaald of ingesteld tekenreeks
naam Naamruimte-SKU-naam. 'Basic'
'Gratis'
Standaard (vereist)
grootte Hiermee wordt de SKU-grootte opgehaald of ingesteld tekenreeks
laag Hiermee wordt de laag van een bepaalde SKU opgehaald of ingesteld tekenreeks

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Azure Notification Hub maken

Implementeren op Azure		 Hiermee maakt u een Azure Notification Hub, een sjabloon die oorspronkelijk is geschreven door John Downs.
Een mobiele app inrichten met een SQL Database

Implementeren op Azure		 Deze sjabloon richt een mobiele app, SQL Database en Notification Hub in. Hiermee configureert u een verbindingsreeks in de mobiele app voor de database en notification hub.

Resourcedefinitie van ARM-sjabloon

Het resourcetype naamruimten kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.NotificationHubs/naamruimten wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.NotificationHubs/namespaces",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "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"
  }
}

Eigenschapswaarden

Naamruimten

Naam Description Waarde
type Het resourcetype 'Microsoft.NotificationHubs/namespaces'
apiVersion De resource-API-versie '2023-10-01-preview'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 6-50

Geldige tekens:
Alfanumerieken en afbreekstreepjes

Begin met letter. Eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku De SKU-beschrijving voor een naamruimte SKU (vereist)
properties Vertegenwoordigt naamruimte-eigenschappen. NaamruimteEigenschappen

NaamruimteEigenschappen

Naam Description Waarde
Datacenter Afgeschaft. tekenreeks
namespaceType Definieert waarden voor NamespaceType. 'Berichten'
NotificationHub
networkAcls Een verzameling netwerkautorisatieregels. NetworkAcls
pnsCredentials Verzameling van PNS-referenties voor Notification Hub of Notification Hub-naamruimte. PnsCredentials
provisioningState Definieert waarden voor OperationProvisioningState. 'Geannuleerd'
'Uitgeschakeld'
'Mislukt'
'InProgress'
'In behandeling'
Geslaagd
'Onbekend'
publicNetworkAccess Type openbare netwerktoegang. 'Uitgeschakeld'
Ingeschakeld
replicationRegion Toegestane replicatieregio 'AustraliaEast'
'BrazilSouth'
'Standaard'
'Geen'
'NoordEurope'
'SouthAfricaNorth'
'SouthEastAsia'
'WestUs2'
scaleUnit Hiermee wordt scaleUnit opgehaald of ingesteld waar de naamruimte wordt gemaakt tekenreeks
status Naamruimtestatus. 'Gemaakt'
'Maken'
'Verwijderen'
'Opgeschort'
zoneRedundancy Naamruimte-SKU-naam. 'Uitgeschakeld'
Ingeschakeld

NetworkAcls

Naam Description Waarde
ipRules Lijst met IP-regels. IpRule[]
publicNetworkRule Een standaardnetwerkautorisatieregel (openbaar internet), die rechten bevat als er geen andere netwerkregel overeenkomt. PublicInternetAuthorizationRule

IpRule

Naam Description Waarde
ipMask IP-masker. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Rechten Lijst met toegangsrechten. Tekenreeksmatrix met een van de volgende:
'Luister'
'Beheren'
Verzenden (vereist)

PublicInternetAuthorizationRule

Naam Description Waarde
Rechten Lijst met toegangsrechten. Tekenreeksmatrix met een van de volgende:
'Luister'
'Beheren'
Verzenden (vereist)

PnsCredentials

Naam Description Waarde
admCredential Beschrijving van een NotificationHub AdmCredential. AdmCredential
apnsCredential Beschrijving van een NotificationHub ApnsCredential. ApnsCredential
baiduCredential Beschrijving van een NotificationHub BaiduCredential. BaiduCredential
browserCredential Beschrijving van een NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Beschrijving van een NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beschrijving van een NotificationHub GcmCredential. GcmCredential
mpnsCredential Beschrijving van een NotificationHub MpnsCredential. MpnsCredential
wnsCredential Beschrijving van een NotificationHub WnsCredential. WnsCredential
xiaomiCredential Beschrijving van een NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub AdmCredential. AdmCredentialProperties (vereist)

AdmCredentialProperties

Naam Description Waarde
authTokenUrl Hiermee wordt de URL van het autorisatietoken opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
clientId Hiermee wordt de client-id opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
clientSecret Hiermee wordt de toegangssleutel voor het referentiegeheim opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

ApnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub ApnsCredential. ApnsCredentialProperties (vereist)

ApnsCredentialProperties

Naam Description Waarde
apnsCertificate Hiermee wordt het APNS-certificaat opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
appId Haalt de geregistreerde claimsleutel van de verlener (iss) op of stelt deze in, waarvan de waarde is
uw team-id van 10 tekens, verkregen van uw ontwikkelaarsaccount		 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Appname De naam van de toepassing ophalen of instellen tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
certificateKey Hiermee wordt de certificaatsleutel opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
endpoint Hiermee wordt het eindpunt van deze referentie opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
keyId Hiermee wordt een sleutel van tien tekens (kid) opgehaald of ingesteld, verkregen van
uw ontwikkelaarsaccount		 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Vingerafdruk De vingerafdruk van het APNS-certificaat ophalen of instellen tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
token Haalt het verificatietoken van de provider op of stelt dit in, verkregen via uw
ontwikkelaarsaccount
 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

BaiduCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub BaiduCredential. BaiduCredentialProperties (vereist)

BaiduCredentialProperties

Naam Description Waarde
baiduApiKey Hiermee wordt de baidu-API-sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
baiduEndPoint Hiermee wordt een baidu-eindpunt opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
baiduSecretKey Haalt de geheime sleutel van baidu op of stelt deze in tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

BrowserCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub BrowserCredential. BrowserCredentialProperties (vereist)

BrowserCredentialProperties

Naam Description Waarde
onderwerp Hiermee wordt het webpushonderwerp opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
vapidPrivateKey Hiermee wordt de persoonlijke sleutel VAN VAPID opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
vapidPublicKey Hiermee wordt de openbare sleutel van VAPID opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

FcmV1Credential

Naam Description Waarde
properties Beschrijving van een NotificationHub FcmV1Credential. FcmV1CredentialProperties (vereist)

FcmV1CredentialProperties

Naam Description Waarde
clientEmail Hiermee wordt client-e-mail opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
privateKey Hiermee wordt een persoonlijke sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
projectId Hiermee wordt de project-id opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

GcmCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub GcmCredential. GcmCredentialProperties (vereist)

GcmCredentialProperties

Naam Description Waarde
gcmEndpoint Hiermee wordt het GCM-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
googleApiKey Hiermee wordt de Google API-sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

MpnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub MpnsCredential. MpnsCredentialProperties (vereist)

MpnsCredentialProperties

Naam Description Waarde
certificateKey Hiermee wordt de certificaatsleutel voor deze referentie opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
mpnsCertificate Hiermee wordt het MPNS-certificaat opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Vingerafdruk De vingerafdruk van het MPNS-certificaat ophalen of instellen tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

WnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub WnsCredential. WnsCredentialProperties (vereist)

WnsCredentialProperties

Naam Description Waarde
certificateKey Ges of stelt de WNS-certificaatsleutel in. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
packageSid Hiermee wordt de pakket-id voor deze referentie opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
secretKey Hiermee wordt de geheime sleutel opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
windowsLiveEndpoint Hiermee wordt het Windows Live-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
wnsCertificate Hiermee wordt het WNS-certificaat opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

XiaomiCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (vereist)

XiaomiCredentialProperties

Naam Description Waarde
appSecret Hiermee wordt een app-geheim opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
endpoint Hiermee wordt het xiaomi-service-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

Sku

Naam Description Waarde
capacity Hiermee wordt de capaciteit van de resource opgehaald of ingesteld int
gezin Hiermee wordt de SKU-familie opgehaald of ingesteld tekenreeks
naam Naamruimte-SKU-naam. 'Basic'
'Gratis'
'Standaard' (vereist)
grootte Hiermee wordt de SKU-grootte opgehaald of ingesteld tekenreeks
laag Hiermee wordt de laag van een bepaalde SKU opgehaald of ingesteld tekenreeks

Snelstartsjablonen

Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Azure Notification Hub maken

Implementeren op Azure		 Hiermee maakt u een Azure Notification Hub, een sjabloon die oorspronkelijk is geschreven door John Downs.
Een mobiele app inrichten met een SQL Database

Implementeren op Azure		 Deze sjabloon richt een mobiele app, SQL Database en Notification Hub in. Hiermee configureert u een verbindingsreeks in de mobiele app voor de database en notification hub.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype naamruimten kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.NotificationHubs/naamruimten wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

Eigenschapswaarden

Naamruimten

Naam Description Waarde
type Het resourcetype "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 6-50

Geldige tekens:
Alfanumerieken en afbreekstreepjes

Begin met letter. Eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden.
sku De SKU-beschrijving voor een naamruimte SKU (vereist)
properties Vertegenwoordigt naamruimte-eigenschappen. NaamruimteEigenschappen

NaamruimteEigenschappen

Naam Description Waarde
Datacenter Afgeschaft. tekenreeks
namespaceType Definieert waarden voor NamespaceType. "Berichten"
"NotificationHub"
networkAcls Een verzameling netwerkautorisatieregels. NetworkAcls
pnsCredentials Verzameling van PNS-referenties voor Notification Hub of Notification Hub-naamruimte. PnsCredentials
provisioningState Definieert waarden voor OperationProvisioningState. "Geannuleerd"
"Uitgeschakeld"
"Mislukt"
"InProgress"
"In behandeling"
"Geslaagd"
"Onbekend"
publicNetworkAccess Type openbare netwerktoegang. "Uitgeschakeld"
"Ingeschakeld"
replicationRegion Toegestane replicatieregio "AustraliaEast"
"BrazilSouth"
"Standaard"
"Geen"
"NoordEurope"
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
scaleUnit Hiermee wordt scaleUnit opgehaald of ingesteld waar de naamruimte wordt gemaakt tekenreeks
status Naamruimtestatus. "Gemaakt"
"Maken"
"Verwijderen"
"Onderbroken"
zoneRedundancy Naamruimte-SKU-naam. "Uitgeschakeld"
"Ingeschakeld"

NetworkAcls

Naam Description Waarde
ipRules Lijst met IP-regels. IpRule[]
publicNetworkRule Een standaardregel voor netwerkautorisatie (openbaar internet), die rechten bevat als er geen andere netwerkregel overeenkomt. PublicInternetAuthorizationRule

IpRule

Naam Description Waarde
ipMask IP-masker. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Rechten Lijst met toegangsrechten. Tekenreeksmatrix met een van de volgende waarden:
"Luister"
"Beheren"
Verzenden (vereist)

PublicInternetAuthorizationRule

Naam Description Waarde
Rechten Lijst met toegangsrechten. Tekenreeksmatrix met een van de volgende waarden:
"Luister"
"Beheren"
Verzenden (vereist)

PnsCredentials

Naam Description Waarde
admCredential Beschrijving van een NotificationHub AdmCredential. AdmCredential
apnsCredential Beschrijving van een NotificationHub ApnsCredential. ApnsCredential
baiduCredential Beschrijving van een NotificationHub BaiduCredential. BaiduCredential
browserCredential Beschrijving van een NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Beschrijving van een NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beschrijving van een NotificationHub GcmCredential. GcmCredential
mpnsCredential Beschrijving van een NotificationHub MpnsCredential. MpnsCredential
wnsCredential Beschrijving van een NotificationHub WnsCredential. WnsCredential
xiaomiCredential Beschrijving van een NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub AdmCredential. AdmCredentialProperties (vereist)

AdmCredentialProperties

Naam Description Waarde
authTokenUrl Hiermee wordt de URL van het autorisatietoken opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
clientId Hiermee wordt de client-id opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
clientSecret Hiermee wordt de geheime toegangssleutel voor referenties opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

ApnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub ApnsCredential. ApnsCredentialProperties (vereist)

ApnsCredentialProperties

Naam Description Waarde
apnsCertificate Hiermee wordt het APNS-certificaat opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
appId Hiermee wordt de geregistreerde claimsleutel van de verlener (iss) opgehaald of ingesteld, waarvan de waarde is
uw team-id van 10 tekens, verkregen uit uw ontwikkelaarsaccount		 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Appname De naam van de toepassing ophalen of instellen tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
certificateKey Hiermee wordt de certificaatsleutel opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
endpoint Hiermee wordt het eindpunt van deze referentie opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
keyId Hiermee wordt een sleutel-id van 10 tekens (kid) opgehaald of ingesteld, verkregen van
uw ontwikkelaarsaccount		 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Vingerafdruk De vingerafdruk van het APNS-certificaat ophalen of instellen tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
token Hiermee wordt het verificatietoken van de provider opgehaald of ingesteld, verkregen via uw
ontwikkelaarsaccount
 tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

BaiduCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub BaiduCredential. BaiduCredentialProperties (vereist)

BaiduCredentialProperties

Naam Description Waarde
baiduApiKey Hiermee wordt de baidu-API-sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
baiduEndPoint Hiermee wordt baidu-eindpunt opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
baiduSecretKey Hiermee wordt een geheime baidu-sleutel opgehaald of ingesteld tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

BrowserCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub BrowserCredential. BrowserCredentialProperties (vereist)

BrowserCredentialProperties

Naam Description Waarde
onderwerp Hiermee wordt webpushonderwerp opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
vapidPrivateKey Hiermee wordt de persoonlijke sleutel voor VAPID opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
vapidPublicKey Hiermee wordt de openbare sleutel VOOR VAPID opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

FcmV1Credential

Naam Description Waarde
properties Beschrijving van een NotificationHub FcmV1Credential. FcmV1CredentialProperties (vereist)

FcmV1CredentialProperties

Naam Description Waarde
clientEmail Hiermee wordt client-e-mail opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
privateKey Hiermee wordt een persoonlijke sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
projectId Hiermee wordt de project-id opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

GcmCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub GcmCredential. GcmCredentialProperties (vereist)

GcmCredentialProperties

Naam Description Waarde
gcmEndpoint Hiermee wordt het GCM-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
googleApiKey Hiermee wordt de Google API-sleutel opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

MpnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub MpnsCredential. MpnsCredentialProperties (vereist)

MpnsCredentialProperties

Naam Description Waarde
certificateKey Hiermee wordt de certificaatsleutel voor deze referentie opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
mpnsCertificate Hiermee wordt het MPNS-certificaat opgehaald of ingesteld. tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.
Vingerafdruk De vingerafdruk van het MPNS-certificaat ophalen of instellen tekenreeks (vereist)

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter.

WnsCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub WnsCredential. WnsCredentialProperties (vereist)

WnsCredentialProperties

Naam Description Waarde
certificateKey Ges of stelt de WNS-certificaatsleutel in. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
packageSid Hiermee wordt de pakket-id voor deze referentie opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
secretKey Hiermee wordt de geheime sleutel opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
windowsLiveEndpoint Hiermee wordt het Windows Live-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
wnsCertificate Hiermee wordt het WNS-certificaat opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

XiaomiCredential

Naam Description Waarde
properties Beschrijving van een NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (vereist)

XiaomiCredentialProperties

Naam Description Waarde
appSecret Hiermee wordt een app-geheim opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
endpoint Hiermee wordt het xiaomi-service-eindpunt opgehaald of ingesteld. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.

Sku

Naam Description Waarde
capacity Hiermee wordt de capaciteit van de resource opgehaald of ingesteld int
gezin Hiermee wordt de SKU-familie opgehaald of ingesteld tekenreeks
naam Naamruimte-SKU-naam. "Basis"
"Gratis"
'Standaard' (vereist)
grootte Hiermee wordt de SKU-grootte opgehaald of ingesteld tekenreeks
laag Hiermee wordt de laag van een bepaalde SKU opgehaald of ingesteld tekenreeks