Job Router Administration Operations - Upsert Exception Policy

Referencia

Servicio:: Communication

Versión de la API:: 2023-11-01

Crea o actualiza una directiva de excepciones.

PATCH {endpoint}/routing/exceptionPolicies/{exceptionPolicyId}?api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Uri del recurso de comunicación
exceptionPolicyId	path	True	string	Identificador de una directiva de excepción.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Requerido	Tipo	Description
If-Match		string	La solicitud solo debe continuar si una entidad coincide con esta cadena.
If-Unmodified-Since		string date-time-rfc7231	La solicitud solo debe continuar si la entidad no se modificó después de este tiempo.

Cuerpo de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Tipo	Description
exceptionRules	ExceptionRule[]	Colección de reglas de excepción en la directiva de excepciones.
name	string	Nombre descriptivo de esta directiva.

Respuestas

Nombre	Tipo	Description
200 OK	ExceptionPolicy	La solicitud se ha realizado correctamente. Encabezados ETag: string Last-Modified: string
201 Created	ExceptionPolicy	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado. Encabezados ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

ExceptionPolicy

La solicitud se ha realizado correctamente.

Encabezados

ETag: string
Last-Modified: string

201 Created

ExceptionPolicy

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Encabezados

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Creates an exception policy

Updates an exception policy

Creates an exception policy

Solicitud de ejemplo

HTTP

PATCH https://contoso.westus.communications.azure.com/routing/exceptionPolicies/cf1cda69-6f41-45ac-b252-213293f1b1cb?api-version=2023-11-01

