Web Pub Sub - Close All Connections

Service:

Azure Web PubSub Service

API Version:

2023-07-01

Cierre las conexiones en el centro.

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

With optional parameters:

POST {endpoint}/api/hubs/{hub}/:closeConnections?excluded={excluded}&reason={reason}&api-version=2023-07-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	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.
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		Ningún contenido
Other Status Codes	ErrorDetail	Respuesta de error Headers x-ms-error-code: string

Ejemplos

WebPubSub_CloseAllConnections

Sample Request

HTTP

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

Sample Response

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