Поделиться через

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

  • Статья

Определение ресурса Bicep

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

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

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

Чтобы создать ресурс Microsoft.NotificationHubs/namespaces, добавьте следующий Bicep в шаблон.

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

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

пространства имен

Имя Описание Значение
name имя ресурса. строка (обязательно)

Ограничение символов: 6–50

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы. Заканчивается буквенно-цифровым символом.

Имя ресурса должно быть уникальным в Azure.
location Географическое расположение, в котором находится ресурс строка (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Описание номера SKU для пространства имен SKU (обязательно)
properties Представляет свойства пространства имен. NamespaceProperties

NamespaceProperties

Имя Описание Значение
Цод Не рекомендуется. строка
namespaceType Определяет значения для NamespaceType. "Обмен сообщениями"
NotificationHub
networkAcls Коллекция правил авторизации сети. NetworkAcls
pnsCredentials Коллекция учетных данных PNS центра уведомлений или пространства имен центра уведомлений. PnsCredentials
provisioningState Определяет значения для OperationProvisioningState. "Отменено"
"Отключено"
"Сбой"
InProgress
"Ожидание"
"Успешно"
"Неизвестно"
publicNetworkAccess Тип доступа к общедоступной сети. "Отключено"
"Включено"
replicationRegion Разрешенный регион репликации 'AustraliaEast'
'BrazilSouth'
'Default'
"Нет"
'NorthEurope'
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
scaleUnit Возвращает или задает scaleUnit, где создается пространство имен. строка
status Состояние пространства имен. "Создано"
"Создание"
Удаление
"Приостановлено"
zoneRedundancy Имя SKU пространства имен. "Отключено"
"Включено"

NetworkAcls

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

IpRule

Имя Описание Значение
ipMask Маска IP-адреса. string (обязательно)

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

PublicInternetAuthorizationRule

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

PnsCredentials

Имя Описание Значение
admCredential Описание объекта NotificationHub AdmCredential. AdmCredential
apnsCredential Описание объекта NotificationHub ApnsCredential. ApnsCredential
baiduCredential Описание NotificationHub BaiduCredential. BaiduCredential
browserCredential Описание NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Описание NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Описание NotificationHub GcmCredential. GcmCredential
mpnsCredential Описание Объекта NotificationHub MpnsCredential. MpnsCredential
wnsCredential Описание notificationHub WnsCredential. WnsCredential
xiaomiCredential Описание NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Имя Описание Значение
properties Описание объекта NotificationHub AdmCredential. AdmCredentialProperties (обязательно)

AdmCredentialProperties

Имя Описание Значение
authTokenUrl Возвращает или задает URL-адрес маркера авторизации. string (обязательно)

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

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

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

ApnsCredential

Имя Описание Значение
properties Описание объекта NotificationHub ApnsCredential. ApnsCredentialProperties (обязательно)

ApnsCredentialProperties

Имя Описание Значение
apnsCertificate Возвращает или задает сертификат APNS. строка

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

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

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

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

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

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

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

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

BaiduCredential

Имя Описание Значение
properties Описание NotificationHub BaiduCredential. BaiduCredentialProperties (обязательно)

BaiduCredentialProperties

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

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

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

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

BrowserCredential

Имя Описание Значение
properties Описание NotificationHub BrowserCredential. BrowserCredentialProperties (обязательно)

BrowserCredentialProperties

Имя Описание Значение
subject Возвращает или задает тему веб-отправки. string (обязательно)

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

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

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

FcmV1Credential

Имя Описание Значение
properties Описание NotificationHub FcmV1Credential. FcmV1CredentialProperties (обязательно)

FcmV1CredentialProperties

Имя Описание Значение
clientEmail Возвращает или задает адрес электронной почты клиента. string (обязательно)

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

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

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

GcmCredential

Имя Описание Значение
properties Описание NotificationHub GcmCredential. GcmCredentialProperties (обязательно)

GcmCredentialProperties

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

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

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

MpnsCredential

Имя Описание Значение
properties Описание Объекта NotificationHub MpnsCredential. MpnsCredentialProperties (обязательно)

MpnsCredentialProperties

Имя Описание Значение
certificateKey Возвращает или задает ключ сертификата для этих учетных данных. string (обязательно)

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

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

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

WnsCredential

Имя Описание Значение
properties Описание notificationHub WnsCredential. WnsCredentialProperties (обязательно)

WnsCredentialProperties

Имя Описание Значение
certificateKey Определяет или задает ключ сертификата WNS. строка

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

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

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

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

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

XiaomiCredential

Имя Описание Значение
properties Описание NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (обязательно)

XiaomiCredentialProperties

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

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

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

Sku

Имя Описание Значение
Емкость Возвращает или задает емкость ресурса. INT
family Возвращает или задает семейство SKU строка
name Имя SKU пространства имен. "Базовый"
"Бесплатный"
"Стандартный" (обязательно)
size Возвращает или задает размер SKU. строка
Уровень Возвращает или задает уровень конкретного номера SKU. строка

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

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

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

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

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

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

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

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

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

Чтобы создать ресурс Microsoft.NotificationHubs/namespaces, добавьте следующий код JSON в шаблон.

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

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

пространства имен

Имя Описание Значение
тип Тип ресурса Microsoft.NotificationHubs/namespaces
версия_API Версия API ресурсов '2023-10-01-preview'
name имя ресурса. string (обязательно)

Ограничение символов: 6-50

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы. Заканчивается буквенно-цифровым символом.

Имя ресурса должно быть уникальным в Azure.
location Географическое расположение, в котором находится ресурс string (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Описание SKU для пространства имен SKU (обязательно)
properties Представляет свойства пространства имен. Свойства пространства имен

Свойства пространства имен

Имя Описание Значение
Цод Не рекомендуется. строка
namespaceType Определяет значения для NamespaceType. "Обмен сообщениями"
NotificationHub
networkAcls Коллекция правил авторизации сети. NetworkAcls
pnsCredentials Коллекция учетных данных PNS центра уведомлений или пространства имен концентратора уведомлений. PnsCredentials
provisioningState Определяет значения для OperationProvisioningState. "Отменено"
"Отключено"
"Сбой"
'InProgress'
"Ожидание"
"Успешно"
"Неизвестно"
publicNetworkAccess Тип доступа к общедоступной сети. "Отключено"
"Включено"
replicationRegion Разрешенный регион репликации 'AustraliaEast'
'BrazilSouth'
'Default'
"Нет"
'NorthEurope'
"SouthAfricaNorth"
'SouthEastAsia'
'WestUs2'
scaleUnit Возвращает или задает scaleUnit, где создается пространство имен. строка
status Состояние пространства имен. "Создано"
"Создание"
"Удаление"
"Приостановлено"
zoneRedundancy Имя SKU пространства имен. "Отключено"
"Включено"

NetworkAcls

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

IpRule

Имя Описание Значение
ipMask Маска IP-адреса. строка (обязательно)

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

PublicInternetAuthorizationRule

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

PnsCredentials

Имя Описание Значение
admCredential Описание NotificationHub AdmCredential. AdmCredential
apnsCredential Описание объекта NotificationHub ApnsCredential. ApnsCredential
baiduCredential Описание NotificationHub BaiduCredential. BaiduCredential
browserCredential Описание NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Описание NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Описание NotificationHub GcmCredential. GcmCredential
mpnsCredential Описание NotificationHub MpnsCredential. MpnsCredential
wnsCredential Описание WnsCredential для NotificationHub. WnsCredential
xiaomiCredential Описание NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Имя Описание Значение
properties Описание NotificationHub AdmCredential. AdmCredentialProperties (обязательно)

AdmCredentialProperties

Имя Описание Значение
authTokenUrl Возвращает или задает URL-адрес маркера авторизации. строка (обязательно)

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

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

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

ApnsCredential

Имя Описание Значение
properties Описание объекта NotificationHub ApnsCredential. ApnsCredentialProperties (обязательно)

ApnsCredentialProperties

Имя Описание Значение
apnsCertificate Возвращает или задает сертификат APNS. строка

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

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

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

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

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

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

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

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

BaiduCredential

Имя Описание Значение
properties Описание NotificationHub BaiduCredential. BaiduCredentialProperties (обязательно)

BaiduCredentialProperties

Имя Описание Значение
baiduApiKey Возвращает или задает ключ API baidu. string (обязательно)

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

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

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

BrowserCredential

Имя Описание Значение
properties Описание NotificationHub BrowserCredential. BrowserCredentialProperties (обязательно)

BrowserCredentialProperties

Имя Описание Значение
subject Возвращает или задает тему веб-отправки. строка (обязательно)

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

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

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

FcmV1Credential

Имя Описание Значение
properties Описание NotificationHub FcmV1Credential. FcmV1CredentialProperties (обязательно)

FcmV1CredentialProperties

Имя Описание Значение
clientEmail Возвращает или задает адрес электронной почты клиента. строка (обязательно)

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

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

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

GcmCredential

Имя Описание Значение
properties Описание NotificationHub GcmCredential. GcmCredentialProperties (обязательно)

GcmCredentialProperties

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

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

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

MpnsCredential

Имя Описание Значение
properties Описание NotificationHub MpnsCredential. MpnsCredentialProperties (обязательно)

MpnsCredentialProperties

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

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

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

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

WnsCredential

Имя Описание Значение
properties Описание notificationHub WnsCredential. WnsCredentialProperties (обязательно)

WnsCredentialProperties

Имя Описание Значение
certificateKey Определяет или задает ключ сертификата WNS. строка

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

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

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

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

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

XiaomiCredential

Имя Описание Значение
properties Описание NotificationHub XiaomiCredentialProperties. XiaomiCredentialProperties (обязательно)

XiaomiCredentialProperties

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

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

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

Sku

Имя Описание Значение
Емкость Возвращает или задает емкость ресурса. INT
family Возвращает или задает семейство SKU строка
name Имя SKU пространства имен. "Базовый"
"Бесплатный"
"Стандартный" (обязательно)
size Возвращает или задает размер SKU. строка
Уровень Возвращает или задает уровень конкретного номера SKU. строка

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

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

Шаблон Описание
Создание центра уведомлений 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"
  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"
    }
  })
}

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

