Sdílet prostřednictvím

Obory názvů Microsoft.NotificationHubs

Definice prostředku Bicep

Typ prostředku oborů názvů je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.NotificationHubs/namespaces, přidejte do šablony následující bicep.

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

Hodnoty vlastností

Microsoft.NotificationHubs/namespaces

Jméno Popis Hodnota
poloha Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 50
Model = ^[a-zA-Z][a-zA-Z0-9-]*$ (povinné)
vlastnosti Představuje vlastnosti oboru názvů. oboru názvů properties
SKU (identifikátor zboží) Popis skladové položky pro obor názvů skladové položky (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

AdmCredential – Přihlašovací údaje

Jméno Popis Hodnota
vlastnosti Popis admCredential NotificationHubu AdmCredentialProperties (povinné)

AdmCredentialProperties

Jméno Popis Hodnota
authTokenUrl Získá nebo nastaví adresu URL autorizačního tokenu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID klienta Získá nebo nastaví identifikátor klienta. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
klientské heslo Získá nebo nastaví přístupový klíč k tajným klíčům přihlašovacích údajů. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

ApnsCredential

Jméno Popis Hodnota
vlastnosti Popis ApnsCredential NotificationHubu ApnsCredentialProperties (povinné)

ApnsCredentialProperties

Jméno Popis Hodnota
Certifikát apns Získá nebo nastaví certifikát APNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
ID aplikace Získá nebo nastaví zaregistrovaný klíč deklarace identity vystavitele (iss), jehož hodnota je
10místné ID týmu získané z vašeho vývojářského účtu		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
název aplikace Získá nebo nastaví název aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
klíč certifikátu Získá nebo nastaví klíč certifikátu. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
koncový bod Získá nebo nastaví koncový bod tohoto pověření. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID klíče Získá nebo nastaví 10mísíčkový identifikátor klíče (dětský) klíč získaný z
váš vývojářský účet		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
kryptografický otisk Získá nebo nastaví kryptografický otisk certifikátu APNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
token Získá nebo nastaví ověřovací token zprostředkovatele získaný prostřednictvím vašeho
vývojářský účet		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

BaiduCredential – funkce BaiduCredential

Jméno Popis Hodnota
vlastnosti Popis NotificationHub BaiduCredential. BaiduCredentialProperties (povinné)

BaiduCredentialProperties

Jméno Popis Hodnota
baiduApiKey Získá nebo nastaví baidu Api Key. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
baiduEndPoint Získá nebo nastaví koncový bod baidu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
baiduSecretKey Získá nebo nastaví tajný klíč baidu řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Přihlašovací údaje prohlížeče

Jméno Popis Hodnota
vlastnosti Popis NotificationHub BrowserCredential. BrowserCredentialProperties (povinné)

Vlastnosti BrowserCredentialProperties

Jméno Popis Hodnota
předmět Získá nebo nastaví předmět webového nabízení. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
vapidPrivateKey Získá nebo nastaví privátní klíč VAPID. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
vapidPublicKey Získá nebo nastaví veřejný klíč VAPID. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

FcmV1Credential (FcmV1Credential)

Jméno Popis Hodnota
vlastnosti Popis NotificationHub FcmV1Credential. FcmV1CredentialProperties (povinné)

FcmV1CredentialProperties

Jméno Popis Hodnota
klientEmail Získá nebo nastaví e-mail klienta. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
soukromý klíč Získá nebo nastaví privátní klíč. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID projektu Získá nebo nastaví ID projektu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

GcmCredential – parametry

Jméno Popis Hodnota
vlastnosti Popis objektu NotificationHub GcmCredential GcmCredentialProperties (povinné)

GcmCredentialProperties

Jméno Popis Hodnota
gcmEndpoint Získá nebo nastaví koncový bod GCM. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
googleApiKey Získá nebo nastaví klíč rozhraní Google API. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Pravidlo protokolu IpRule

Jméno Popis Hodnota
ipMask Maska IP. řetězec

Omezení:
Minimální délka = 1 (povinné)
práva Seznam přístupových práv Řetězcové pole obsahující některou z těchto možností:
Poslouchejte
Spravovat
Odeslat (povinné)

MpnsCredential

Jméno Popis Hodnota
vlastnosti Popis souboru MpnsCredential NotificationHub MpnsCredentialProperties (povinné)

MpnsCredentialProperties

Jméno Popis Hodnota
klíč certifikátu Získá nebo nastaví klíč certifikátu pro tyto přihlašovací údaje. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
Certifikát mpns Získá nebo nastaví certifikát MPNS. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
kryptografický otisk Získá nebo nastaví kryptografický otisk certifikátu MPNS. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Obor názvůProperties

Jméno Popis Hodnota
datové centrum Zavrhovaný. řetězec
Typ jmenného prostoru Definuje hodnoty pro NamespaceType. Zasílání zpráv
NotificationHub
networkAcls Kolekce pravidel autorizace sítě. NetworkAcls
pnsCredentials Kolekce přihlašovacích údajů PNS centra oznámení nebo centra oznámení. PnsCredentials
stav přípravy Definuje hodnoty pro OperationProvisioningState. Zrušeno
Zakázáno
Chyba
InProgress
Čeká na vyřízení
Úspěch
Neznámý
přístup k veřejné síti Typ přístupu k veřejné síti Zakázáno
Povoleno
replicationRegion Povolená oblast replikace "Východ Austrálie"
"BrazílieSouth"
Výchozí
None (Žádný)
"NorthEurope"
SouthAfricaNorth
SouthEastAsia
WestUs2
scaleUnit Získá nebo nastaví scaleUnit, kde se obor názvů vytvoří. řetězec
stav Stav oboru názvů Vytvořeno
Vytváření
Odstranění
"Pozastaveno"
ZónaRedundance Název skladové položky oboru názvů Zakázáno
Povoleno

Seznamy NetworkAcls

Jméno Popis Hodnota
IpRules Seznam pravidel PROTOKOLU IP iprule[]
Pravidlo veřejné sítě Výchozí (veřejné internetové) pravidlo autorizace sítě, které obsahuje práva, pokud žádné jiné pravidlo sítě neodpovídá. PublicInternetAuthorizationRule

PnsCredentials

Jméno Popis Hodnota
admCredential Popis admCredential NotificationHubu AdmCredential
apnsCredential (Přihlašovací údaje) Popis ApnsCredential NotificationHubu ApnsCredential
baiduCredential Popis NotificationHub BaiduCredential. BaiduCredential – funkce BaiduCredential
přihlašovací údaje prohlížeče Popis NotificationHub BrowserCredential. Přihlašovací údaje prohlížeče
fcmV1Credential Popis NotificationHub FcmV1Credential. FcmV1Credential (FcmV1Credential)
gcmCredential Popis objektu NotificationHub GcmCredential GcmCredential
mpnsCredential (Přihlašovací údaje) Popis souboru MpnsCredential NotificationHub mpnsCredential
wnsCredential (Přihlašovací údaje) Popis notificationHub WnsCredential. WnsCredential – Přihlašovací údaje
xiaomiCredential Popis NotificationHub XiaomiCredential. XiaomiCredential

Pravidlo veřejné internetové autorizace

Jméno Popis Hodnota
práva Seznam přístupových práv Řetězcové pole obsahující některou z těchto možností:
Poslouchejte
Spravovat
Odeslat (povinné)

Sku

Jméno Popis Hodnota
kapacita Získá nebo nastaví kapacitu prostředku. Int
Rodina Získá nebo nastaví SKU Family řetězec
Jméno Název skladové položky oboru názvů "Základní"
"Zdarma"
Standard (povinné)
velikost Získá nebo nastaví velikost skladové položky. řetězec
přesunout do jiné vrstvy Získá nebo nastaví úroveň konkrétní skladové položky. řetězec

TrackedResourceTags

Jméno Popis Hodnota

WnsCredential – Přihlašovací údaje

Jméno Popis Hodnota
vlastnosti Popis notificationHub WnsCredential. WnsCredentialProperties (povinné)

WnsCredentialProperties

Jméno Popis Hodnota
klíč certifikátu Ges nebo nastaví klíč certifikátu WNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
packageSid Získá nebo nastaví ID balíčku pro tyto přihlašovací údaje. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
tajný klíč Získá nebo nastaví tajný klíč. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
windowsLiveEndpoint Získá nebo nastaví koncový bod Windows Live. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
wnsCertifikát Získá nebo nastaví certifikát WNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

XiaomiCredential

Jméno Popis Hodnota
vlastnosti Popis NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (povinné)

XiaomiCredentialProperties

Jméno Popis Hodnota
tajný kód aplikace Získá nebo nastaví tajný kód aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
koncový bod Získá nebo nastaví koncový bod služby xiaomi. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

Příklady použití

Ukázky Bicep

Základní příklad nasazení oboru názvů centra oznámení.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource namespace 'Microsoft.NotificationHubs/namespaces@2017-04-01' = {
  name: resourceName
  location: location
  properties: {
    enabled: true
    namespaceType: 'NotificationHub'
    region: 'westeurope'
  }
  sku: {
    name: 'Free'
  }
}

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
vytvoření centra oznámení Azure Vytvoří centrum oznámení Azure, původně autor šablony John Downs.

Definice prostředku šablony ARM

Typ prostředku oborů názvů je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.NotificationHubs/namespaces, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Microsoft.NotificationHubs/namespaces

Jméno Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API 2023-10-01-preview
poloha Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 50
Model = ^[a-zA-Z][a-zA-Z0-9-]*$ (povinné)
vlastnosti Představuje vlastnosti oboru názvů. oboru názvů properties
SKU (identifikátor zboží) Popis skladové položky pro obor názvů skladové položky (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.NotificationHubs/namespaces

AdmCredential – Přihlašovací údaje

Jméno Popis Hodnota
vlastnosti Popis admCredential NotificationHubu AdmCredentialProperties (povinné)

AdmCredentialProperties

Jméno Popis Hodnota
authTokenUrl Získá nebo nastaví adresu URL autorizačního tokenu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID klienta Získá nebo nastaví identifikátor klienta. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
klientské heslo Získá nebo nastaví přístupový klíč k tajným klíčům přihlašovacích údajů. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

ApnsCredential

Jméno Popis Hodnota
vlastnosti Popis ApnsCredential NotificationHubu ApnsCredentialProperties (povinné)

ApnsCredentialProperties

Jméno Popis Hodnota
Certifikát apns Získá nebo nastaví certifikát APNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
ID aplikace Získá nebo nastaví zaregistrovaný klíč deklarace identity vystavitele (iss), jehož hodnota je
10místné ID týmu získané z vašeho vývojářského účtu		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
název aplikace Získá nebo nastaví název aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
klíč certifikátu Získá nebo nastaví klíč certifikátu. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
koncový bod Získá nebo nastaví koncový bod tohoto pověření. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID klíče Získá nebo nastaví 10mísíčkový identifikátor klíče (dětský) klíč získaný z
váš vývojářský účet		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
kryptografický otisk Získá nebo nastaví kryptografický otisk certifikátu APNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
token Získá nebo nastaví ověřovací token zprostředkovatele získaný prostřednictvím vašeho
vývojářský účet		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

BaiduCredential – funkce BaiduCredential

Jméno Popis Hodnota
vlastnosti Popis NotificationHub BaiduCredential. BaiduCredentialProperties (povinné)

BaiduCredentialProperties

Jméno Popis Hodnota
baiduApiKey Získá nebo nastaví baidu Api Key. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
baiduEndPoint Získá nebo nastaví koncový bod baidu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
baiduSecretKey Získá nebo nastaví tajný klíč baidu řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Přihlašovací údaje prohlížeče

Jméno Popis Hodnota
vlastnosti Popis NotificationHub BrowserCredential. BrowserCredentialProperties (povinné)

Vlastnosti BrowserCredentialProperties

Jméno Popis Hodnota
předmět Získá nebo nastaví předmět webového nabízení. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
vapidPrivateKey Získá nebo nastaví privátní klíč VAPID. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
vapidPublicKey Získá nebo nastaví veřejný klíč VAPID. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

FcmV1Credential (FcmV1Credential)

Jméno Popis Hodnota
vlastnosti Popis NotificationHub FcmV1Credential. FcmV1CredentialProperties (povinné)

FcmV1CredentialProperties

Jméno Popis Hodnota
klientEmail Získá nebo nastaví e-mail klienta. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
soukromý klíč Získá nebo nastaví privátní klíč. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID projektu Získá nebo nastaví ID projektu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

GcmCredential – parametry

Jméno Popis Hodnota
vlastnosti Popis objektu NotificationHub GcmCredential GcmCredentialProperties (povinné)

GcmCredentialProperties

Jméno Popis Hodnota
gcmEndpoint Získá nebo nastaví koncový bod GCM. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
googleApiKey Získá nebo nastaví klíč rozhraní Google API. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Pravidlo protokolu IpRule

Jméno Popis Hodnota
ipMask Maska IP. řetězec

Omezení:
Minimální délka = 1 (povinné)
práva Seznam přístupových práv Řetězcové pole obsahující některou z těchto možností:
Poslouchejte
Spravovat
Odeslat (povinné)

MpnsCredential

Jméno Popis Hodnota
vlastnosti Popis souboru MpnsCredential NotificationHub MpnsCredentialProperties (povinné)

MpnsCredentialProperties

Jméno Popis Hodnota
klíč certifikátu Získá nebo nastaví klíč certifikátu pro tyto přihlašovací údaje. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
Certifikát mpns Získá nebo nastaví certifikát MPNS. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
kryptografický otisk Získá nebo nastaví kryptografický otisk certifikátu MPNS. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Obor názvůProperties

Jméno Popis Hodnota
datové centrum Zavrhovaný. řetězec
Typ jmenného prostoru Definuje hodnoty pro NamespaceType. Zasílání zpráv
NotificationHub
networkAcls Kolekce pravidel autorizace sítě. NetworkAcls
pnsCredentials Kolekce přihlašovacích údajů PNS centra oznámení nebo centra oznámení. PnsCredentials
stav přípravy Definuje hodnoty pro OperationProvisioningState. Zrušeno
Zakázáno
Chyba
InProgress
Čeká na vyřízení
Úspěch
Neznámý
přístup k veřejné síti Typ přístupu k veřejné síti Zakázáno
Povoleno
replicationRegion Povolená oblast replikace "Východ Austrálie"
"BrazílieSouth"
Výchozí
None (Žádný)
"NorthEurope"
SouthAfricaNorth
SouthEastAsia
WestUs2
scaleUnit Získá nebo nastaví scaleUnit, kde se obor názvů vytvoří. řetězec
stav Stav oboru názvů Vytvořeno
Vytváření
Odstranění
"Pozastaveno"
ZónaRedundance Název skladové položky oboru názvů Zakázáno
Povoleno

Seznamy NetworkAcls

Jméno Popis Hodnota
IpRules Seznam pravidel PROTOKOLU IP iprule[]
Pravidlo veřejné sítě Výchozí (veřejné internetové) pravidlo autorizace sítě, které obsahuje práva, pokud žádné jiné pravidlo sítě neodpovídá. PublicInternetAuthorizationRule

PnsCredentials

Jméno Popis Hodnota
admCredential Popis admCredential NotificationHubu AdmCredential
apnsCredential (Přihlašovací údaje) Popis ApnsCredential NotificationHubu ApnsCredential
baiduCredential Popis NotificationHub BaiduCredential. BaiduCredential – funkce BaiduCredential
přihlašovací údaje prohlížeče Popis NotificationHub BrowserCredential. Přihlašovací údaje prohlížeče
fcmV1Credential Popis NotificationHub FcmV1Credential. FcmV1Credential (FcmV1Credential)
gcmCredential Popis objektu NotificationHub GcmCredential GcmCredential
mpnsCredential (Přihlašovací údaje) Popis souboru MpnsCredential NotificationHub mpnsCredential
wnsCredential (Přihlašovací údaje) Popis notificationHub WnsCredential. WnsCredential – Přihlašovací údaje
xiaomiCredential Popis NotificationHub XiaomiCredential. XiaomiCredential

Pravidlo veřejné internetové autorizace

Jméno Popis Hodnota
práva Seznam přístupových práv Řetězcové pole obsahující některou z těchto možností:
Poslouchejte
Spravovat
Odeslat (povinné)

Sku

Jméno Popis Hodnota
kapacita Získá nebo nastaví kapacitu prostředku. Int
Rodina Získá nebo nastaví SKU Family řetězec
Jméno Název skladové položky oboru názvů "Základní"
"Zdarma"
Standard (povinné)
velikost Získá nebo nastaví velikost skladové položky. řetězec
přesunout do jiné vrstvy Získá nebo nastaví úroveň konkrétní skladové položky. řetězec

TrackedResourceTags

Jméno Popis Hodnota

WnsCredential – Přihlašovací údaje

Jméno Popis Hodnota
vlastnosti Popis notificationHub WnsCredential. WnsCredentialProperties (povinné)

WnsCredentialProperties

Jméno Popis Hodnota
klíč certifikátu Ges nebo nastaví klíč certifikátu WNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
packageSid Získá nebo nastaví ID balíčku pro tyto přihlašovací údaje. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
tajný klíč Získá nebo nastaví tajný klíč. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
windowsLiveEndpoint Získá nebo nastaví koncový bod Windows Live. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
wnsCertifikát Získá nebo nastaví certifikát WNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

XiaomiCredential

Jméno Popis Hodnota
vlastnosti Popis NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (povinné)

XiaomiCredentialProperties

Jméno Popis Hodnota
tajný kód aplikace Získá nebo nastaví tajný kód aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
koncový bod Získá nebo nastaví koncový bod služby xiaomi. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
vytvoření centra oznámení Azure

nasazení do Azure		 Vytvoří centrum oznámení Azure, původně autor šablony John Downs.
zřízení mobilní aplikace pomocí služby SQL Database

nasazení do Azure		 Tato šablona zřídí mobilní aplikaci, službu SQL Database a centrum oznámení. Nakonfiguruje připojovací řetězec v mobilní aplikaci pro databázi a centrum oznámení.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku oborů názvů je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.NotificationHubs/namespaces, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Hodnoty vlastností

Microsoft.NotificationHubs/namespaces

Jméno Popis Hodnota
poloha Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 50
Model = ^[a-zA-Z][a-zA-Z0-9-]*$ (povinné)
vlastnosti Představuje vlastnosti oboru názvů. oboru názvů properties
SKU (identifikátor zboží) Popis skladové položky pro obor názvů skladové položky (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.NotificationHubs/namespaces@2023-10-01-preview

AdmCredential – Přihlašovací údaje

Jméno Popis Hodnota
vlastnosti Popis admCredential NotificationHubu AdmCredentialProperties (povinné)

AdmCredentialProperties

Jméno Popis Hodnota
authTokenUrl Získá nebo nastaví adresu URL autorizačního tokenu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID klienta Získá nebo nastaví identifikátor klienta. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
klientské heslo Získá nebo nastaví přístupový klíč k tajným klíčům přihlašovacích údajů. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

ApnsCredential

Jméno Popis Hodnota
vlastnosti Popis ApnsCredential NotificationHubu ApnsCredentialProperties (povinné)

ApnsCredentialProperties

Jméno Popis Hodnota
Certifikát apns Získá nebo nastaví certifikát APNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
ID aplikace Získá nebo nastaví zaregistrovaný klíč deklarace identity vystavitele (iss), jehož hodnota je
10místné ID týmu získané z vašeho vývojářského účtu		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
název aplikace Získá nebo nastaví název aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
klíč certifikátu Získá nebo nastaví klíč certifikátu. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
koncový bod Získá nebo nastaví koncový bod tohoto pověření. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID klíče Získá nebo nastaví 10mísíčkový identifikátor klíče (dětský) klíč získaný z
váš vývojářský účet		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
kryptografický otisk Získá nebo nastaví kryptografický otisk certifikátu APNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
token Získá nebo nastaví ověřovací token zprostředkovatele získaný prostřednictvím vašeho
vývojářský účet		 řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

BaiduCredential – funkce BaiduCredential

Jméno Popis Hodnota
vlastnosti Popis NotificationHub BaiduCredential. BaiduCredentialProperties (povinné)

BaiduCredentialProperties

Jméno Popis Hodnota
baiduApiKey Získá nebo nastaví baidu Api Key. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
baiduEndPoint Získá nebo nastaví koncový bod baidu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
baiduSecretKey Získá nebo nastaví tajný klíč baidu řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Přihlašovací údaje prohlížeče

Jméno Popis Hodnota
vlastnosti Popis NotificationHub BrowserCredential. BrowserCredentialProperties (povinné)

Vlastnosti BrowserCredentialProperties

Jméno Popis Hodnota
předmět Získá nebo nastaví předmět webového nabízení. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
vapidPrivateKey Získá nebo nastaví privátní klíč VAPID. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
vapidPublicKey Získá nebo nastaví veřejný klíč VAPID. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

FcmV1Credential (FcmV1Credential)

Jméno Popis Hodnota
vlastnosti Popis NotificationHub FcmV1Credential. FcmV1CredentialProperties (povinné)

FcmV1CredentialProperties

Jméno Popis Hodnota
klientEmail Získá nebo nastaví e-mail klienta. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
soukromý klíč Získá nebo nastaví privátní klíč. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
ID projektu Získá nebo nastaví ID projektu. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

GcmCredential – parametry

Jméno Popis Hodnota
vlastnosti Popis objektu NotificationHub GcmCredential GcmCredentialProperties (povinné)

GcmCredentialProperties

Jméno Popis Hodnota
gcmEndpoint Získá nebo nastaví koncový bod GCM. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
googleApiKey Získá nebo nastaví klíč rozhraní Google API. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Pravidlo protokolu IpRule

Jméno Popis Hodnota
ipMask Maska IP. řetězec

Omezení:
Minimální délka = 1 (povinné)
práva Seznam přístupových práv Řetězcové pole obsahující některou z těchto možností:
Poslouchejte
Spravovat
Odeslat (povinné)

MpnsCredential

Jméno Popis Hodnota
vlastnosti Popis souboru MpnsCredential NotificationHub MpnsCredentialProperties (povinné)

MpnsCredentialProperties

Jméno Popis Hodnota
klíč certifikátu Získá nebo nastaví klíč certifikátu pro tyto přihlašovací údaje. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
Certifikát mpns Získá nebo nastaví certifikát MPNS. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)
kryptografický otisk Získá nebo nastaví kryptografický otisk certifikátu MPNS. řetězec

Omezení:
Minimální délka = 1
Citlivá hodnota. Předejte ho jako zabezpečený parametr. (povinné)

Obor názvůProperties

Jméno Popis Hodnota
datové centrum Zavrhovaný. řetězec
Typ jmenného prostoru Definuje hodnoty pro NamespaceType. Zasílání zpráv
NotificationHub
networkAcls Kolekce pravidel autorizace sítě. NetworkAcls
pnsCredentials Kolekce přihlašovacích údajů PNS centra oznámení nebo centra oznámení. PnsCredentials
stav přípravy Definuje hodnoty pro OperationProvisioningState. Zrušeno
Zakázáno
Chyba
InProgress
Čeká na vyřízení
Úspěch
Neznámý
přístup k veřejné síti Typ přístupu k veřejné síti Zakázáno
Povoleno
replicationRegion Povolená oblast replikace "Východ Austrálie"
"BrazílieSouth"
Výchozí
None (Žádný)
"NorthEurope"
SouthAfricaNorth
SouthEastAsia
WestUs2
scaleUnit Získá nebo nastaví scaleUnit, kde se obor názvů vytvoří. řetězec
stav Stav oboru názvů Vytvořeno
Vytváření
Odstranění
"Pozastaveno"
ZónaRedundance Název skladové položky oboru názvů Zakázáno
Povoleno

Seznamy NetworkAcls

Jméno Popis Hodnota
IpRules Seznam pravidel PROTOKOLU IP iprule[]
Pravidlo veřejné sítě Výchozí (veřejné internetové) pravidlo autorizace sítě, které obsahuje práva, pokud žádné jiné pravidlo sítě neodpovídá. PublicInternetAuthorizationRule

PnsCredentials

Jméno Popis Hodnota
admCredential Popis admCredential NotificationHubu AdmCredential
apnsCredential (Přihlašovací údaje) Popis ApnsCredential NotificationHubu ApnsCredential
baiduCredential Popis NotificationHub BaiduCredential. BaiduCredential – funkce BaiduCredential
přihlašovací údaje prohlížeče Popis NotificationHub BrowserCredential. Přihlašovací údaje prohlížeče
fcmV1Credential Popis NotificationHub FcmV1Credential. FcmV1Credential (FcmV1Credential)
gcmCredential Popis objektu NotificationHub GcmCredential GcmCredential
mpnsCredential (Přihlašovací údaje) Popis souboru MpnsCredential NotificationHub mpnsCredential
wnsCredential (Přihlašovací údaje) Popis notificationHub WnsCredential. WnsCredential – Přihlašovací údaje
xiaomiCredential Popis NotificationHub XiaomiCredential. XiaomiCredential

Pravidlo veřejné internetové autorizace

Jméno Popis Hodnota
práva Seznam přístupových práv Řetězcové pole obsahující některou z těchto možností:
Poslouchejte
Spravovat
Odeslat (povinné)

Sku

Jméno Popis Hodnota
kapacita Získá nebo nastaví kapacitu prostředku. Int
Rodina Získá nebo nastaví SKU Family řetězec
Jméno Název skladové položky oboru názvů "Základní"
"Zdarma"
Standard (povinné)
velikost Získá nebo nastaví velikost skladové položky. řetězec
přesunout do jiné vrstvy Získá nebo nastaví úroveň konkrétní skladové položky. řetězec

TrackedResourceTags

Jméno Popis Hodnota

WnsCredential – Přihlašovací údaje

Jméno Popis Hodnota
vlastnosti Popis notificationHub WnsCredential. WnsCredentialProperties (povinné)

WnsCredentialProperties

Jméno Popis Hodnota
klíč certifikátu Ges nebo nastaví klíč certifikátu WNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
packageSid Získá nebo nastaví ID balíčku pro tyto přihlašovací údaje. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
tajný klíč Získá nebo nastaví tajný klíč. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
windowsLiveEndpoint Získá nebo nastaví koncový bod Windows Live. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
wnsCertifikát Získá nebo nastaví certifikát WNS. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

XiaomiCredential

Jméno Popis Hodnota
vlastnosti Popis NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (povinné)

XiaomiCredentialProperties

Jméno Popis Hodnota
tajný kód aplikace Získá nebo nastaví tajný kód aplikace. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
koncový bod Získá nebo nastaví koncový bod služby xiaomi. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.

Příklady použití

Ukázky Terraformu

Základní příklad nasazení oboru názvů centra oznámení.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.NotificationHubs/namespaces@2017-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      enabled       = true
      namespaceType = "NotificationHub"
      region        = "westeurope"
    }
    sku = {
      name = "Free"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on