Partilhar via

Web Pub Sub - Close Group Connections

  • Referência
Serviço:
Azure Web PubSub Service
Versão da API:
2024-01-01

Feche conexões no grupo específico.

POST {endpoint}/api/hubs/{hub}/groups/{group}/:closeConnections?api-version=2024-01-01
Com parâmetros opcionais: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:closeConnections?excluded={excluded}&reason={reason}&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.
group
 path True

string

Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.

Padrão Regex: ^(?!\s+$).+$
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.
excluded
 query

string[]

Exclua esses connectionIds ao fechar as conexões no grupo.
reason
 query

string

O motivo de fechar a conexão do cliente.

Respostas

Name Tipo Description
204 No Content

Sem conteúdo
Other Status Codes

ErrorDetail

Resposta de erro

Cabeçalhos

x-ms-error-code: string

Exemplos

WebPubSub_CloseGroupConnections

Pedido de amostra

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

Resposta da amostra

Código de estado:
204

Definições

Name Description
ErrorDetail

O objeto de erro.
InnerError

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