Job Router Administration Operations - Get Queue

Dienst:

Communication

API-Version:

2023-11-01

Ruft eine vorhandene Warteschlange nach ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	URI Ihrer Kommunikationsressource
queueId	path	True	string	ID einer Warteschlange.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	RouterQueue	Die Anforderung ist erfolgreich. Header ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Retrieves an existing queue by Id

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
RouterQueue	Eine Warteschlange, die Aufträge enthalten kann, die weitergeleitet werden sollen.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

RouterQueue

Objekt

Eine Warteschlange, die Aufträge enthalten kann, die weitergeleitet werden sollen.

Name	Typ	Beschreibung
distributionPolicyId	string	ID einer Verteilungsrichtlinie, die bestimmt, wie ein Auftrag an Mitarbeiter verteilt wird.
etag	string	Das Entitätstag für diese Ressource.
exceptionPolicyId	string	ID einer Ausnahmerichtlinie, die verschiedene Regeln für die Auftragseskalation bestimmt.
id	string	ID einer Warteschlange.
labels		Eine Reihe von Schlüssel-Wert-Paaren, die Attribute identifizieren, die von den Regelmodulen verwendet werden, um Entscheidungen zu treffen. Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.
name	string	Anzeigename dieser Warteschlange.