Send To Connection - Send To Connection

Hizmet:

Azure Web PubSub Service

API Sürümü:

2024-12-01

İstek gövdesi içindeki içeriği belirli bir bağlantıya gönderin.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
connectionId	path	True	string minLength: 1	Bağlantı kimliği.
endpoint	path	True	string (uri)	Web PubSub hizmeti örneği için HTTP veya HTTPS uç noktası
hub	path	True	string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$	Alfabetik karakterlerle başlaması ve yalnızca alfasayısal karakterler veya alt çizgi içermesi gereken hedef hub adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
messageTtlSeconds	query		integer (int32) maximum: 300	Hizmete gönderilen iletiler için saniye cinsinden yaşam süresi (TTL) değeri. 0 varsayılan değerdir, bu da iletinin süresinin hiçbir zaman dolmadığı anlamına gelir. 300 maksimum değerdir. Bu parametre sıfır değilse, belirtilen TTL içinde istemci tarafından tüketilmeyen iletiler hizmet tarafından bırakılır. Bu parametre, istemcinin bant genişliği sınırlı olduğunda yardımcı olabilir.

İstek Gövdesi

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

Name	Tür	Description
message	string (byte)	Yük gövdesi.

Yanıtlar

Name	Tür	Description
204 No Content		Bu istek için gönderilecek içerik yok, ancak başlıklar yararlı olabilir.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

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

Örnekler

SendToConnection

Örnek isteği

HTTP

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

"TWVzc2FnZSB0byBzZW5k"

Örnek yanıt

Durum kodu:

204

Tanımlar

Name	Description
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Object

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tarafından tanımlanan hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bildirilen bu hataya neden olan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hata hakkında geçerli nesneden daha fazla bilgi içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Object

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Object

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tür	Description
code	string	Sunucu tarafından tanımlanan hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.