Send To Connection - Send To Connection

Служба:

Azure Web PubSub Service

Версия API:

2024-12-01

Отправка содержимого внутри тела запроса на конкретное соединение.

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01

С использованием необязательных параметров:

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01&messageTtlSeconds={messageTtlSeconds}

Параметры URI

Имя	В	Обязательно	Тип	Описание
connectionId	path	True	string minLength: 1	Идентификатор подключения
endpoint	path	True	string (uri)	Конечная точка HTTP или HTTPS для экземпляра службы Web PubSub
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Имя целевого хаба, которое должно начинаться с буквенных символов и содержать только буквенно-цифровые символы или символы подчеркивания.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	Значение срока жизни (TTL) в секундах для сообщений, отправляемых в службу. 0 — это значение по умолчанию, что означает, что срок действия сообщения никогда не истекает. 300 — это максимальное значение. Если этот параметр не равен нулю, то сообщения, которые не были использованы клиентом в течение указанного TTL, будут отброшены службой. Этот параметр может быть полезен при ограниченной пропускной способности клиента.

Текст запроса

Media Types: "application/json", "application/octet-stream", "text/plain"

Имя	Тип	Описание
message	string (byte)	Тело полезной нагрузки.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

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

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://webpubsub.azure.com/.default

Примеры

SendToConnection

Образец запроса

HTTP

POST {endpoint}/api/hubs/hub1/connections/connection1/:send?api-version=2024-12-01&messageTtlSeconds=15

"TWVzc2FnZSB0byBzZW5k"

Пример ответа

Код состояния:

202

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.