Пространства имен Microsoft.NotificationHubs

Определение ресурсов Bicep

Тип ресурса пространств имен можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.NotificationHubs/namespaces, добавьте следующий 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'
  }
}

Значения свойств

Справочник по шаблонам пространства имен Microsoft.NotificationHubs.

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 50
Pattern = ^[a-zA-Z][a-zA-Z0-9-]*$ (обязательно)
свойства Представляет свойства пространства имен. NamespaceProperties
SKU Описание SKU для пространства имен Sku (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

Аккредитация AdmCredential

Имя Описание Ценность
свойства Описание AdmCredential в NotificationHub. AdmCredentialProperties (обязательно)

AdmCredentialProperties

Имя Описание Ценность
authTokenUrl Возвращает или задает URL-адрес маркера авторизации. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
clientId Возвращает или задает идентификатор клиента. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
клиентский секрет Возвращает или задает ключ доступа к секрету учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

ApnsCredential (Учетные данные)

Имя Описание Ценность
свойства Описание a NotificationHub ApnsCredential. ApnsCredentialProperties (обязательно)

ApnsCredentialProperties (Свойства учетных данных)

Имя Описание Ценность
apnsСертификат Возвращает или задает сертификат APNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
appId (идентификатор приложения) Возвращает или задает зарегистрированный ключ утверждения издателя (iss), значение которого равно
10-символьный идентификатор команды, полученный из учетной записи разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
appName Возвращает или задает имя приложения струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
сертификатКлюч Возвращает или задает ключ сертификата. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
конечная точка Возвращает или задает конечную точку этих учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
keyId Возвращает или задает 10-символьный идентификатор ключа (kid), полученный из
учетная запись разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
Отпечаток Возвращает или задает отпечаток сертификата APNS струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
жетон Возвращает или задает маркер проверки подлинности поставщика, полученный через ваш
Учетная запись разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

BaiduУчетные данные

Имя Описание Ценность
свойства Описание элемента NotificationHub BaiduCredential. BaiduCredentialProperties (обязательно)

Свойства BaiduCredentialProperties

Имя Описание Ценность
baiduApiKey Возвращает или задает ключ API baidu. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
baiduEndPoint Возвращает или задает конечную точку baidu. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
baiduSecretKey Возвращает или задает секретный ключ baidu струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

BrowserCredential (Учетные данные)

Имя Описание Ценность
свойства Описание browserCredential в NotificationHub. BrowserCredentialProperties (обязательно)

Свойства браузераCredentialProperties

Имя Описание Ценность
Тема Возвращает или задает тему веб-push-отправки. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
vapidPrivateKey Возвращает или задает закрытый ключ VAPID. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
vapidPublicKey Возвращает или задает открытый ключ VAPID. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

FcmV1Учетные данные

Имя Описание Ценность
свойства Описание уведомления FcmV1Credential. FcmV1CredentialProperties (обязательно)

FcmV1CredentialProperties

Имя Описание Ценность
клиентЭлектронная почта Возвращает или задает адрес электронной почты клиента. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
закрытый ключ Возвращает или задает закрытый ключ. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
projectId Возвращает или задает идентификатор проекта. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

Полномочия GcmCredential

Имя Описание Ценность
свойства Описание объекта NotificationHub GcmCredential. GcmCredentialProperties (обязательно)

GcmCredentialProperties

Имя Описание Ценность
Конечная точка gcmEndpoint Возвращает или задает конечную точку GCM. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
googleApiKey Возвращает или задает ключ API Google. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

Правило IpRule

Имя Описание Ценность
Маска ipMask Маска IP-адресов. струна

Ограничения целостности:
Минимальная длина = 1 (обязательно)
права Список прав доступа. Массив строк, содержащий любой из:
"Прослушивание"
"Управление"
"Отправить" (обязательно)

MpnsCredential

Имя Описание Ценность
свойства Описание элемента NotificationHub MpnsCredential. MpnsCredentialProperties (обязательно)

Свойства MpnsCredentialProperties

Имя Описание Ценность
сертификатКлюч Возвращает или задает ключ сертификата для этих учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
mpnsСертификат Возвращает или задает сертификат MPNS. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
Отпечаток Возвращает или задает отпечаток сертификата MPNS струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

NamespaceProperties

Имя Описание Ценность
DataCenter Устаревшие. струна
namespaceType Определяет значения для NamespaceType. "Обмен сообщениями"
NotificationHub
networkAcls Коллекция правил авторизации сети. NetworkAcls
pnsCredentials Коллекция учетных данных PNS центра уведомлений или пространства имен концентратора уведомлений. PnsCredentials
Состояние обеспечения Определяет значения для OperationProvisioningState. "Отменено"
"Отключено"
"Не удалось"
«В процессе»
"Ожидание"
"Успешно"
"Неизвестно"
доступ к публичной сети Тип доступа к общедоступной сети. "Отключено"
"Включено"
replicationRegion Разрешенная область репликации "АвстралияEast"
"БразилияСут"
По умолчанию
"Нет"
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
Единица измерения scaleUnit Возвращает или задает scaleUnit, в котором создается пространство имен. струна
статус Состояние пространства имен. "Создано"
Создание
Удаление
"Приостановлено"
zoneRedundancy Имя SKU пространства имен. "Отключено"
"Включено"

NetworkAcls

Имя Описание Ценность
ipRules Список правил IP-адресов. Правило IpRule[]
publicNetworkRule Правило авторизации сети по умолчанию (общедоступная сеть Интернет), содержащее права, если другое сетевое правило не совпадает. Правило авторизации в PublicInternetAuthority

PnsCredentials

Имя Описание Ценность
admCredential Описание AdmCredential в NotificationHub. Аккредитация AdmCredential
apnsCredential Описание a NotificationHub ApnsCredential. ApnsCredential (Учетные данные)
baiduCredential Описание элемента NotificationHub BaiduCredential. BaiduУчетные данные
browserCredential Описание browserCredential в NotificationHub. BrowserCredential (Учетные данные)
fcmV1Учетные данные Описание уведомления FcmV1Credential. FcmV1Учетные данные
gcmУчетные данные Описание объекта NotificationHub GcmCredential. Полномочия GcmCredential
mpnsCredential Описание элемента NotificationHub MpnsCredential. MpnsCredential
wnsCredential Описание WnsCredential в NotificationHub. Учетные данные WnsCredential
xiaomiCredential Описание Приложения NotificationHub XiaomiCredential. XiaomiУчетные данные

Правило авторизации в PublicInternetAuthority

Имя Описание Ценность
права Список прав доступа. Массив строк, содержащий любой из:
"Прослушивание"
"Управление"
"Отправить" (обязательно)

Артикул

Имя Описание Ценность
способность Возвращает или задает емкость ресурса инт
семья Возвращает или задает семейство SKU струна
имя Имя SKU пространства имен. "Базовый"
"Бесплатный"
"Стандартный" (обязательный)
размер Возвращает или задает размер SKU струна
ярус Возвращает или задает уровень определенного номера SKU струна

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Учетные данные WnsCredential

Имя Описание Ценность
свойства Описание WnsCredential в NotificationHub. WnsCredentialProperties (обязательно)

WnsCredentialProperties

Имя Описание Ценность
сертификатКлюч Ges или задает ключ сертификата WNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
пакетSid Возвращает или задает идентификатор пакета для этих учетных данных. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
secretKey Возвращает или задает секретный ключ. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
Конечная точка windowsLiveEndpoint Возвращает или задает конечную точку Windows Live. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
wnsСертификат Возвращает или задает сертификат WNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

XiaomiУчетные данные

Имя Описание Ценность
свойства Описание NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (обязательно)

XiaomiCredentialProperties

Имя Описание Ценность
appSecret Возвращает или задает секрет приложения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
конечная точка Возвращает или задает конечную точку службы Xiaomi. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

Примеры использования

Примеры Bicep

Простой пример развертывания пространства имен концентратора уведомлений.

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

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
создание центра уведомлений Azure Создает Центр уведомлений Azure, шаблон, изначально созданный Джоном Дауном.

Определение ресурса шаблона ARM

Тип ресурса пространств имен можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.NotificationHubs/namespaces, добавьте следующий код 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"
  }
}

