Job Router Administration Operations - Get Queue

Tjänst:

Communication

API-versionen:

2023-11-01

Hämtar en befintlig kö efter ID.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
endpoint	path	True	string (uri)	Uri för din kommunikationsresurs
queueId	path	True	string	ID för en kö.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	RouterQueue	Begäran har slutförts. Headers ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Säkerhet

AadOauth2Auth

Azure Active Directory OAuth2-flödet

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

Scope

Namn	Beskrivning
https://communication.azure.com/.default

Exempel

Retrieves an existing queue by Id

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Namn	Beskrivning
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
RouterQueue	En kö som kan innehålla jobb som ska dirigeras.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Namn	Typ	Beskrivning
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

RouterQueue

Objekt

En kö som kan innehålla jobb som ska dirigeras.

Namn	Typ	Beskrivning
distributionPolicyId	string	ID för en distributionsprincip som avgör hur ett jobb distribueras till arbetare.
etag	string	Entitetstaggen för den här resursen.
exceptionPolicyId	string	ID för en undantagsprincip som bestämmer olika regler för eskalering av jobb.
id	string	ID för en kö.
labels		En uppsättning nyckel/värde-par som identifierar attribut som används av regelmotorerna för att fatta beslut. Värden måste vara primitiva värden – tal, sträng, booleskt värde.
name	string	Eget namn på den här kön.