API REST do Serviço Azure SignalR
Artigo 10/24/2023
1 colaborador
Comentários
Neste artigo
Versão: 2022-06-01
APIs Disponíveis
/api/integridade
HEAD
Resumo
Obter status de integridade do serviço.
Obter status de integridade do serviço
HEAD /api/health
Parâmetros
Nome
Localizado em
Descrição
Necessário
Esquema
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
Código
Descrição
200
O serviço é saudável
default
Resposta de erro
/api/hubs/{hub}/:closeConnections
POST
Resumo
Feche todas as conexões no hub.
Feche todas as conexões no hub
POST /api/hubs/{hub}/:closeConnections
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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
Excluído
Consulta
Exclua esses connectionIds ao fechar as conexões no hub.
Não
[ cadeia de caracteres ]
reason
Consulta
O motivo do fechamento das conexões do cliente.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
Código
Descrição
Esquema
204
Sucesso
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/:enviar
POST
Resumo
Transmitir uma mensagem para todos os clientes conectados ao hub de destino.
Transmitir uma mensagem para todos os clientes conectados ao hub de destino
POST /api/hubs/{hub}/:send
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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
Excluído
Consulta
IDs de conexão excluídas
Não
[ cadeia de caracteres ]
api-version
Consulta
A versão das APIs REST.
Sim
string
mensagem
body
A mensagem de carga.
Sim
Mensagem de carga útil
Respostas
/api/hubs/{hub}/connections/{connectionId}
HEAD
Resumo
Verificar se a conexão com a connectionId determinada existe
Verificar se a conexão com a connectionId determinada existe
HEAD /api/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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
DELETE
Resumo
Fechar conexão de cliente
Fechar conexão de cliente
DELETE /api/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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
reason
Consulta
O motivo da conexão fechar.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/connections/{connectionId}/:send
POST
Resumo
Enviar mensagem para a conexão específica.
Enviar mensagem para a conexão específica
POST /api/hubs/{hub}/connections/{connectionId}/:send
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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
mensagem
body
A mensagem de carga.
Sim
Mensagem de carga útil
Respostas
/api/hubs/{hub}/groups/{grupo}
HEAD
Resumo
Verificar se há conexões de cliente dentro do grupo determinado
Verificar se há conexões de cliente dentro do grupo determinado
HEAD /api/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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/groups/{group}/:closeConnections
POST
Resumo
Feche conexões no grupo específico.
Fechar conexões no grupo específico
POST /api/hubs/{hub}/groups/{group}/:closeConnections
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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
Excluído
Consulta
Exclua esses connectionIds ao fechar as conexões no hub.
Não
[ cadeia de caracteres ]
reason
Consulta
O motivo do fechamento das conexões do cliente.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
Código
Descrição
Esquema
204
Sucesso
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/groups/{grupo}/:send
POST
Resumo
Transmitir uma mensagem para todos os clientes dentro do grupo de destino.
Transmitir uma mensagem para todos os clientes dentro do grupo de destino
POST /api/hubs/{hub}/groups/{group}/:send
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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
Excluído
Consulta
IDs de conexão excluídas
Não
[ cadeia de caracteres ]
api-version
Consulta
A versão das APIs REST.
Sim
string
mensagem
body
A mensagem de carga.
Sim
Mensagem de carga útil
Respostas
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
Resumo
Adicionar uma conexão ao grupo de destino.
Adicionar uma conexão ao grupo de destino
PUT /api/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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
DELETE
Resumo
Remover uma conexão do grupo de destino.
Remover uma conexão do grupo de destino
DELETE /api/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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
Resumo
Remover uma conexão de todos os grupos
Remover uma conexão de todos os grupos
DELETE /api/hubs/{hub}/connections/{connectionId}/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
connectionId
path
ID da conexão de destino
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/users/{usuário}
HEAD
Resumo
Verificar se há conexões de cliente conectadas para o usuário determinado
Verificar se há conexões de cliente conectadas para o usuário determinado
HEAD /api/hubs/{hub}/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
usuário
path
A ID do usuário.
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/users/{user}/:closeConnections
POST
Resumo
Feche conexões para o usuário específico.
Fechar conexões para o usuário específico
POST /api/hubs/{hub}/users/{user}/:closeConnections
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
A ID do usuário.
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
Excluído
Consulta
Exclua esses connectionIds ao fechar as conexões no hub.
Não
[ cadeia de caracteres ]
reason
Consulta
O motivo do fechamento das conexões do cliente.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
Código
Descrição
Esquema
204
Sucesso
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/users/{usuário}/:send
POST
Resumo
Transmitir uma mensagem para todos os clientes pertencentes ao usuário de destino.
Transmitir uma mensagem para todos os clientes pertencentes ao usuário de destino
POST /api/hubs/{hub}/users/{user}/:send
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
A ID do usuário.
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
mensagem
body
A mensagem de carga.
Sim
Mensagem de carga útil
Respostas
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
Resumo
Verificar se um usuário existe no grupo de destino.
Verificar se um usuário existe no grupo de destino
HEAD /api/hubs/{hub}/users/{user}/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
usuário
path
ID do usuário de destino
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
PUT
Resumo
Adicionar um usuário ao grupo de destino.
Adicionar um usuário ao grupo de destino
PUT /api/hubs/{hub}/users/{user}/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
usuário
path
ID do usuário de destino
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
ttl
Consulta
Especifica os segundos que o usuário existe no grupo. Se não estiver definido, o usuário vive no grupo por no máximo 1 ano. Se um usuário for adicionado a alguns grupos sem limitação de ttl, apenas os 100 grupos atualizados mais recentes serão reservados entre todos os grupos aos quais o usuário ingressou sem TTL. Se ttl = 0, somente as conexões conectadas atuais do usuário de destino serão adicionadas ao grupo de destino.
Não
Número inteiro
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
DELETE
Resumo
Remover um usuário do grupo de destino.
Remover um usuário do grupo de destino
DELETE /api/hubs/{hub}/users/{user}/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
usuário
path
ID do usuário de destino
Sim
string
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
Código
Descrição
Esquema
204
Sucesso
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
DELETE
Resumo
Remover um usuário de todos os grupos.
Remover um usuário de todos os grupos
DELETE /api/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
aplicativo
Consulta
Nome do aplicativo de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
Não
string
api-version
Consulta
A versão das APIs REST.
Sim
string
Respostas
Código
Descrição
Esquema
204
Sucesso
default
Resposta de erro
ErrorDetail
Modelos
ErrorDetail
O objeto de erro.
Nome
Digitar
Descrição
Obrigatório
código
string
Um de um conjunto definido pelo servidor de códigos de erro.
Não
message
string
Uma representação legível do erro.
Não
destino
string
O destino do erro.
Não
detalhes
[ ErrorDetail ]Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
Não
inner
InnerError Não
InnerError
Nome
Digitar
Descrição
Obrigatório
código
string
Um código de erro mais específico do que foi fornecido pelo erro que contém.
Não
inner
InnerError Não
PayloadMessage
Nome
Digitar
Descrição
Necessário
destino
string
Sim
argumentos
[ ]
Não
ServiceResponse
Nome
Digitar
Descrição
Obrigatório
código
cadeia de caracteres
Não
level
string
Enum: "Info", , "Warning""Error"Não
scope
string
Enum: , , , , "Request""Connection""User""Unknown""Group"Não
errorKind
string
Enum: "Unknown", , , "NotExisted""NotInGroup""Invalid"Não
message
string
Não
jsonObject
Não
isSuccess
boolean
Não