{
  "name": "Main",
  "exceptionRules": [
    {
      "id": "MaxWaitTimeExceeded",
      "actions": [
        {
          "kind": "reclassify",
          "classificationPolicyId": "Main",
          "labelsToUpsert": {
            "escalated": true
          }
        }
      ],
      "trigger": {
        "kind": "waitTime",
        "thresholdSeconds": 20
      }
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "id": "cf1cda69-6f41-45ac-b252-213293f1b1cb",
  "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"
}

status code:: 201

{
  "id": "cf1cda69-6f41-45ac-b252-213293f1b1cb",
  "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"
}

Updates an exception policy

Solicitud de ejemplo

HTTP

PATCH https://contoso.westus.communications.azure.com/routing/exceptionPolicies/cf1cda69-6f41-45ac-b252-213293f1b1cb?api-version=2023-11-01

{
  "name": "Main test",
  "exceptionRules": [
    {
      "id": "MaxWaitTimeExceeded",
      "actions": [
        {
          "kind": "reclassify",
          "classificationPolicyId": "Main",
          "labelsToUpsert": {
            "escalated": true
          }
        }
      ],
      "trigger": {
        "kind": "waitTime",
        "thresholdSeconds": 20
      }
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "id": "cf1cda69-6f41-45ac-b252-213293f1b1cb",
  "name": "Main test",
  "exceptionRules": [
    {
      "id": "MaxWaitTimeExceeded",
      "trigger": {
        "kind": "waitTime",
        "thresholdSeconds": 20
      },
      "actions": [
        {
          "id": "babd4f6f-916e-4e91-9c89-e0bb05a2c425",
          "kind": "reclassify",
          "classificationPolicyId": "Main",
          "labelsToUpsert": {
            "escalated": true
          }
        }
      ]
    }
  ],
  "etag": "etag"
}

status code:: 201

{
  "id": "cf1cda69-6f41-45ac-b252-213293f1b1cb",
  "name": "Main test",
  "exceptionRules": [
    {
      "id": "MaxWaitTimeExceeded",
      "trigger": {
        "kind": "waitTime",
        "thresholdSeconds": 20
      },
      "actions": [
        {
          "id": "babd4f6f-916e-4e91-9c89-e0bb05a2c425",
          "kind": "reclassify",
          "classificationPolicyId": "Main",
          "labelsToUpsert": {
            "escalated": true
          }
        }
      ]
    }
  ],
  "etag": "etag"
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Acción que marca un trabajo como cancelado.
ExceptionActionKind	Discriminadores para los tipos de acción de excepción admitidos.
ExceptionPolicy	Directiva que define las acciones que se van a ejecutar cuando se desencadena la excepción.
ExceptionPolicyCreateOrUpdate	Directiva que define las acciones que se van a ejecutar cuando se desencadena la excepción.
ExceptionRule	Regla que define las acciones que se van a ejecutar en un desencadenador específico.
ExceptionTriggerKind	Discriminadores para los tipos de desencadenadores de excepciones admitidos.
LabelOperator	Describe las operaciones admitidas en los valores de etiqueta.
ManualReclassifyExceptionAction	Una acción que vuelve a clasificar manualmente un trabajo proporcionando los selectores de cola, prioridad y trabajo.
QueueLengthExceptionTrigger	Desencadenador para una acción de excepción al superar la longitud de la cola.
ReclassifyExceptionAction	Una acción que modifica las etiquetas de un trabajo y, a continuación, la vuelve a clasificar.
RouterWorkerSelector	Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de trabajo.
RouterWorkerSelectorStatus	Describe el estado de un selector de trabajo.
WaitTimeExceptionTrigger	Desencadenador para una acción de excepción al superar el tiempo de espera.

Azure.Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

CancelExceptionAction

Acción que marca un trabajo como cancelado.

Nombre	Tipo	Description
dispositionCode	string	Indica el resultado de un trabajo, rellene este campo con sus propios valores personalizados.
id	string	Identificador único de la acción de excepción.
kind	string: cancel	El discriminador de tipo que describe un subtipo de ExceptionAction.
note	string	Nota que se anexará a la colección de notas de un trabajo con la marca de tiempo actual.

ExceptionActionKind

Discriminadores para los tipos de acción de excepción admitidos.

Nombre	Tipo	Description
cancel	string	Valor discriminador para CancelExceptionAction.
manualReclassify	string	Valor discriminador de ManualReclassifyExceptionAction.
reclassify	string	Valor discriminador para ReclassifyExceptionAction.

ExceptionPolicy

Directiva que define las acciones que se van a ejecutar cuando se desencadena la excepción.

Nombre	Tipo	Description
etag	string	Etiqueta de entidad para este recurso.
exceptionRules	ExceptionRule[]	Colección de reglas de excepción en la directiva de excepciones.
id	string	Identificador de una directiva de excepción.
name	string	Nombre descriptivo de esta directiva.

ExceptionPolicyCreateOrUpdate

Directiva que define las acciones que se van a ejecutar cuando se desencadena la excepción.

Nombre	Tipo	Description
exceptionRules	ExceptionRule[]	Colección de reglas de excepción en la directiva de excepciones.
name	string	Nombre descriptivo de esta directiva.

ExceptionRule

Regla que define las acciones que se van a ejecutar en un desencadenador específico.

Nombre	Tipo	Description
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Colección de acciones que se realizarán una vez que se desencadene la excepción.
id	string	Identificador de una regla de excepción.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	Desencadenador para esta regla de excepción.

ExceptionTriggerKind

Discriminadores para los tipos de desencadenadores de excepciones admitidos.

Nombre	Tipo	Description
queueLength	string	Valor discriminador de QueueLengthExceptionTrigger.
waitTime	string	Valor discriminador de WaitTimeExceptionTrigger.

LabelOperator

Describe las operaciones admitidas en los valores de etiqueta.

Nombre	Tipo	Description
equal	string	Igual.
greaterThan	string	Mayor que.
greaterThanOrEqual	string	Mayor o igual que.
lessThan	string	Menos que.
lessThanOrEqual	string	Menor o igual que.
notEqual	string	No es igual.

ManualReclassifyExceptionAction

Una acción que vuelve a clasificar manualmente un trabajo proporcionando los selectores de cola, prioridad y trabajo.

Nombre	Tipo	Description
id	string	Identificador único de la acción de excepción.
kind	string: manualReclassify	El discriminador de tipo que describe un subtipo de ExceptionAction.
priority	integer	Prioridad actualizada.
queueId	string	QueueId actualizado.
workerSelectors	RouterWorkerSelector[]	WorkerSelectors actualizados.

QueueLengthExceptionTrigger

Desencadenador para una acción de excepción al superar la longitud de la cola.

Nombre	Tipo	Description
kind	string: queueLength	El discriminador de tipo que describe un subtipo de ExceptionTrigger.
threshold	integer	Umbral de número de trabajos por delante en la cola para que se active este desencadenador.

ReclassifyExceptionAction

Una acción que modifica las etiquetas de un trabajo y, a continuación, la vuelve a clasificar.

Nombre	Tipo	Description
classificationPolicyId	string	La nueva directiva de clasificación que determinará los selectores de cola, prioridad y trabajo.
id	string	Identificador único de la acción de excepción.
kind	string: reclassify	El discriminador de tipo que describe un subtipo de ExceptionAction.
labelsToUpsert		Diccionario que contiene las etiquetas que se van a actualizar (o agregar si no existen) en pares clave-valor. Los valores deben ser valores primitivos: número, cadena, booleano.

RouterWorkerSelector

Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de trabajo.

Nombre	Tipo	Description
expedite	boolean	Inserta un trabajo en la parte delantera de la cola siempre que este selector esté activo.
expiresAfterSeconds	number	Describe cuánto tiempo es válido este selector de etiquetas en segundos.
expiresAt	string	Hora a la que expira este selector de trabajo en UTC.
key	string	Clave de etiqueta en la que se va a consultar.
labelOperator	LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor definido en el selector de trabajo.
status	RouterWorkerSelectorStatus	Estado del selector de trabajo.
value		Valor que se va a comparar con el valor de etiqueta real con el operador especificado. Los valores deben ser valores primitivos: número, cadena, booleano.

RouterWorkerSelectorStatus

Describe el estado de un selector de trabajo.

Nombre	Tipo	Description
active	string	El selector de trabajo es válido.
expired	string	El selector de trabajo no es válido.

WaitTimeExceptionTrigger

Desencadenador para una acción de excepción al superar el tiempo de espera.

Nombre	Tipo	Description
kind	string: waitTime	El discriminador de tipo que describe un subtipo de ExceptionTrigger.
thresholdSeconds	number	Umbral de tiempo de espera para este desencadenador.

Compartir a través de

Job Router Administration Operations - Upsert Exception Policy

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

AadOauth2Auth

Ámbitos

Ejemplos

Creates an exception policy

Solicitud de ejemplo

Respuesta de muestra

Updates an exception policy

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CancelExceptionAction

ExceptionActionKind

ExceptionPolicy

ExceptionPolicyCreateOrUpdate

ExceptionRule

ExceptionTriggerKind

LabelOperator

ManualReclassifyExceptionAction

QueueLengthExceptionTrigger

ReclassifyExceptionAction

RouterWorkerSelector

RouterWorkerSelectorStatus

WaitTimeExceptionTrigger

Recursos adicionales