Job Router Administration Operations - Get Exception Policy

Referência

Serviço:: Communication

Versão da API:: 2023-11-01

Recupera uma política de exceção existente por Id.

GET {endpoint}/routing/exceptionPolicies/{exceptionPolicyId}?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
exceptionPolicyId	path	True	string	ID de uma política de exceção.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ExceptionPolicy	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

Nome

Tipo

Description

200 OK

ExceptionPolicy

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 exception policy by Id

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "id": "MainExceptionPolicy",
  "name": "Main",
  "exceptionRules": [
    {
      "id": "MaxWaitTimeExceeded",
      "trigger": {
        "kind": "waitTime",
        "thresholdSeconds": 20
      },
      "actions": [
        {
          "id": "babd4f6f-916e-4e91-9c89-e0bb05a2c425",
          "kind": "reclassify",
          "classificationPolicyId": "Main",
          "labelsToUpsert": {
            "escalated": true
          }
        }
      ]
    }
  ],
  "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.
CancelExceptionAction	Uma ação que marca um trabalho como cancelado.
ExceptionActionKind	Discriminadores para tipos de ação de exceção com suporte.
ExceptionPolicy	Uma política que define ações a serem executadas quando a exceção é disparada.
ExceptionRule	Uma regra que define ações a serem executadas em um gatilho específico.
ExceptionTriggerKind	Discriminadores para tipos de gatilho de exceção com suporte.
LabelOperator	Descreve as operações com suporte em valores de rótulo.
ManualReclassifyExceptionAction	Uma ação que reclassifica manualmente um trabalho fornecendo a fila, a prioridade e os seletores de trabalho.
QueueLengthExceptionTrigger	Gatilho para uma ação de exceção ao exceder o comprimento da fila.
ReclassifyExceptionAction	Uma ação que modifica rótulos em um trabalho e, em seguida, o reclassifica.
RouterWorkerSelector	Descreve uma condição que deve ser atendida em relação a um conjunto de rótulos para seleção de trabalho.
RouterWorkerSelectorStatus	Descreve o status de um seletor de trabalho.
WaitTimeExceptionTrigger	Disparar para uma ação de exceção ao exceder o tempo de espera.

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.

CancelExceptionAction

Uma ação que marca um trabalho como cancelado.

Nome	Tipo	Description
dispositionCode	string	Indica o resultado de um trabalho, preencha esse campo com seus próprios valores personalizados.
id	string	ID exclusiva da ação de exceção.
kind	string: cancel	O tipo discriminatório que descreve um subtipo de ExceptionAction.
note	string	Uma observação que será acrescentada à coleção de anotações de um trabalho com o carimbo de data/hora atual.

ExceptionActionKind

Discriminadores para tipos de ação de exceção com suporte.

Nome	Tipo	Description
cancel	string	Valor discriminatório para CancelExceptionAction.
manualReclassify	string	Valor discriminatório para ManualReclassifyExceptionAction.
reclassify	string	Valor discriminatório para ReclassifyExceptionAction.

ExceptionPolicy

Uma política que define ações a serem executadas quando a exceção é disparada.

Nome	Tipo	Description
etag	string	A marca de entidade para esse recurso.
exceptionRules	ExceptionRule[]	Uma coleção de regras de exceção na política de exceção.
id	string	ID de uma política de exceção.
name	string	Nome amigável desta política.

ExceptionRule

Uma regra que define ações a serem executadas em um gatilho específico.

Nome	Tipo	Description
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Uma coleção de ações a serem executadas quando a exceção for disparada.
id	string	ID de uma regra de exceção.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	O gatilho para essa regra de exceção.

ExceptionTriggerKind

Discriminadores para tipos de gatilho de exceção com suporte.

Nome	Tipo	Description
queueLength	string	Valor discriminatório para QueueLengthExceptionTrigger.
waitTime	string	Valor discriminatório para WaitTimeExceptionTrigger.

LabelOperator

Descreve as operações com suporte em valores de rótulo.

Nome	Tipo	Description
equal	string	Igual.
greaterThan	string	Maior que.
greaterThanOrEqual	string	Maior ou igual.
lessThan	string	Menor que.
lessThanOrEqual	string	Menor ou igual.
notEqual	string	Não é igual.

ManualReclassifyExceptionAction

Uma ação que reclassifica manualmente um trabalho fornecendo a fila, a prioridade e os seletores de trabalho.

Nome	Tipo	Description
id	string	ID exclusiva da ação de exceção.
kind	string: manualReclassify	O tipo discriminatório que descreve um subtipo de ExceptionAction.
priority	integer	Prioridade atualizada.
queueId	string	QueueId atualizada.
workerSelectors	RouterWorkerSelector[]	WorkerSelectors atualizados.

QueueLengthExceptionTrigger

Gatilho para uma ação de exceção ao exceder o comprimento da fila.

Nome	Tipo	Description
kind	string: queueLength	O tipo discriminatório que descreve um subtipo de ExceptionTrigger.
threshold	integer	Limite de número de trabalhos à frente na fila para que esse gatilho seja acionado.

ReclassifyExceptionAction

Uma ação que modifica rótulos em um trabalho e, em seguida, o reclassifica.

Nome	Tipo	Description
classificationPolicyId	string	A nova política de classificação que determinará os seletores de fila, prioridade e trabalho.
id	string	ID exclusiva da ação de exceção.
kind	string: reclassify	O tipo discriminatório que descreve um subtipo de ExceptionAction.
labelsToUpsert		Dicionário que contém os rótulos a serem atualizados (ou adicionados se não existirem) em pares chave-valor. Os valores devem ser valores primitivos - número, cadeia de caracteres, booliano.

RouterWorkerSelector

Descreve uma condição que deve ser atendida em relação a um conjunto de rótulos para seleção de trabalho.

Nome	Tipo	Description
expedite	boolean	Envia um trabalho para a frente da fila enquanto esse seletor estiver ativo.
expiresAfterSeconds	number	Descreve por quanto tempo esse seletor de rótulo é válido em segundos.
expiresAt	string	O momento em que esse seletor de trabalho expira em UTC.
key	string	A chave de rótulo com a qual consultar.
labelOperator	LabelOperator	Descreve como o valor do rótulo é comparado ao valor definido no seletor de trabalho.
status	RouterWorkerSelectorStatus	Status do seletor de trabalho.
value		O valor a ser comparado com o valor real do rótulo com o operador fornecido. Os valores devem ser valores primitivos - número, cadeia de caracteres, booliano.

RouterWorkerSelectorStatus

Descreve o status de um seletor de trabalho.

Nome	Tipo	Description
active	string	O seletor de trabalho é válido.
expired	string	O seletor de trabalho não é válido.

WaitTimeExceptionTrigger

Disparar para uma ação de exceção ao exceder o tempo de espera.

Nome	Tipo	Description
kind	string: waitTime	O tipo discriminatório que descreve um subtipo de ExceptionTrigger.
thresholdSeconds	number	Limite de tempo de espera para esse gatilho.

Compartilhar via

Job Router Administration Operations - Get Exception Policy

Parâmetros de URI

Respostas

Segurança

AadOauth2Auth

Escopos

Exemplos

Retrieves an existing exception policy by Id

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CancelExceptionAction

ExceptionActionKind

ExceptionPolicy

ExceptionRule

ExceptionTriggerKind

LabelOperator

ManualReclassifyExceptionAction

QueueLengthExceptionTrigger

ReclassifyExceptionAction

RouterWorkerSelector

RouterWorkerSelectorStatus

WaitTimeExceptionTrigger

Recursos adicionais