Send To Connection - Send To Connection

Serviço:

Azure Web PubSub Service

Versão da API:

2024-12-01

Envie o conteúdo dentro do corpo da solicitação para a conexão específica.

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01

Com parâmetros opcionais:

POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-12-01&messageTtlSeconds={messageTtlSeconds}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
connectionId	path	True	string minLength: 1	O ID da conexão.
endpoint	path	True	string (uri)	Ponto de extremidade HTTP ou HTTPS para a instância do serviço Web PubSub
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
messageTtlSeconds	query		integer (int32) minimum: 0 maximum: 300	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/json", "application/octet-stream", "text/plain"

Name	Tipo	Description
message	string (byte)	O corpo da carga útil.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.
Other Status Codes	ErrorDetail	A resposta de erro. Cabeçalhos x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://webpubsub.azure.com/.default

Exemplos

SendToConnection

Pedido de amostra

HTTP

POST {endpoint}/api/hubs/hub1/connections/connection1/:send?api-version=2024-12-01&messageTtlSeconds=15

"TWVzc2FnZSB0byBzZW5k"

Resposta da amostra

Código de estado:

202

Definições

Name	Description
ErrorDetail	O objeto de erro.
InnerError	Detalhe de erro interno.

ErrorDetail

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	ErrorDetail[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
inner	InnerError	Um objeto que contém informações mais específicas sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

InnerError

Object

Detalhe de erro interno.

Name	Tipo	Description
code	string	Um código de erro mais específico do que o fornecido pelo erro de contenção.
inner	InnerError	Erro interno.