Dela via

Microsoft.NotificationHubs-namnområden

  • Artikel

Bicep-resursdefinition

Namnområdesresurstypen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.NotificationHubs/namespaces-resurs lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

Namnområden

Name Beskrivning Värde
name Resursnamnet sträng (krävs)

Teckengräns: 6–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck

Börja med bokstav. Avsluta med alfanumeriskt.

Resursnamnet måste vara unikt i Hela Azure.
location Den geo-plats där resursen finns sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
sku SKU-beskrivningen för ett namnområde SKU (krävs)
properties Representerar namnområdesegenskaper. NamespaceProperties

NamespaceProperties

Name Beskrivning Värde
Datacenter Inaktuellt. sträng
namespaceType Definierar värden för NamespaceType. Meddelanden
"NotificationHub"
networkAcls En samling regler för nätverksauktorisering. NetworkAcls
pnsCredentials Insamling av PNS-autentiseringsuppgifter för Notification Hub eller Notification Hub Namespace. PnsCredentials
provisioningState Definierar värden för OperationProvisioningState. "Avbruten"
"Inaktiverad"
"Misslyckades"
"InProgress"
"Väntar"
"Lyckades"
"Okänd"
publicNetworkAccess Typ av åtkomst till offentligt nätverk. "Inaktiverad"
"Aktiverad"
replicationRegion Tillåten replikeringsregion "AustraliaEast"
"BrazilSouth"
"Standard"
"Ingen"
"Nordeurope"
"SouthAfricaNorth"
"Sydostasien"
"Usa, västra 2"
scaleUnit Hämtar eller anger scaleUnit där namnområdet skapas sträng
status Namnområdesstatus. "Skapad"
"Skapar"
"Tar bort"
"Pausad"
zoneRedundancy Namnområdes-SKU-namn. "Inaktiverad"
"Aktiverad"

NetworkAcls

Name Beskrivning Värde
ipRules Lista över IP-regler. IpRule[]
publicNetworkRule En standardregel för nätverksauktorisering (offentligt Internet) som innehåller rättigheter om ingen annan nätverksregel matchar. PublicInternetAuthorizationRule

IpRule

Name Beskrivning Värde
ipMask IP-mask. sträng (krävs)

Begränsningar:
Minsta längd = 1
Rättigheter Lista över åtkomsträttigheter. Strängmatris som innehåller något av:
"Lyssna"
"Hantera"
"Skicka" (obligatoriskt)

PublicInternetAuthorizationRule

Name Beskrivning Värde
Rättigheter Lista över åtkomsträttigheter. Strängmatris som innehåller något av:
"Lyssna"
"Hantera"
"Skicka" (obligatoriskt)

PnsCredentials

Name Beskrivning Värde
admCredential Beskrivning av en NotificationHub AdmCredential. AdmCredential
apnsCredential Beskrivning av en NotificationHub ApnsCredential. ApnsCredential
baiduCredential Beskrivning av en NotificationHub BaiduCredential. BaiduCredential
browserCredential Beskrivning av en NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Beskrivning av en NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beskrivning av en NotificationHub GcmCredential. GcmCredential
mpnsCredential Beskrivning av en NotificationHub MpnsCredential. MpnsCredential
wnsCredential Beskrivning av en NotificationHub WnsCredential. WnsCredential
xiaomiCredential Beskrivning av en NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub AdmCredential. AdmCredentialProperties (krävs)

AdmCredentialProperties

Name Beskrivning Värde
authTokenUrl Hämtar eller anger URL:en för auktoriseringstoken. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
ClientID Hämtar eller anger klientidentifieraren. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
clientSecret Hämtar eller anger åtkomstnyckeln för hemligheten för autentiseringsuppgifter. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

ApnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub ApnsCredential. ApnsCredentialProperties (krävs)

ApnsCredentialProperties

