Job Router Administration Operations - Get Queue

Serviço:

Communication

Versão da API:

2023-11-01

Recupera uma fila existente por ID.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Uri do seu recurso de comunicação
queueId	path	True	string	ID de uma fila.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	RouterQueue	A solicitação foi bem-sucedida. Cabeçalhos ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

AadOauth2Auth

O fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Retrieves an existing queue by Id

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue	Uma fila que pode conter trabalhos a serem roteado.

Azure.Core.Foundations.Error

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

RouterQueue

Uma fila que pode conter trabalhos a serem roteado.

Nome	Tipo	Description
distributionPolicyId	string	ID de uma política de distribuição que determinará como um trabalho é distribuído aos trabalhadores.
etag	string	A marca de entidade para esse recurso.
exceptionPolicyId	string	ID de uma política de exceção que determina várias regras de escalonamento de trabalho.
id	string	ID de uma fila.
labels		Um conjunto de pares chave/valor que estão identificando atributos usados pelos mecanismos de regras para tomar decisões. Os valores devem ser valores primitivos - número, cadeia de caracteres, booliano.
name	string	Nome amigável dessa fila.