API REST do plano de dados do Serviço do Azure SignalR – v1
Artigo 10/24/2023
1 colaborador
Comentários
Neste artigo
Este artigo contém as APIs REST versão v1 para o plano de dados do Serviço do Azure SignalR.
APIs Disponíveis
Transmitir uma mensagem para todos os clientes conectados ao hub de destino.
POST /api/v1/hubs/{hub}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
Excluído
Consulta
IDs de conexão excluídas
Não
[ cadeia de caracteres ]
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Transmitir uma mensagem para todos os clientes pertencentes ao usuário de destino.
POST /api/v1/hubs/{hub}/users/{id}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
ID
path
A ID do usuário.
Sim
string
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Enviar mensagem para a conexão específica.
POST /api/v1/hubs/{hub}/connections/{connectionId}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
connectionId
path
A ID de conexão.
Sim
string
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Verificar se a conexão com a connectionId determinada existe
GET /api/v1/hubs/{hub}/connections/{connectionId}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
Sim
string
connectionId
path
Sim
string
Respostas
Código
Descrição
200
Êxito
400
Solicitação incorreta
404
Não encontrado
Fechar conexão de cliente
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
Sim
string
connectionId
path
Sim
string
reason
Consulta
Não
string
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Transmitir uma mensagem para todos os clientes dentro do grupo de destino.
POST /api/v1/hubs/{hub}/groups/{group}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
Excluído
Consulta
IDs de conexão excluídas
Não
[ cadeia de caracteres ]
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Verificar se há conexões de cliente dentro do grupo determinado
GET /api/v1/hubs/{hub}/groups/{group}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
Sim
string
grupo
path
Sim
string
Respostas
Código
Descrição
200
Êxito
400
Solicitação incorreta
404
Não encontrado
Verificar se há conexões de cliente conectadas para o usuário determinado
GET /api/v1/hubs/{hub}/users/{user}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
Sim
string
usuário
path
Sim
string
Respostas
Código
Descrição
200
Êxito
400
Solicitação incorreta
404
Não encontrado
Adicionar uma conexão ao grupo de destino.
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
connectionId
path
ID da conexão de destino
Sim
string
Respostas
Código
Descrição
200
Êxito
400
Solicitação incorreta
404
Não encontrado
Remover uma conexão do grupo de destino.
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
connectionId
path
ID da conexão de destino
Sim
string
Respostas
Código
Descrição
200
Êxito
400
Solicitação incorreta
404
Não encontrado
Verificar se um usuário existe no grupo de destino.
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
usuário
path
ID do usuário de destino
Sim
string
Respostas
Código
Descrição
200
Êxito
400
Solicitação incorreta
404
Não encontrado
Adicionar um usuário ao grupo de destino.
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
usuário
path
ID do usuário de destino
Sim
string
ttl
Consulta
Especifica os segundos que o usuário existe no grupo. Se não estiver definido, o usuário viverá no grupo por no máximo 1 ano. Observe que, quando o ttl não está definido, o serviço preserva 100 relações de grupo de usuários por usuário e relações de grupos de usuários antigos são substituídas por recém-adicionadas.
Não
Número inteiro
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Remover um usuário do grupo de destino.
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
grupo
path
Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.
Sim
string
usuário
path
ID do usuário de destino
Sim
string
Respostas
Código
Descrição
202
Êxito
400
Solicitação incorreta
Remover um usuário de todos os grupos.
DELETE /api/v1/hubs/{hub}/users/{user}/groups
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
hub
path
O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado.
Sim
string
usuário
path
ID do usuário de destino
Sim
string
Respostas
Código
Descrição
200
O usuário é excluído
202
A solicitação de exclusão é aceita e o serviço está tratando a solicitação em segundo plano
400
Solicitação incorreta
Modelos
PayloadMessage
Nome
Digitar
Descrição
Necessário
Destino
string
Não
Argumentos
[ objeto ]
Não