Name Beskrivning Värde
apnsCertificate Hämtar eller anger APNS-certifikatet. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
appId Hämtar eller anger den registrerade anspråksnyckeln för utfärdaren (iss), vars värde är
ditt team-ID på 10 tecken som hämtats från ditt utvecklarkonto		 sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
Appname Hämtar eller anger namnet på programmet sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
certificateKey Hämtar eller anger certifikatnyckeln. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
slutpunkt Hämtar eller anger slutpunkten för den här autentiseringsuppgiften. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
keyId Hämtar eller anger en nyckelidentifierare på 10 tecken (barn) som hämtats från
ditt utvecklarkonto		 sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
Stämpel Hämtar eller anger APNS-certifikatets tumavtryck sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
token Hämtar eller anger providerautentiseringstoken som hämtas via din
utvecklarkonto
 sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.

BaiduCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub BaiduCredential. BaiduCredentialProperties (krävs)

BaiduCredentialProperties

Name Beskrivning Värde
baiduApiKey Hämtar eller ställer in baidu Api Key. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
baiduEndPoint Hämtar eller ställer in baidu-slutpunkt. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
baiduSecretKey Hämtar eller ställer in hemlig baidu-nyckel sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

BrowserCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub BrowserCredential. BrowserCredentialProperties (krävs)

BrowserCredentialProperties

Name Beskrivning Värde
ämne Hämtar eller ställer in webb-push-ämne. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
vapidPrivateKey Hämtar eller anger en privat VAPID-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
vapidPublicKey Hämtar eller anger offentlig VAPID-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

FcmV1Credential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub FcmV1Credential. FcmV1CredentialProperties (krävs)

FcmV1CredentialProperties

Name Beskrivning Värde
clientEmail Hämtar eller anger klient-e-post. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
privateKey Hämtar eller anger privat nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
projectId Hämtar eller anger projekt-ID. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

GcmCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub GcmCredential. GcmCredentialProperties (krävs)

GcmCredentialProperties

Name Beskrivning Värde
gcmEndpoint Hämtar eller anger GCM-slutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
googleApiKey Hämtar eller anger Google API-nyckeln. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

MpnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub MpnsCredential. MpnsCredentialProperties (krävs)

MpnsCredentialProperties

Name Beskrivning Värde
certificateKey Hämtar eller anger certifikatnyckeln för den här autentiseringsuppgiften. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
mpnsCertificate Hämtar eller anger MPNS-certifikatet. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
Stämpel Hämtar eller anger MPNS-certifikatets tumavtryck sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

WnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub WnsCredential. WnsCredentialProperties (krävs)

WnsCredentialProperties

Name Beskrivning Värde
certificateKey Ges eller anger WNS-certifikatnyckeln. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
packageSid Hämtar eller anger paket-ID för den här autentiseringsuppgiften. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
secretKey Hämtar eller anger den hemliga nyckeln. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
windowsLiveEndpoint Hämtar eller anger Windows Live-slutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
wnsCertificate Hämtar eller anger WNS-certifikatet. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.

XiaomiCredential

Name Beskrivning Värde
properties Beskrivning av NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (krävs)

XiaomiCredentialProperties

Name Beskrivning Värde
appSecret Hämtar eller anger apphemlighet. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
slutpunkt Hämtar eller anger xiaomi-tjänstslutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.

Sku

Name Beskrivning Värde
capacity Hämtar eller anger resursens kapacitet int
familj Hämtar eller ställer in SKU-familjen sträng
name Namnområdes-SKU-namn. "Grundläggande"
"Kostnadsfri"
"Standard" (krävs)
ikoner Hämtar eller anger SKU-storleken sträng
nivå Hämtar eller anger nivån för en viss sku sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa Azure Notification Hub

Distribuera till Azure		 Skapar en Azure Notification Hub, en mall som ursprungligen skapades av John Downs.
Etablera en mobilapp med en SQL Database

Distribuera till Azure		 Den här mallen etablerar en Mobilapp, SQL Database och Notification Hub. Den konfigurerar en anslutningssträng i mobilappen för databasen och meddelandehubben.