Значения свойств

Справочник по шаблонам пространства имен Microsoft.NotificationHubs.

Имя Описание Ценность
apiVersion Версия API «2023-10-01-превью»
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 50
Pattern = ^[a-zA-Z][a-zA-Z0-9-]*$ (обязательно)
свойства Представляет свойства пространства имен. NamespaceProperties
SKU Описание SKU для пространства имен Sku (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.NotificationHubs/namespaces"

Аккредитация AdmCredential

Имя Описание Ценность
свойства Описание AdmCredential в NotificationHub. AdmCredentialProperties (обязательно)

AdmCredentialProperties

Имя Описание Ценность
authTokenUrl Возвращает или задает URL-адрес маркера авторизации. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
clientId Возвращает или задает идентификатор клиента. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
клиентский секрет Возвращает или задает ключ доступа к секрету учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

ApnsCredential (Учетные данные)

Имя Описание Ценность
свойства Описание a NotificationHub ApnsCredential. ApnsCredentialProperties (обязательно)

ApnsCredentialProperties (Свойства учетных данных)

Имя Описание Ценность
apnsСертификат Возвращает или задает сертификат APNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
appId (идентификатор приложения) Возвращает или задает зарегистрированный ключ утверждения издателя (iss), значение которого равно
10-символьный идентификатор команды, полученный из учетной записи разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
appName Возвращает или задает имя приложения струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
сертификатКлюч Возвращает или задает ключ сертификата. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
конечная точка Возвращает или задает конечную точку этих учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
keyId Возвращает или задает 10-символьный идентификатор ключа (kid), полученный из
учетная запись разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
Отпечаток Возвращает или задает отпечаток сертификата APNS струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
жетон Возвращает или задает маркер проверки подлинности поставщика, полученный через ваш
Учетная запись разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

BaiduУчетные данные

Имя Описание Ценность
свойства Описание элемента NotificationHub BaiduCredential. BaiduCredentialProperties (обязательно)

Свойства BaiduCredentialProperties

Имя Описание Ценность
baiduApiKey Возвращает или задает ключ API baidu. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
baiduEndPoint Возвращает или задает конечную точку baidu. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
baiduSecretKey Возвращает или задает секретный ключ baidu струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

BrowserCredential (Учетные данные)

Имя Описание Ценность
свойства Описание browserCredential в NotificationHub. BrowserCredentialProperties (обязательно)

Свойства браузераCredentialProperties

Имя Описание Ценность
Тема Возвращает или задает тему веб-push-отправки. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
vapidPrivateKey Возвращает или задает закрытый ключ VAPID. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
vapidPublicKey Возвращает или задает открытый ключ VAPID. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

FcmV1Учетные данные

Имя Описание Ценность
свойства Описание уведомления FcmV1Credential. FcmV1CredentialProperties (обязательно)

FcmV1CredentialProperties

Имя Описание Ценность
клиентЭлектронная почта Возвращает или задает адрес электронной почты клиента. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
закрытый ключ Возвращает или задает закрытый ключ. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
projectId Возвращает или задает идентификатор проекта. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

Полномочия GcmCredential

Имя Описание Ценность
свойства Описание объекта NotificationHub GcmCredential. GcmCredentialProperties (обязательно)

GcmCredentialProperties

Имя Описание Ценность
Конечная точка gcmEndpoint Возвращает или задает конечную точку GCM. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
googleApiKey Возвращает или задает ключ API Google. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

Правило IpRule

Имя Описание Ценность
Маска ipMask Маска IP-адресов. струна

Ограничения целостности:
Минимальная длина = 1 (обязательно)
права Список прав доступа. Массив строк, содержащий любой из:
"Прослушивание"
"Управление"
"Отправить" (обязательно)

MpnsCredential

Имя Описание Ценность
свойства Описание элемента NotificationHub MpnsCredential. MpnsCredentialProperties (обязательно)

Свойства MpnsCredentialProperties

Имя Описание Ценность
сертификатКлюч Возвращает или задает ключ сертификата для этих учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
mpnsСертификат Возвращает или задает сертификат MPNS. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
Отпечаток Возвращает или задает отпечаток сертификата MPNS струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

NamespaceProperties

Имя Описание Ценность
DataCenter Устаревшие. струна
namespaceType Определяет значения для NamespaceType. "Обмен сообщениями"
NotificationHub
networkAcls Коллекция правил авторизации сети. NetworkAcls
pnsCredentials Коллекция учетных данных PNS центра уведомлений или пространства имен концентратора уведомлений. PnsCredentials
Состояние обеспечения Определяет значения для OperationProvisioningState. "Отменено"
"Отключено"
"Не удалось"
«В процессе»
"Ожидание"
"Успешно"
"Неизвестно"
доступ к публичной сети Тип доступа к общедоступной сети. "Отключено"
"Включено"
replicationRegion Разрешенная область репликации "АвстралияEast"
"БразилияСут"
По умолчанию
"Нет"
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
Единица измерения scaleUnit Возвращает или задает scaleUnit, в котором создается пространство имен. струна
статус Состояние пространства имен. "Создано"
Создание
Удаление
"Приостановлено"
zoneRedundancy Имя SKU пространства имен. "Отключено"
"Включено"

NetworkAcls

Имя Описание Ценность
ipRules Список правил IP-адресов. Правило IpRule[]
publicNetworkRule Правило авторизации сети по умолчанию (общедоступная сеть Интернет), содержащее права, если другое сетевое правило не совпадает. Правило авторизации в PublicInternetAuthority

PnsCredentials

Имя Описание Ценность
admCredential Описание AdmCredential в NotificationHub. Аккредитация AdmCredential
apnsCredential Описание a NotificationHub ApnsCredential. ApnsCredential (Учетные данные)
baiduCredential Описание элемента NotificationHub BaiduCredential. BaiduУчетные данные
browserCredential Описание browserCredential в NotificationHub. BrowserCredential (Учетные данные)
fcmV1Учетные данные Описание уведомления FcmV1Credential. FcmV1Учетные данные
gcmУчетные данные Описание объекта NotificationHub GcmCredential. Полномочия GcmCredential
mpnsCredential Описание элемента NotificationHub MpnsCredential. MpnsCredential
wnsCredential Описание WnsCredential в NotificationHub. Учетные данные WnsCredential
xiaomiCredential Описание Приложения NotificationHub XiaomiCredential. XiaomiУчетные данные

Правило авторизации в PublicInternetAuthority

Имя Описание Ценность
права Список прав доступа. Массив строк, содержащий любой из:
"Прослушивание"
"Управление"
"Отправить" (обязательно)

Артикул

Имя Описание Ценность
способность Возвращает или задает емкость ресурса инт
семья Возвращает или задает семейство SKU струна
имя Имя SKU пространства имен. "Базовый"
"Бесплатный"
"Стандартный" (обязательный)
размер Возвращает или задает размер SKU струна
ярус Возвращает или задает уровень определенного номера SKU струна

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Учетные данные WnsCredential

Имя Описание Ценность
свойства Описание WnsCredential в NotificationHub. WnsCredentialProperties (обязательно)

WnsCredentialProperties

Имя Описание Ценность
сертификатКлюч Ges или задает ключ сертификата WNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
пакетSid Возвращает или задает идентификатор пакета для этих учетных данных. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
secretKey Возвращает или задает секретный ключ. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
Конечная точка windowsLiveEndpoint Возвращает или задает конечную точку Windows Live. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
wnsСертификат Возвращает или задает сертификат WNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

XiaomiУчетные данные

Имя Описание Ценность
свойства Описание NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (обязательно)

XiaomiCredentialProperties

Имя Описание Ценность
appSecret Возвращает или задает секрет приложения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
конечная точка Возвращает или задает конечную точку службы Xiaomi. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
создание центра уведомлений Azure

развертывание в Azure		 Создает Центр уведомлений Azure, шаблон, изначально созданный Джоном Дауном.
подготовка мобильного приложения с помощью базы данных SQL

развертывание в Azure		 Этот шаблон подготавливает мобильное приложение, базу данных SQL и Центр уведомлений. Он настраивает строку подключения в мобильном приложении для базы данных и концентратора уведомлений.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса пространств имен можно развернуть с помощью операций, предназначенных для следующих операций:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.NotificationHubs/namespaces, добавьте следующий объект 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"
    }
  }
}

