Job Router Administration Operations - Get Queue

Hizmet:

Communication

API Sürümü:

2023-11-01

Var olan bir kuyruğu kimliğine göre alır.

GET {endpoint}/routing/queues/{queueId}?api-version=2023-11-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	İletişim kaynağınızın Uri'sini
queueId	path	True	string	Kuyruğun kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	RouterQueue	İstek başarılı oldu. Üst Bilgiler ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

AadOauth2Auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

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

Örnekler

Retrieves an existing queue by Id

Örnek isteği

HTTP

GET https://contoso.westus.communications.azure.com/routing/queues/MainQueue?api-version=2023-11-01

Örnek yanıt

Durum kodu:

200

{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

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.
RouterQueue	Yönlendirilecek işleri içerebilen bir kuyruk.

Azure.Core.Foundations.Error

Nesne

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Nesne

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

Nesne

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 tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

RouterQueue

Nesne

Yönlendirilecek işleri içerebilen bir kuyruk.

Name	Tür	Description
distributionPolicyId	string	bir işin çalışanlara nasıl dağıtılacağını belirleyecek dağıtım ilkesinin kimliği.
etag	string	Bu kaynağın varlık etiketi.
exceptionPolicyId	string	Çeşitli iş yükseltme kurallarını belirleyen bir özel durum ilkesinin kimliği.
id	string	Kuyruğun kimliği.
labels		Kural altyapıları tarafından karar almak için kullanılan öznitelikleri tanımlayan bir dizi anahtar/değer çifti. Değerler ilkel değerler olmalıdır: sayı, dize, boole.
name	string	Bu kuyruğun kolay adı.