Share via

Notification Hubs - List

  • Ссылка
Service:
Notification Hubs
API Version:
2023-09-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?api-version=2023-09-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?$skipToken={$skipToken}&$top={$top}&api-version=2023-09-01

Параметры URI

Имя В Обязательно Тип Описание
namespaceName
 path True

string

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

Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
resourceGroupName
 path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId
 path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

Версия API, используемая для данной операции.
$skipToken
 query

string

Маркер продолжения.
$top
 query

integer

int32

Размер страницы.

Ответы

Имя Тип Описание
200 OK

NotificationHubListResult

Успешное завершение
Other Status Codes

ErrorResponse

Код ошибки с причиной.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

NotificationHubs_List

Sample Request

GET https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs?api-version=2023-09-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "location": "East US",
      "properties": {
        "name": "test",
        "registrationTtl": "10675199.02:48:05.4775807",
        "dailyMaxActiveDevices": 0
      },
      "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
      "name": "test",
      "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
      "tags": {
        "hubTag1": "hubTagValue1",
        "hubTag2": "hubTagValue2"
      }
    }
  ]
}

Определения

Имя Описание
AccessRights

Определяет значения для AccessRights.
AdmCredential

Описание NotificationHub AdmCredential.
AdmCredentialProperties

Описание объекта NotificationHub AdmCredential.
ApnsCredential

Описание объекта NotificationHub ApnsCredential.
ApnsCredentialProperties

Описание объекта NotificationHub ApnsCredential.
BaiduCredential

Описание NotificationHub BaiduCredential.
BaiduCredentialProperties

Описание NotificationHub BaiduCredential.
BrowserCredential

Описание NotificationHub BrowserCredential.
BrowserCredentialProperties

Описание NotificationHub BrowserCredential.
createdByType

Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
GcmCredential

Описание NotificationHub GcmCredential.
GcmCredentialProperties

Описание NotificationHub GcmCredential.
MpnsCredential

Описание NotificationHub MpnsCredential.
MpnsCredentialProperties

Описание NotificationHub MpnsCredential.
NotificationHubListResult

Ответ операции List NotificationHub.
NotificationHubProperties

Свойства NotificationHub.
NotificationHubResource

Ресурс центра уведомлений.
SharedAccessAuthorizationRuleProperties

Свойства SharedAccessAuthorizationRule.
Sku

Описание номера SKU для пространства имен
SkuName

Имя SKU пространства имен.
systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.
WnsCredential

Описание WnsCredential для NotificationHub.
WnsCredentialProperties

Описание WnsCredential для NotificationHub.
XiaomiCredential

Описание NotificationHub XiaomiCredential.
XiaomiCredentialProperties

Описание NotificationHub XiaomiCredentialProperties.

AccessRights

Определяет значения для AccessRights.

Имя Тип Описание
Listen

string

Manage

string

Send

string

AdmCredential

Описание NotificationHub AdmCredential.

Имя Тип Описание
properties

AdmCredentialProperties

Описание NotificationHub AdmCredential.

AdmCredentialProperties

Описание объекта NotificationHub AdmCredential.

Имя Тип Описание
authTokenUrl

string

Возвращает или задает URL-адрес маркера авторизации.
clientId

string

Возвращает или задает идентификатор клиента.
clientSecret

string

Возвращает или задает ключ доступа к секрету учетных данных.

ApnsCredential

Описание объекта NotificationHub ApnsCredential.

Имя Тип Описание
properties

ApnsCredentialProperties

Описание объекта NotificationHub ApnsCredential.

ApnsCredentialProperties

Описание объекта NotificationHub ApnsCredential.

Имя Тип Описание
apnsCertificate

string

Возвращает или задает сертификат APNS.
appId

string

Возвращает или задает зарегистрированный ключ утверждения издателя (ISS), значением которого является 10-значный идентификатор команды, полученный из учетной записи разработчика.
appName

string

Возвращает или задает имя приложения.
certificateKey

string

Возвращает или задает ключ сертификата.
endpoint

string

Возвращает или задает конечную точку этих учетных данных.
keyId

string

Возвращает или задает 10-значный идентификатор ключа (kid), полученный из учетной записи разработчика.
thumbprint

string

Возвращает или задает отпечаток сертификата APNS.
token

string

Возвращает или задает маркер проверки подлинности поставщика, полученный через учетную запись разработчика.

BaiduCredential

Описание NotificationHub BaiduCredential.

Имя Тип Описание
properties

BaiduCredentialProperties

Описание NotificationHub BaiduCredential.

BaiduCredentialProperties

Описание NotificationHub BaiduCredential.

Имя Тип Описание
baiduApiKey

string

Возвращает или задает ключ API baidu.
baiduEndPoint

string

Возвращает или задает конечную точку baidu.
baiduSecretKey

string

Возвращает или задает секретный ключ baidu

BrowserCredential

Описание NotificationHub BrowserCredential.

Имя Тип Описание
properties

BrowserCredentialProperties

Описание NotificationHub BrowserCredential.

BrowserCredentialProperties

Описание NotificationHub BrowserCredential.

Имя Тип Описание
subject

