Web Pub Sub - Close All Connections

Servicio:

Azure Web PubSub Service

Versión de la API:

2024-01-01

Cierre las conexiones del centro.

POST {endpoint}/api/hubs/{hub}/:closeConnections?api-version=2024-01-01

Con parámetros opcionales:

POST {endpoint}/api/hubs/{hub}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2024-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Punto de conexión HTTP o HTTPS para la instancia del servicio Web PubSub.
hub	path	True	string	Nombre del centro de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. Patrón de Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Versión de las API REST.
excluded	query		string[]	Excluya estos connectionIds al cerrar las conexiones en el centro.
reason	query		string	Motivo por el que se cierra la conexión de cliente.

Respuestas

Nombre	Tipo	Description
204 No Content		Sin contenido
Other Status Codes	ErrorDetail	Respuesta de error Encabezados x-ms-error-code: string

Ejemplos

WebPubSub_CloseAllConnections

Solicitud de ejemplo

HTTP

POST {endpoint}/api/hubs/hub1/:closeConnections?reason=Close reason&api-version=2024-01-01

Respuesta de muestra

status code:

204

Definiciones

Nombre	Description
ErrorDetail	Objeto de error.
InnerError

ErrorDetail

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
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