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 de URI

Nome	Em	Obrigató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 de serviço do 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 ser usada para esta operação.
messageTtlSeconds	query		integer (int32) maximum: 300	O valor de vida útil (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. Esse parâmetro pode ajudar quando a largura de banda do cliente é limitada.

Corpo da solicitação

Media Types: "application/json", "application/octet-stream", "text/plain"

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

Respostas

Nome	Tipo	Description
204 No Content		Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

OAuth2Auth

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

Escopos

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

Exemplos

SendToConnection

Solicitação de exemplo

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

Resposta de exemplo

Código de status:

204

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta contendo detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.