Compartir a través de


Web Pub Sub - Remove Connections From Groups

Quite las conexiones filtradas de varios grupos.

POST {endpoint}/api/hubs/{hub}/:removeFromGroups?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.

Patrón de Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$

api-version
query True

string

La versión de las API REST.

Cuerpo de la solicitud

Nombre Tipo Description
filter

string

Filtro de OData que satisfacen las conexiones de destino

groups

string[]

Lista de grupos de los que se quitarán las conexiones de destino

Respuestas

Nombre Tipo Description
200 OK

Correcto

Other Status Codes

ErrorDetail

Respuesta de error

Encabezados

x-ms-error-code: string

Ejemplos

WebPubSub_RemoveConnectionsFromGroups

Sample request

POST {endpoint}/api/hubs/hub1/:removeFromGroups?api-version=2023-07-01

{
  "groups": [
    "group1",
    "group2"
  ],
  "filter": "startswith(userId, 'listener-')"
}

Sample response

Definiciones

Nombre Description
ErrorDetail

Objeto de error.

InnerError
RemoveFromGroupsRequest

El objeto de solicitud que contiene grupos de destinos y un filtro de conexión

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

RemoveFromGroupsRequest

El objeto de solicitud que contiene grupos de destinos y un filtro de conexión

Nombre Tipo Description
filter

string

Filtro de OData que satisfacen las conexiones de destino

groups

string[]

Lista de grupos de los que se quitarán las conexiones de destino