Значения свойств

Справочник по шаблонам пространства имен Microsoft.NotificationHubs.

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 50
Pattern = ^[a-zA-Z][a-zA-Z0-9-]*$ (обязательно)
свойства Представляет свойства пространства имен. NamespaceProperties
SKU Описание SKU для пространства имен Sku (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"

Аккредитация AdmCredential

Имя Описание Ценность
свойства Описание AdmCredential в NotificationHub. AdmCredentialProperties (обязательно)

AdmCredentialProperties

Имя Описание Ценность
authTokenUrl Возвращает или задает URL-адрес маркера авторизации. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
clientId Возвращает или задает идентификатор клиента. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
клиентский секрет Возвращает или задает ключ доступа к секрету учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

ApnsCredential (Учетные данные)

Имя Описание Ценность
свойства Описание a NotificationHub ApnsCredential. ApnsCredentialProperties (обязательно)

ApnsCredentialProperties (Свойства учетных данных)

Имя Описание Ценность
apnsСертификат Возвращает или задает сертификат APNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
appId (идентификатор приложения) Возвращает или задает зарегистрированный ключ утверждения издателя (iss), значение которого равно
10-символьный идентификатор команды, полученный из учетной записи разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
appName Возвращает или задает имя приложения струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
сертификатКлюч Возвращает или задает ключ сертификата. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
конечная точка Возвращает или задает конечную точку этих учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
keyId Возвращает или задает 10-символьный идентификатор ключа (kid), полученный из
учетная запись разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
Отпечаток Возвращает или задает отпечаток сертификата APNS струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
жетон Возвращает или задает маркер проверки подлинности поставщика, полученный через ваш
Учетная запись разработчика		 струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

BaiduУчетные данные

Имя Описание Ценность
свойства Описание элемента NotificationHub BaiduCredential. BaiduCredentialProperties (обязательно)

Свойства BaiduCredentialProperties

Имя Описание Ценность
baiduApiKey Возвращает или задает ключ API baidu. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
baiduEndPoint Возвращает или задает конечную точку baidu. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
baiduSecretKey Возвращает или задает секретный ключ baidu струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

BrowserCredential (Учетные данные)

Имя Описание Ценность
свойства Описание browserCredential в NotificationHub. BrowserCredentialProperties (обязательно)

Свойства браузераCredentialProperties

Имя Описание Ценность
Тема Возвращает или задает тему веб-push-отправки. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
vapidPrivateKey Возвращает или задает закрытый ключ VAPID. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
vapidPublicKey Возвращает или задает открытый ключ VAPID. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

FcmV1Учетные данные

Имя Описание Ценность
свойства Описание уведомления FcmV1Credential. FcmV1CredentialProperties (обязательно)

FcmV1CredentialProperties

Имя Описание Ценность
клиентЭлектронная почта Возвращает или задает адрес электронной почты клиента. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
закрытый ключ Возвращает или задает закрытый ключ. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
projectId Возвращает или задает идентификатор проекта. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

Полномочия GcmCredential

Имя Описание Ценность
свойства Описание объекта NotificationHub GcmCredential. GcmCredentialProperties (обязательно)

GcmCredentialProperties

Имя Описание Ценность
Конечная точка gcmEndpoint Возвращает или задает конечную точку GCM. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
googleApiKey Возвращает или задает ключ API Google. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

Правило IpRule

Имя Описание Ценность
Маска ipMask Маска IP-адресов. струна

Ограничения целостности:
Минимальная длина = 1 (обязательно)
права Список прав доступа. Массив строк, содержащий любой из:
"Прослушивание"
"Управление"
"Отправить" (обязательно)

MpnsCredential

Имя Описание Ценность
свойства Описание элемента NotificationHub MpnsCredential. MpnsCredentialProperties (обязательно)

Свойства MpnsCredentialProperties

Имя Описание Ценность
сертификатКлюч Возвращает или задает ключ сертификата для этих учетных данных. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
mpnsСертификат Возвращает или задает сертификат MPNS. струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)
Отпечаток Возвращает или задает отпечаток сертификата MPNS струна

