Job Router Administration Operations - Get Queue

Layanan:

Communication

Versi API:

2023-11-01

Mengambil antrean yang ada berdasarkan Id.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Uri sumber daya Komunikasi Anda
queueId	path	True	string	Id antrean.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	RouterQueue	Permintaan telah berhasil. Header ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

AadOauth2Auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Cakupan

Nama	Deskripsi
https://communication.azure.com/.default

Contoh

Retrieves an existing queue by Id

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
RouterQueue	Antrean yang dapat berisi pekerjaan yang akan dirutekan.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

RouterQueue

Objek

Antrean yang dapat berisi pekerjaan yang akan dirutekan.

Nama	Jenis	Deskripsi
distributionPolicyId	string	Id kebijakan distribusi yang akan menentukan bagaimana pekerjaan didistribusikan kepada pekerja.
etag	string	Tag entitas untuk sumber daya ini.
exceptionPolicyId	string	Id kebijakan pengecualian yang menentukan berbagai aturan eskalasi pekerjaan.
id	string	Id antrean.
labels		Sekumpulan pasangan kunci/nilai yang mengidentifikasi atribut yang digunakan oleh mesin aturan untuk membuat keputusan. Nilai harus berupa nilai primitif - angka, string, boolean.
name	string	Nama yang mudah diingat dari antrean ini.