Notification Hubs - Debug Send

Ссылка

Service:: Notification Hubs

API Version:: 2023-09-01

Проверка отправки push-уведомления.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend?api-version=2023-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string	Имя пространства имен Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]*$`
notificationHubName	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, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	DebugSendResponse	Успешное завершение
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_DebugSend

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "properties": {
    "success": 0,
    "failure": 0,
    "results": []
  },
  "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/debugSend"
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
DebugSendResponse	Описание ресурса NotificationHub.
DebugSendResult	Результат операций DebugSend.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
RegistrationResult	Результат уведомления для одной регистрации.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

createdByType

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

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

DebugSendResponse

Описание ресурса NotificationHub.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Не рекомендуется — только для обеспечения совместимости.
name	string	Имя ресурса.
properties	DebugSendResult	Результат операций DebugSend.
systemData	systemData	Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.
tags	object	Не рекомендуется — только для обеспечения совместимости.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

DebugSendResult

Результат операций DebugSend.

Имя	Тип	Описание
failure	integer	Возвращает или задает ошибку отправки
results	RegistrationResult[]	Возвращает или задает фактическое описание сбоя.
success	integer	Возвращает или задает успешную отправку

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

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

Имя	Тип	Описание
error	ErrorDetail	Объект error.

RegistrationResult

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

Имя	Тип	Описание
applicationPlatform	string	Тип PNS.
outcome	string	Результат уведомления.
pnsHandle	string	Дескриптор PNS.
registrationId	string	Идентификатор регистрации.

systemData

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

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

Share via