Ограничения целостности:
Минимальная длина = 1
Конфиденциальное значение. Передайте в качестве безопасного параметра. (обязательно)

NamespaceProperties

Имя Описание Ценность
DataCenter Устаревшие. струна
namespaceType Определяет значения для NamespaceType. "Обмен сообщениями"
NotificationHub
networkAcls Коллекция правил авторизации сети. NetworkAcls
pnsCredentials Коллекция учетных данных PNS центра уведомлений или пространства имен концентратора уведомлений. PnsCredentials
Состояние обеспечения Определяет значения для OperationProvisioningState. "Отменено"
"Отключено"
"Не удалось"
«В процессе»
"Ожидание"
"Успешно"
"Неизвестно"
доступ к публичной сети Тип доступа к общедоступной сети. "Отключено"
"Включено"
replicationRegion Разрешенная область репликации "АвстралияEast"
"БразилияСут"
По умолчанию
"Нет"
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
Единица измерения scaleUnit Возвращает или задает scaleUnit, в котором создается пространство имен. струна
статус Состояние пространства имен. "Создано"
Создание
Удаление
"Приостановлено"
zoneRedundancy Имя SKU пространства имен. "Отключено"
"Включено"

NetworkAcls

Имя Описание Ценность
ipRules Список правил IP-адресов. Правило IpRule[]
publicNetworkRule Правило авторизации сети по умолчанию (общедоступная сеть Интернет), содержащее права, если другое сетевое правило не совпадает. Правило авторизации в PublicInternetAuthority

