Web Pub Sub - Send To Connection

Service:

Azure Web PubSub Service

API Version:

2023-07-01

Enviar contenido dentro del cuerpo de la solicitud a la conexión específica.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionId	path	True	string	Identificador de conexión.
endpoint	path	True	string url	Punto de conexión HTTP o HTTPS para la instancia del servicio Web PubSub.
hub	path	True	string	El nombre del centro de destino, que debe comenzar con los caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Regex pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	La versión de las API REST.
messageTtlSeconds	query		integer int32	Valor de período de vida (TTL) en segundos para los mensajes enviados al servicio. 0 es el valor predeterminado, lo que significa que el mensaje nunca expira. 300 es el valor máximo. Si este parámetro es distinto de cero, el servicio quitará los mensajes que no consuma el cliente dentro del TTL especificado. Este parámetro puede ayudar cuando el ancho de banda del cliente está limitado.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
message	string	Cuerpo de la carga.

Respuestas

Nombre	Tipo	Description
202 Accepted		Aceptado
Other Status Codes	ErrorDetail	Respuesta de error Headers x-ms-error-code: string

Ejemplos

WebPubSub_SendToConnection

Sample Request

HTTP

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

"Message to send"

Sample Response

Status code:

202

Definiciones

Nombre	Description
ErrorDetail	Objeto de error.
InnerError

ErrorDetail

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	ErrorDetail[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
inner	InnerError
message	string	Representación legible del error.
target	string	Destino del error.

InnerError

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
inner	InnerError