string

Возвращает или задает тему веб-отправки.
vapidPrivateKey

string

Возвращает или задает закрытый ключ VAPID.
vapidPublicKey

string

Возвращает или задает открытый ключ VAPID.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

GcmCredential

Описание NotificationHub GcmCredential.

Имя Тип Описание
properties

GcmCredentialProperties

Описание NotificationHub GcmCredential.

GcmCredentialProperties

Описание NotificationHub GcmCredential.

Имя Тип Описание
gcmEndpoint

string

Возвращает или задает конечную точку GCM.
googleApiKey

string

Возвращает или задает ключ API Google.

MpnsCredential

Описание NotificationHub MpnsCredential.

Имя Тип Описание
properties

MpnsCredentialProperties

Описание NotificationHub MpnsCredential.

MpnsCredentialProperties

Описание NotificationHub MpnsCredential.

Имя Тип Описание
certificateKey

string

Возвращает или задает ключ сертификата для этих учетных данных.
mpnsCertificate

string

Возвращает или задает сертификат MPNS.
thumbprint

string

Возвращает или задает отпечаток сертификата MPNS.

NotificationHubListResult

Ответ операции List NotificationHub.

Имя Тип Описание
nextLink

string

Возвращает или задает ссылку на следующий набор результатов.
value

NotificationHubResource[]

Возвращает или задает результат операции List AuthorizationRules.

NotificationHubProperties

Свойства NotificationHub.

Имя Тип Описание
admCredential

AdmCredential

Описание NotificationHub AdmCredential.
apnsCredential

ApnsCredential

Описание объекта NotificationHub ApnsCredential.
authorizationRules

SharedAccessAuthorizationRuleProperties[]

Возвращает или задает значение AuthorizationRules созданного центра уведомлений.
baiduCredential

BaiduCredential

Описание NotificationHub BaiduCredential.
browserCredential

BrowserCredential

Описание NotificationHub BrowserCredential.
dailyMaxActiveDevices

integer

gcmCredential

GcmCredential

Описание NotificationHub GcmCredential.
mpnsCredential

MpnsCredential

Описание NotificationHub MpnsCredential.
name

string

Возвращает или задает имя NotificationHub.
registrationTtl

string

Возвращает или задает значение RegistrationTtl созданного notificationHub.
wnsCredential

WnsCredential

Описание WnsCredential для NotificationHub.
xiaomiCredential

XiaomiCredential

Описание NotificationHub XiaomiCredential.

NotificationHubResource

Ресурс центра уведомлений.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location

string

Географическое расположение, в котором находится ресурс
name

string

Имя ресурса.
properties

NotificationHubProperties

Свойства NotificationHub.
sku

Sku

Описание номера SKU для пространства имен
systemData

systemData

Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
tags

object

Теги ресурсов.
type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

SharedAccessAuthorizationRuleProperties

Свойства SharedAccessAuthorizationRule.

Имя Тип Описание
claimType

string

Возвращает строку, описывающую тип утверждения.
claimValue

string

Возвращает строку, описывающую значение утверждения.
createdTime

string

Возвращает время создания для этого правила.
keyName

string

Возвращает строку, описывающую правило авторизации.
modifiedTime

string

Возвращает время последнего изменения для этого правила.
primaryKey

string

Возвращает 256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS.
revision

integer

Возвращает номер редакции для правила.
rights

AccessRights[]

Возвращает или задает права, связанные с правилом.
secondaryKey

string

Возвращает 256-разрядный первичный ключ в кодировке Base64 для подписывания и проверки маркера SAS.

Sku

Описание номера SKU для пространства имен

Имя Тип Описание
capacity

integer

Возвращает или задает емкость ресурса.
family

string

Возвращает или задает семейство SKU
name

SkuName

Имя SKU пространства имен.
size

string

Возвращает или задает размер SKU.
tier

string

Возвращает или задает уровень определенного номера SKU.

SkuName

Имя SKU пространства имен.

Имя Тип Описание
Basic

string

Free

string

Standard

string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.
lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.

WnsCredential

Описание WnsCredential для NotificationHub.

Имя Тип Описание
properties

WnsCredentialProperties

Описание WnsCredential для NotificationHub.

WnsCredentialProperties

Описание WnsCredential для NotificationHub.

Имя Тип Описание
certificateKey

string

Определяет или задает ключ сертификата WNS.
packageSid

string

Возвращает или задает идентификатор пакета для этих учетных данных.
secretKey

string

Возвращает или задает секретный ключ.
windowsLiveEndpoint

string

Возвращает или задает конечную точку Windows Live.
wnsCertificate

string

Возвращает или задает сертификат WNS.

XiaomiCredential

Описание NotificationHub XiaomiCredential.

Имя Тип Описание
properties

XiaomiCredentialProperties

Описание Объекта NotificationHub Для XiaomiCredentialProperties.

XiaomiCredentialProperties

Описание NotificationHub XiaomiCredentialProperties.

Имя Тип Описание
appSecret

string

Возвращает или задает секрет приложения.
endpoint

string

Возвращает или задает конечную точку службы Xiaomi.