пространства имен

Имя Описание Значение
тип Тип ресурса "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
name имя ресурса. строка (обязательно)

Ограничение символов: 6–50

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы. Заканчивается буквенно-цифровым символом.

Имя ресурса должно быть уникальным в Azure.
location Географическое расположение, в котором находится ресурс строка (обязательно)
parent_id Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов.
sku Описание номера SKU для пространства имен SKU (обязательно)
properties Представляет свойства пространства имен. NamespaceProperties

NamespaceProperties

Имя Описание Значение
Цод Не рекомендуется. строка
namespaceType Определяет значения для NamespaceType. "Обмен сообщениями"
NotificationHub
networkAcls Коллекция правил авторизации сети. NetworkAcls
pnsCredentials Коллекция учетных данных PNS центра уведомлений или пространства имен центра уведомлений. PnsCredentials
provisioningState Определяет значения для OperationProvisioningState. "Отменено"
"Отключено"
"Сбой"
"InProgress"
"Ожидание"
"Успешно"
"Неизвестно"
publicNetworkAccess Тип доступа к общедоступной сети. "Отключено"
"Включено"
replicationRegion Разрешенный регион репликации "AustraliaEast"
"BrazilSouth"
"По умолчанию"
"None"
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
scaleUnit Возвращает или задает scaleUnit, где создается пространство имен. строка
status Состояние пространства имен. "Создано"
"Создание"
"Удаление"
"Приостановлено"
zoneRedundancy Имя SKU пространства имен. "Отключено"
"Включено"

