API REST do Serviço Azure SignalR
Artigo 07/03/2024
1 contribuidor
Comentários
Neste artigo
Versão: 2022-06-01
APIs disponíveis
/api/saúde
HEAD
Resumo
Obtenha o status de integridade do serviço.
Obter o estado de funcionamento do serviço
HEAD /api/health
Parâmetros
Nome
Localizada em
Description
Obrigatório
Esquema
api-version
query
A versão das APIs REST.
Sim
string
Respostas
Código
Description
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
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
Exclua esses connectionIds ao fechar as conexões no hub.
Não
[ string ]
reason
query
O motivo de fechar as conexões do cliente.
Não
string
api-version
query
A versão das APIs REST.
Sim
string
Respostas
Código
Description
Esquema
204
Com êxito
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/:enviar
POST
Resumo
Difunda 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
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
Ids de conexão excluídos
Não
[ string ]
api-version
query
A versão das APIs REST.
Sim
string
mensagem
corpo
A mensagem de carga útil.
Sim
PayloadMessage
Respostas
/api/hubs/{hub}/connections/{connectionId}
HEAD
Resumo
Verifique se a conexão com o connectionId fornecido existe
Verifique se a conexão com o connectionId fornecido existe
HEAD /api/hubs/{hub}/connections/{connectionId}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
DELETE
Resumo
Feche a conexão do cliente
Feche a conexão do cliente
DELETE /api/hubs/{hub}/connections/{connectionId}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
O motivo do fechamento da conexão.
Não
string
api-version
query
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
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
mensagem
corpo
A mensagem de carga útil.
Sim
PayloadMessage
Respostas
/api/hubs/{hub}/groups/{group}
HEAD
Resumo
Verifique se há alguma conexão de cliente dentro de um determinado grupo
Verifique se há alguma conexão de cliente dentro de um determinado grupo
HEAD /api/hubs/{hub}/groups/{group}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
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
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
Exclua esses connectionIds ao fechar as conexões no hub.
Não
[ string ]
reason
query
O motivo de fechar as conexões do cliente.
Não
string
api-version
query
A versão das APIs REST.
Sim
string
Respostas
Código
Description
Esquema
204
Com êxito
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/groups/{group}/:enviar
POST
Resumo
Difundir uma mensagem para todos os clientes dentro do grupo-alvo.
Transmitir uma mensagem a todos os clientes dentro do grupo-alvo
POST /api/hubs/{hub}/groups/{group}/:send
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
Ids de conexão excluídos
Não
[ string ]
api-version
query
A versão das APIs REST.
Sim
string
mensagem
corpo
A mensagem de carga útil.
Sim
PayloadMessage
Respostas
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
Resumo
Adicione uma conexão ao grupo-alvo.
Adicionar uma ligação ao grupo-alvo
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
DELETE
Resumo
Remova uma conexão do grupo-alvo.
Remover uma ligação do grupo-alvo
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
Resumo
Remover uma ligação de todos os grupos
Remover uma ligação de todos os grupos
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
ID da conexão de destino
Sim
string
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
/api/hubs/{hub}/users/{usuário}
HEAD
Resumo
Verifique se há alguma conexão de cliente conectada para um determinado usuário
Verifique se há alguma conexão de cliente conectada para um determinado usuário
HEAD /api/hubs/{hub}/users/{user}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
O ID do usuário.
Sim
string
aplicação
query
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
query
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
Localizada em
Description
Obrigatório
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
O ID do usuário.
Sim
string
aplicação
query
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
query
Exclua esses connectionIds ao fechar as conexões no hub.
Não
[ string ]
reason
query
O motivo de fechar as conexões do cliente.
Não
string
api-version
query
A versão das APIs REST.
Sim
string
Respostas
Código
Description
Esquema
204
Com êxito
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/users/{user}/:enviar
POST
Resumo
Transmitir uma mensagem para todos os clientes pertencem ao usuário alvo.
Transmitir uma mensagem para todos os clientes pertencem ao usuário alvo
POST /api/hubs/{hub}/users/{user}/:send
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
O ID do usuário.
Sim
string
aplicação
query
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
query
A versão das APIs REST.
Sim
string
mensagem
corpo
A mensagem de carga útil.
Sim
PayloadMessage
Respostas
/api/hubs/{hub}/users/{usuário}/groups/{group}
HEAD
Resumo
Verifique se existe um utilizador no grupo-alvo.
Verificar se existe um utilizador no grupo-alvo
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
PUT
Resumo
Adicione um usuário ao grupo-alvo.
Adicionar um utilizador ao grupo-alvo
PUT /api/hubs/{hub}/users/{user}/groups/{group}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
Especifica os segundos em que o usuário existe no grupo. Se não estiver definido, o usuário vive no grupo por 1 ano no máximo. 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 alvo serão adicionadas ao grupo-alvo.
Não
integer
api-version
query
A versão das APIs REST.
Sim
string
Respostas
DELETE
Resumo
Remova um usuário do grupo-alvo.
Remover um utilizador do grupo-alvo
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
Código
Description
Esquema
204
Com êxito
default
Resposta de erro
ErrorDetail
/api/hubs/{hub}/users/{user}/groups
DELETE
Resumo
Remova um usuário de todos os grupos.
Remover um utilizador de todos os grupos
DELETE /api/hubs/{hub}/users/{user}/groups
Parâmetros
Nome
Localizada em
Description
Obrigatório
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
aplicação
query
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
query
A versão das APIs REST.
Sim
string
Respostas
Código
Description
Esquema
204
Com êxito
default
Resposta de erro
ErrorDetail
Modelos
ErrorDetail
O objeto de erro.
Nome
Tipo
Descrição
Obrigatório
code
string
Um de um conjunto de códigos de erro definido pelo servidor.
Não
mensagem
string
Uma representação legível por humanos 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
interior
InnerError Não
InnerError
Nome
Tipo
Descrição
Obrigatório
code
string
Um código de erro mais específico do que foi fornecido pelo erro que contém.
Não
interior
InnerError Não
PayloadMessage
Nome
Tipo
Descrição
Obrigatório
destino
string
Sim
Argumentos
[ ]
Não
ServiceResponse
Nome
Tipo
Descrição
Obrigatório
code
string
Não
nível
string
Enum: "Info", "Warning", "Error"Não
âmbito
string
Enum: "Unknown", "Request", "Connection", , "User", "Group"Não
errorKind
string
Enum: "Unknown", "NotExisted", "NotInGroup", , "Invalid"Não
mensagem
string
Não
jsonObjeto
Não
isSuccess
boolean
Não