Web Pub Sub - Send To All
Difunda o conteúdo dentro do corpo da solicitação para todas as conexões de cliente conectadas.
POST {endpoint}/api/hubs/{hub}/:send?api-version=2024-01-01
POST {endpoint}/api/hubs/{hub}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}
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. |
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: |
api-version
|
query | True |
string |
A versão das APIs REST. |
excluded
|
query |
string[] |
IDs de conexão excluídos. |
|
filter
|
query |
string |
Seguindo a sintaxe do filtro OData para filtrar os assinantes que recebem as mensagens. |
|
message
|
query |
integer int32 |
O valor de tempo de vida (TTL) em segundos para mensagens enviadas ao serviço. 0 é o valor padrão, o que significa que a mensagem nunca expira. 300 é o valor máximo. Se esse parâmetro for diferente de zero, as mensagens que não forem consumidas pelo cliente dentro do TTL especificado serão descartadas pelo serviço. Este parâmetro pode ajudar quando a largura de banda do cliente é limitada. |
Corpo do Pedido
Media Types: "application/octet-stream", "text/plain", "application/json"
Name | Tipo | Description |
---|---|---|
message |
string |
O corpo da carga útil. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
A mensagem é aceite. O serviço segue o padrão de disparar e esquecer ao enviar mensagens. |
|
Other Status Codes |
Resposta de erro Cabeçalhos x-ms-error-code: string |
Exemplos
WebPubSub_SendToAll
Pedido de amostra
POST {endpoint}/api/hubs/hub1/:send?api-version=2024-01-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15
"Message to send"
Resposta da amostra
Definições
Name | Description |
---|---|
Error |
O objeto de erro. |
Inner |
ErrorDetail
O objeto de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
inner | ||
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 |