Resursdefinition för ARM-mall

Namnområdesresurstypen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.NotificationHubs/namespaces-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

Namnområden

Name Beskrivning Värde
typ Resurstypen "Microsoft.NotificationHubs/namespaces"
apiVersion Resurs-API-versionen "2023-10-01-preview"
name Resursnamnet sträng (krävs)

Teckengräns: 6–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck

Börja med bokstav. Avsluta med alfanumeriskt.

Resursnamnet måste vara unikt i Hela Azure.
location Den geo-plats där resursen finns sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
sku SKU-beskrivningen för ett namnområde SKU (krävs)
properties Representerar namnområdesegenskaper. NamespaceProperties

NamespaceProperties

Name Beskrivning Värde
Datacenter Inaktuellt. sträng
namespaceType Definierar värden för NamespaceType. Meddelanden
"NotificationHub"
networkAcls En samling regler för nätverksauktorisering. NetworkAcls
pnsCredentials Insamling av PNS-autentiseringsuppgifter för Notification Hub eller Notification Hub Namespace. PnsCredentials
provisioningState Definierar värden för OperationProvisioningState. "Avbruten"
"Inaktiverad"
"Misslyckades"
"InProgress"
"Väntar"
"Lyckades"
"Okänd"
publicNetworkAccess Typ av åtkomst till offentligt nätverk. "Inaktiverad"
"Aktiverad"
replicationRegion Tillåten replikeringsregion "AustraliaEast"
"BrazilSouth"
"Standard"
"Ingen"
"Nordeurope"
"SouthAfricaNorth"
"Sydostasien"
"Usa, västra 2"
scaleUnit Hämtar eller anger scaleUnit där namnområdet skapas sträng
status Namnområdesstatus. "Skapad"
"Skapar"
"Tar bort"
"Pausad"
zoneRedundancy Namnområdes-SKU-namn. "Inaktiverad"
"Aktiverad"

NetworkAcls

Name Beskrivning Värde
ipRules Lista över IP-regler. IpRule[]
publicNetworkRule En standardregel för nätverksauktorisering (offentligt Internet) som innehåller rättigheter om ingen annan nätverksregel matchar. PublicInternetAuthorizationRule

IpRule

Name Beskrivning Värde
ipMask IP-mask. sträng (krävs)

Begränsningar:
Minsta längd = 1
Rättigheter Lista över åtkomsträttigheter. Strängmatris som innehåller något av:
"Lyssna"
"Hantera"
"Skicka" (krävs)

PublicInternetAuthorizationRule

Name Beskrivning Värde
Rättigheter Lista över åtkomsträttigheter. Strängmatris som innehåller något av:
"Lyssna"
"Hantera"
"Skicka" (krävs)

PnsCredentials

Name Beskrivning Värde
admCredential Beskrivning av en NotificationHub AdmCredential. AdmCredential
apnsCredential Beskrivning av en NotificationHub ApnsCredential. ApnsCredential
baiduCredential Beskrivning av en NotificationHub BaiduCredential. BaiduCredential
browserCredential Beskrivning av en NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Beskrivning av en NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beskrivning av en NotificationHub GcmCredential. GcmCredential
mpnsCredential Beskrivning av en NotificationHub MpnsCredential. MpnsCredential
wnsCredential Beskrivning av en NotificationHub WnsCredential. WnsCredential
xiaomiCredential Beskrivning av en NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub AdmCredential. AdmCredentialProperties (krävs)

AdmCredentialProperties

Name Beskrivning Värde
authTokenUrl Hämtar eller anger URL:en för auktoriseringstoken. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
ClientID Hämtar eller anger klientidentifieraren. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
clientSecret Hämtar eller anger autentiseringsuppgifternas hemliga åtkomstnyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

ApnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub ApnsCredential. ApnsCredentialProperties (krävs)

ApnsCredentialProperties

