Web Pub Sub - Remove Connections From Groups

Serviço:

Azure Web PubSub Service

Versão da API:

2024-01-01

Remova conexões filtradas de vários grupos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Ponto de extremidade HTTP ou HTTPS para a instância do serviço Web PubSub.
hub	path	True	string	Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Padrão Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	A versão das APIs REST.

Corpo do Pedido

Name	Tipo	Description
filter	string	Um filtro OData que as conexões de destino satisfazem
groups	string[]	Uma lista de grupos dos quais as conexões de destino serão removidas

Respostas

Name	Tipo	Description
200 OK		Sucesso
Other Status Codes	ErrorDetail	Resposta de erro Cabeçalhos x-ms-error-code: string

Exemplos

WebPubSub_RemoveConnectionsFromGroups

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

200

Definições

Name	Description
ErrorDetail	O objeto de erro.
InnerError
RemoveFromGroupsRequest	O objeto de solicitação que contém grupos de destino e um filtro de conexão

ErrorDetail

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	ErrorDetail[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
inner	InnerError
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

InnerError

Name	Tipo	Description
code	string	Um código de erro mais específico do que foi fornecido pelo erro que contém.
inner	InnerError

RemoveFromGroupsRequest

O objeto de solicitação que contém grupos de destino e um filtro de conexão

Name	Tipo	Description
filter	string	Um filtro OData que as conexões de destino satisfazem
groups	string[]	Uma lista de grupos dos quais as conexões de destino serão removidas