NetworkAcls

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

IpRule

Имя Описание Значение
ipMask Маска IP-адреса. string (обязательно)

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

PublicInternetAuthorizationRule

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

PnsCredentials

Имя Описание Значение
admCredential Описание объекта NotificationHub AdmCredential. AdmCredential
apnsCredential Описание объекта NotificationHub ApnsCredential. ApnsCredential
baiduCredential Описание NotificationHub BaiduCredential. BaiduCredential
browserCredential Описание NotificationHub BrowserCredential. BrowserCredential
fcmV1Credential Описание NotificationHub FcmV1Credential. FcmV1Credential
gcmCredential Описание NotificationHub GcmCredential. GcmCredential
mpnsCredential Описание Объекта NotificationHub MpnsCredential. MpnsCredential
wnsCredential Описание notificationHub WnsCredential. WnsCredential
xiaomiCredential Описание NotificationHub XiaomiCredential. XiaomiCredential

AdmCredential

Имя Описание Значение
properties Описание объекта NotificationHub AdmCredential. AdmCredentialProperties (обязательно)

AdmCredentialProperties

Имя Описание Значение
authTokenUrl Возвращает или задает URL-адрес маркера авторизации. string (обязательно)

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

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

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

ApnsCredential

Имя Описание Значение
properties Описание объекта NotificationHub ApnsCredential. ApnsCredentialProperties (обязательно)