Name Beskrivning Värde
apnsCertificate Hämtar eller anger APNS-certifikatet. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
appId Hämtar eller anger den registrerade anspråksnyckeln för utfärdaren (iss), vars värde är
ditt team-ID på 10 tecken som hämtats från ditt utvecklarkonto		 sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
Appname Hämtar eller anger namnet på programmet sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
certificateKey Hämtar eller anger certifikatnyckeln. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
slutpunkt Hämtar eller anger slutpunkten för den här autentiseringsuppgiften. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
keyId Hämtar eller anger en nyckelidentifierare på 10 tecken (barn) som hämtas från
ditt utvecklarkonto		 sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
Stämpel Hämtar eller anger APNS-certifikatets tumavtryck sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
token Hämtar eller anger providerautentiseringstoken som hämtas via din
utvecklarkonto
 sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

BaiduCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub BaiduCredential. BaiduCredentialProperties (krävs)

BaiduCredentialProperties

Name Beskrivning Värde
baiduApiKey Hämtar eller anger baidu API-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
baiduEndPoint Hämtar eller anger baidu-slutpunkt. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
baiduSecretKey Hämtar eller anger baidu secret key sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

BrowserCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub BrowserCredential. BrowserCredentialProperties (krävs)

BrowserCredentialProperties

Name Beskrivning Värde
ämne Hämtar eller ställer in webb-push-ämne. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
vapidPrivateKey Hämtar eller anger en privat VAPID-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
vapidPublicKey Hämtar eller anger offentlig VAPID-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

FcmV1Credential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub FcmV1Credential. FcmV1CredentialProperties (krävs)

FcmV1CredentialProperties

Name Beskrivning Värde
clientEmail Hämtar eller anger klient-e-post. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
privateKey Hämtar eller anger privat nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
projectId Hämtar eller anger projekt-ID. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

GcmCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub GcmCredential. GcmCredentialProperties (krävs)

GcmCredentialProperties

Name Beskrivning Värde
gcmEndpoint Hämtar eller anger GCM-slutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
googleApiKey Hämtar eller anger Google API-nyckeln. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.

MpnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub MpnsCredential. MpnsCredentialProperties (krävs)

MpnsCredentialProperties

Name Beskrivning Värde
certificateKey Hämtar eller anger certifikatnyckeln för den här autentiseringsuppgiften. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka som en säker parameter.
mpnsCertificate Hämtar eller anger MPNS-certifikatet. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
Stämpel Hämtar eller anger MPNS-certifikatets tumavtryck sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

WnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub WnsCredential. WnsCredentialProperties (krävs)

WnsCredentialProperties

Name Beskrivning Värde
certificateKey Ge ut eller anger WNS-certifikatnyckeln. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
packageSid Hämtar eller anger paket-ID för den här autentiseringsuppgiften. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
secretKey Hämtar eller anger den hemliga nyckeln. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
windowsLiveEndpoint Hämtar eller anger Windows Live-slutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
wnsCertificate Hämtar eller anger WNS-certifikatet. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

XiaomiCredential

Name Beskrivning Värde
properties Beskrivning av NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (krävs)

XiaomiCredentialProperties

Name Beskrivning Värde
appSecret Hämtar eller anger apphemlighet. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
slutpunkt Hämtar eller anger xiaomi-tjänstslutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

Sku

Name Beskrivning Värde
capacity Hämtar eller anger resursens kapacitet int
familj Hämtar eller anger SKU-familjen sträng
name Namnområdes-SKU-namn. "Grundläggande"
"Kostnadsfri"
"Standard" (obligatoriskt)
ikoner Hämtar eller anger SKU-storleken sträng
nivå Hämtar eller anger nivån för en viss SKU sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa Azure Notification Hub

Distribuera till Azure		 Skapar en Azure Notification Hub, en mall som ursprungligen skapades av John Downs.
Etablera en mobilapp med en SQL Database

Distribuera till Azure		 Den här mallen etablerar en Mobilapp, SQL Database och Notification Hub. Den konfigurerar en anslutningssträng i mobilappen för databasen och meddelandehubben.