PnsCredentials

Имя Описание Ценность
admCredential Описание AdmCredential в NotificationHub. Аккредитация AdmCredential
apnsCredential Описание a NotificationHub ApnsCredential. ApnsCredential (Учетные данные)
baiduCredential Описание элемента NotificationHub BaiduCredential. BaiduУчетные данные
browserCredential Описание browserCredential в NotificationHub. BrowserCredential (Учетные данные)
fcmV1Учетные данные Описание уведомления FcmV1Credential. FcmV1Учетные данные
gcmУчетные данные Описание объекта NotificationHub GcmCredential. Полномочия GcmCredential
mpnsCredential Описание элемента NotificationHub MpnsCredential. MpnsCredential
wnsCredential Описание WnsCredential в NotificationHub. Учетные данные WnsCredential
xiaomiCredential Описание Приложения NotificationHub XiaomiCredential. XiaomiУчетные данные

Правило авторизации в PublicInternetAuthority

Имя Описание Ценность
права Список прав доступа. Массив строк, содержащий любой из:
"Прослушивание"
"Управление"
"Отправить" (обязательно)

Артикул

Имя Описание Ценность
способность Возвращает или задает емкость ресурса инт
семья Возвращает или задает семейство SKU струна
имя Имя SKU пространства имен. "Базовый"
"Бесплатный"
"Стандартный" (обязательный)
размер Возвращает или задает размер SKU струна
ярус Возвращает или задает уровень определенного номера SKU струна

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Учетные данные WnsCredential

Имя Описание Ценность
свойства Описание WnsCredential в NotificationHub. WnsCredentialProperties (обязательно)

WnsCredentialProperties

Имя Описание Ценность
сертификатКлюч Ges или задает ключ сертификата WNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
пакетSid Возвращает или задает идентификатор пакета для этих учетных данных. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
secretKey Возвращает или задает секретный ключ. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
Конечная точка windowsLiveEndpoint Возвращает или задает конечную точку Windows Live. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
wnsСертификат Возвращает или задает сертификат WNS. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

XiaomiУчетные данные

Имя Описание Ценность
свойства Описание NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (обязательно)

XiaomiCredentialProperties

Имя Описание Ценность
appSecret Возвращает или задает секрет приложения. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
конечная точка Возвращает или задает конечную точку службы Xiaomi. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

Примеры использования

Примеры Terraform

Простой пример развертывания пространства имен концентратора уведомлений.

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