API REST do plano de dados do Serviço Azure SignalR - v1
Artigo 25/10/2023
1 contribuidor
Comentários
Neste artigo
Este artigo contém as APIs REST da versão v1 para o plano de dados do Serviço Azure SignalR.
Expandir tabela
Difunda uma mensagem para todos os clientes conectados ao hub de destino.
POST /api/v1/hubs/{hub}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
excluído
query
Ids de conexão excluídos
Não
[ string ]
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Transmitir uma mensagem para todos os clientes pertencem ao usuário alvo.
POST /api/v1/hubs/{hub}/users/{id}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
ID
path
O ID do usuário.
Sim
string
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Enviar mensagem para a conexão específica.
POST /api/v1/hubs/{hub}/connections/{connectionId}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
connectionId
path
O ID da conexão.
Sim
string
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Verifique se a conexão com o connectionId fornecido existe
GET /api/v1/hubs/{hub}/connections/{connectionId}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Sim
string
connectionId
path
Sim
string
Expandir tabela
Código
Descrição
200
Com êxito
400
Pedido Incorreto
404
Não Encontrado
Feche a conexão do cliente
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Sim
string
connectionId
path
Sim
string
reason
query
Não
string
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Difundir uma mensagem para todos os clientes dentro do grupo-alvo.
POST /api/v1/hubs/{hub}/groups/{group}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
excluído
query
Ids de conexão excluídos
Não
[ string ]
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Verifique se há alguma conexão de cliente dentro de um determinado grupo
GET /api/v1/hubs/{hub}/groups/{group}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Sim
string
grupo
path
Sim
string
Expandir tabela
Código
Descrição
200
Com êxito
400
Pedido Incorreto
404
Não Encontrado
Verifique se há alguma conexão de cliente conectada para um determinado usuário
GET /api/v1/hubs/{hub}/users/{user}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Sim
string
Utilizador
path
Sim
string
Expandir tabela
Código
Descrição
200
Com êxito
400
Pedido Incorreto
404
Não Encontrado
Adicione uma conexão ao grupo-alvo.
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
connectionId
path
ID da conexão de destino
Sim
string
Expandir tabela
Código
Descrição
200
Com êxito
400
Pedido Incorreto
404
Não Encontrado
Remova uma conexão do grupo-alvo.
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
connectionId
path
ID da conexão de destino
Sim
string
Expandir tabela
Código
Descrição
200
Com êxito
400
Pedido Incorreto
404
Não Encontrado
Verifique se existe um utilizador no grupo-alvo.
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
Utilizador
path
ID do usuário alvo
Sim
string
Expandir tabela
Código
Descrição
200
Com êxito
400
Pedido Incorreto
404
Não Encontrado
Adicione um usuário ao grupo-alvo.
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
Utilizador
path
ID do usuário alvo
Sim
string
ttl
query
Especifica os segundos em que o usuário existe no grupo. Se não estiver definido, o usuário vive no grupo por no máximo 1 ano. Observe que, quando ttl não está definido, o serviço preserva 100 relações de grupo de usuários por usuário e as relações de grupo de usuários antigas são substituídas por relações recém-adicionadas.
Não
integer
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Remova um usuário do grupo-alvo.
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo-alvo, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
Utilizador
path
ID do usuário alvo
Sim
string
Expandir tabela
Código
Descrição
202
Com êxito
400
Pedido Incorreto
Remova um usuário de todos os grupos.
DELETE /api/v1/hubs/{hub}/users/{user}/groups
Expandir tabela
Nome
Localizada em
Descrição
Necessária
Esquema
hub
path
Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Sim
string
Utilizador
path
ID do usuário alvo
Sim
string
Expandir tabela
Código
Descrição
200
O usuário é excluído
202
A solicitação de exclusão é aceita e o serviço está lidando com a solicitação em segundo plano
400
Pedido Incorreto
Expandir tabela
Nome
Tipo
Descrição
Necessária
Destino
string
Não
Argumentos
[ objeto ]
Não