Resursdefinition för Terraform (AzAPI-provider)

Namnområdesresurstypen kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.NotificationHubs/namespaces-resurs lägger du till följande Terraform i mallen.

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"
    }
  })
}

Egenskapsvärden

Namnområden

Name Beskrivning Värde
typ Resurstypen "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
name Resursnamnet sträng (krävs)

Teckengräns: 6–50

Giltiga tecken:
Alfanumeriska tecken och bindestreck

Börja med bokstav. Avsluta med alfanumeriskt.

Resursnamnet måste vara unikt i Hela Azure.
location Den geo-plats där resursen finns sträng (krävs)
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden.
sku SKU-beskrivningen för ett namnområde SKU (krävs)
properties Representerar namnområdesegenskaper. NamespaceProperties

NamespaceProperties

Name Beskrivning Värde
Datacenter Inaktuellt. sträng
namespaceType Definierar värden för NamespaceType. "Meddelanden"
"NotificationHub"
networkAcls En samling regler för nätverksauktorisering. NetworkAcls
pnsCredentials Insamling av PNS-autentiseringsuppgifter för Notification Hub eller Notification Hub Namespace. PnsCredentials
provisioningState Definierar värden för OperationProvisioningState. "Avbruten"
"Inaktiverad"
"Misslyckades"
"InProgress"
"Väntar"
"Lyckades"
"Okänd"
publicNetworkAccess Typ av åtkomst till offentligt nätverk. "Inaktiverad"
"Aktiverad"
replicationRegion Tillåten replikeringsregion "AustralienEast"
"BrazilSouth"
"Standard"
"Ingen"
"Nordeurope"
"SouthAfricaNorth"
"Sydostasien"
"WestUs2"
scaleUnit Hämtar eller anger scaleUnit där namnområdet skapas sträng
status Namnområdesstatus. "Skapad"
"Skapar"
"Tar bort"
"Pausad"
zoneRedundancy Namnområdes-SKU-namn. "Inaktiverad"
"Aktiverad"

NetworkAcls

Name Beskrivning Värde
ipRules Lista över IP-regler. IpRule[]
publicNetworkRule En standardregel för nätverksauktorisering (offentligt Internet) som innehåller rättigheter om ingen annan nätverksregel matchar. PublicInternetAuthorizationRule

IpRule

Name Beskrivning Värde
ipMask IP-mask. sträng (krävs)

Begränsningar:
Minsta längd = 1
Rättigheter Lista över åtkomsträttigheter. Strängmatris som innehåller något av:
"Lyssna"
"Hantera"
"Skicka" (obligatoriskt)

PublicInternetAuthorizationRule

Name Beskrivning Värde
Rättigheter Lista över åtkomsträttigheter. Strängmatris som innehåller något av:
"Lyssna"
"Hantera"
"Skicka" (obligatoriskt)

PnsCredentials

Name Beskrivning Värde
admCredential Beskrivning av en NotificationHub AdmCredential. AdmCredential
apnsCredential Beskrivning av en NotificationHub ApnsCredential. ApnsCredential
baiduCredential Beskrivning av en NotificationHub BaiduCredential. BaiduCredential
browserCredential Beskrivning av en NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Beskrivning av en NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Beskrivning av en NotificationHub GcmCredential. GcmCredential
mpnsCredential Beskrivning av en NotificationHub MpnsCredential. MpnsCredential
wnsCredential Beskrivning av en NotificationHub WnsCredential. WnsCredential
xiaomiCredential Beskrivning av en NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub AdmCredential. AdmCredentialProperties (krävs)

AdmCredentialProperties

Name Beskrivning Värde
authTokenUrl Hämtar eller anger URL:en för auktoriseringstoken. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
ClientID Hämtar eller anger klientidentifieraren. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
clientSecret Hämtar eller anger åtkomstnyckeln för hemligheten för autentiseringsuppgifter. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

ApnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub ApnsCredential. ApnsCredentialProperties (krävs)