ApnsCredentialProperties

Имя Описание Значение
apnsCertificate Возвращает или задает сертификат APNS. строка

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

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

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

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

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

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

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

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

BaiduCredential

Имя Описание Значение
properties Описание NotificationHub BaiduCredential. BaiduCredentialProperties (обязательно)

BaiduCredentialProperties

Имя Описание Значение
baiduApiKey Возвращает или задает ключ API baidu. string (обязательно)

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

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

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

BrowserCredential

Имя Описание Значение
properties Описание NotificationHub BrowserCredential. BrowserCredentialProperties (обязательно)

BrowserCredentialProperties

Имя Описание Значение
subject Возвращает или задает тему веб-отправки. string (обязательно)

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

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

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

FcmV1Credential

Имя Описание Значение
properties Описание NotificationHub FcmV1Credential. FcmV1CredentialProperties (обязательно)

FcmV1CredentialProperties

Имя Описание Значение
clientEmail Возвращает или задает адрес электронной почты клиента. string (обязательно)

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

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

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

GcmCredential

Имя Описание Значение
properties Описание NotificationHub GcmCredential. GcmCredentialProperties (обязательно)

GcmCredentialProperties

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

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

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

MpnsCredential

Имя Описание Значение
properties Описание Объекта NotificationHub MpnsCredential. MpnsCredentialProperties (обязательно)

MpnsCredentialProperties

Имя Описание Значение
certificateKey Возвращает или задает ключ сертификата для этих учетных данных. string (обязательно)

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

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

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

WnsCredential

Имя Описание Значение
properties Описание WnsCredential для NotificationHub. WnsCredentialProperties (обязательно)

WnsCredentialProperties

Имя Описание Значение
certificateKey Определяет или задает ключ сертификата WNS. строка

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

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

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

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

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

XiaomiCredential

Имя Описание Значение
properties Описание Объекта NotificationHub Для XiaomiCredentialProperties. XiaomiCredentialProperties (обязательно)

XiaomiCredentialProperties

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

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

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

Sku

Имя Описание Значение
Емкость Возвращает или задает емкость ресурса. INT
family Возвращает или задает семейство SKU строка
name Имя SKU пространства имен. "Basic"
"Бесплатный"
"Стандартный" (обязательно)
size Возвращает или задает размер SKU. строка
Уровень Возвращает или задает уровень определенного номера SKU. строка