ApnsCredentialProperties

Name Beskrivning Värde
apnsCertificate Hämtar eller anger APNS-certifikatet. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
appId Hämtar eller anger den registrerade anspråksnyckeln för utfärdaren (iss), vars värde är
ditt team-ID på 10 tecken som hämtats från ditt utvecklarkonto		 sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
Appname Hämtar eller anger namnet på programmet sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
certificateKey Hämtar eller anger certifikatnyckeln. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
slutpunkt Hämtar eller anger slutpunkten för den här autentiseringsuppgiften. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
keyId Hämtar eller anger en nyckelidentifierare på 10 tecken (barn) som hämtas från
ditt utvecklarkonto		 sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
Stämpel Hämtar eller anger APNS-certifikatets tumavtryck sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
token Hämtar eller anger providerautentiseringstoken som hämtas via din
utvecklarkonto
 sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

BaiduCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub BaiduCredential. BaiduCredentialProperties (krävs)

BaiduCredentialProperties

Name Beskrivning Värde
baiduApiKey Hämtar eller anger baidu API-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
baiduEndPoint Hämtar eller anger baidu-slutpunkt. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
baiduSecretKey Hämtar eller anger baidu secret key sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

BrowserCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub BrowserCredential. BrowserCredentialProperties (krävs)

BrowserCredentialProperties

Name Beskrivning Värde
ämne Hämtar eller ställer in webb-push-ämne. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
vapidPrivateKey Hämtar eller anger en privat VAPID-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
vapidPublicKey Hämtar eller anger en offentlig VAPID-nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

FcmV1Credential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub FcmV1Credential. FcmV1CredentialProperties (krävs)

FcmV1CredentialProperties

Name Beskrivning Värde
clientEmail Hämtar eller anger klient-e-post. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
privateKey Hämtar eller anger privat nyckel. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
projectId Hämtar eller anger projekt-ID. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

GcmCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub GcmCredential. GcmCredentialProperties (krävs)

GcmCredentialProperties

Name Beskrivning Värde
gcmEndpoint Hämtar eller anger GCM-slutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
googleApiKey Hämtar eller anger Google API-nyckeln. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

MpnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub MpnsCredential. MpnsCredentialProperties (krävs)

MpnsCredentialProperties

Name Beskrivning Värde
certificateKey Hämtar eller anger certifikatnyckeln för den här autentiseringsuppgiften. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
mpnsCertificate Hämtar eller anger MPNS-certifikatet. sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.
Stämpel Hämtar eller anger MPNS-certifikatets tumavtryck sträng (krävs)

Begränsningar:
Minsta längd = 1
Känsligt värde. Skicka in som en säker parameter.

WnsCredential

Name Beskrivning Värde
properties Beskrivning av en NotificationHub WnsCredential. WnsCredentialProperties (krävs)

WnsCredentialProperties

Name Beskrivning Värde
certificateKey Ge ut eller anger WNS-certifikatnyckeln. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
packageSid Hämtar eller anger paket-ID för den här autentiseringsuppgiften. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
secretKey Hämtar eller anger den hemliga nyckeln. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
windowsLiveEndpoint Hämtar eller anger Windows Live-slutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
wnsCertificate Hämtar eller anger WNS-certifikatet. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

XiaomiCredential

Name Beskrivning Värde
properties Beskrivning av NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (krävs)

XiaomiCredentialProperties

Name Beskrivning Värde
appSecret Hämtar eller anger apphemlighet. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
slutpunkt Hämtar eller anger xiaomi-tjänstslutpunkten. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.

Sku

Name Beskrivning Värde
capacity Hämtar eller anger resursens kapacitet int
familj Hämtar eller anger SKU-familjen sträng
name Namnområdes-SKU-namn. "Grundläggande"
"Kostnadsfri"
"Standard" (obligatoriskt)
ikoner Hämtar eller anger SKU-storleken sträng
nivå Hämtar eller anger nivån för en viss SKU sträng