Job Router Administration Operations - Upsert Exception Policy

Référence

Service:: Communication

Version d'API:: 2023-11-01

Crée ou met à jour une stratégie d’exception.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URI de votre ressource communication
exceptionPolicyId	path	True	string	ID d’une stratégie d’exception.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

En-tête de la demande

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

Nom	Obligatoire	Type	Description
If-Match		string	La requête ne doit continuer que si une entité correspond à cette chaîne.
If-Unmodified-Since		string date-time-rfc7231	La requête ne doit continuer que si l’entité n’a pas été modifiée après cette période.

Corps de la demande

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

Nom	Type	Description
exceptionRules	ExceptionRule[]	Collection de règles d’exception sur la stratégie d’exception.
name	string	Nom convivial de cette stratégie.

Réponses

Nom	Type	Description
200 OK	ExceptionPolicy	La demande a réussi. En-têtes ETag: string Last-Modified: string
201 Created	ExceptionPolicy	La requête a réussi et une nouvelle ressource a été créée en conséquence. En-têtes ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

ExceptionPolicy

La demande a réussi.

En-têtes

ETag: string
Last-Modified: string

201 Created

ExceptionPolicy

La requête a réussi et une nouvelle ressource a été créée en conséquence.

En-têtes

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

AadOauth2Auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

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

Exemples

Creates an exception policy

Updates an exception policy

Creates an exception policy

Exemple de requête

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
      }
    }
  ]
}

Exemple de réponse

Code d’état:: 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"
}

Code d’état:: 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

Exemple de requête

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
      }
    }
  ]
}

Exemple de réponse

Code d’état:: 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"
}

Code d’état:: 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"
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Action qui marque un travail comme annulé.
ExceptionActionKind	Discriminateurs pour les types d’actions d’exception pris en charge.
ExceptionPolicy	Stratégie qui définit les actions à exécuter lorsque l’exception est déclenchée.
ExceptionPolicyCreateOrUpdate	Stratégie qui définit les actions à exécuter lorsque l’exception est déclenchée.
ExceptionRule	Règle qui définit les actions à exécuter sur un déclencheur spécifique.
ExceptionTriggerKind	Discriminateurs pour les types de déclencheurs d’exception pris en charge.
LabelOperator	Décrit les opérations prises en charge sur les valeurs d’étiquette.
ManualReclassifyExceptionAction	Action qui reclassifie manuellement un travail en fournissant les sélecteurs de file d’attente, de priorité et de travail.
QueueLengthExceptionTrigger	Déclencheur d’une action d’exception sur le dépassement de la longueur de la file d’attente.
ReclassifyExceptionAction	Action qui modifie les étiquettes d’un travail, puis la reclassifie.
RouterWorkerSelector	Décrit une condition qui doit être remplie par rapport à un ensemble d’étiquettes pour la sélection de travail.
RouterWorkerSelectorStatus	Décrit l’état d’un sélecteur de travail.
WaitTimeExceptionTrigger	Déclencher une action d’exception sur le dépassement du temps d’attente.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

CancelExceptionAction

Action qui marque un travail comme annulé.

Nom	Type	Description
dispositionCode	string	Indique le résultat d’un travail, renseignez ce champ avec vos propres valeurs personnalisées.
id	string	ID unique de l’action d’exception.
kind	string: cancel	Discriminateur de type décrivant un sous-type d’ExceptionAction.
note	string	Remarque qui sera ajoutée à la collection de notes d’un travail avec l’horodatage actuel.

ExceptionActionKind

Discriminateurs pour les types d’actions d’exception pris en charge.

Nom	Type	Description
cancel	string	Valeur de discrimination pour CancelExceptionAction.
manualReclassify	string	Valeur de discriminateur pour ManualReclassifyExceptionAction.
reclassify	string	Valeur de discriminateur pour ReclassifyExceptionAction.

ExceptionPolicy

Stratégie qui définit les actions à exécuter lorsque l’exception est déclenchée.

Nom	Type	Description
etag	string	Balise d’entité pour cette ressource.
exceptionRules	ExceptionRule[]	Collection de règles d’exception sur la stratégie d’exception.
id	string	ID d’une stratégie d’exception.
name	string	Nom convivial de cette stratégie.

ExceptionPolicyCreateOrUpdate

Stratégie qui définit les actions à exécuter lorsque l’exception est déclenchée.

Nom	Type	Description
exceptionRules	ExceptionRule[]	Collection de règles d’exception sur la stratégie d’exception.
name	string	Nom convivial de cette stratégie.

ExceptionRule

Règle qui définit les actions à exécuter sur un déclencheur spécifique.

Nom	Type	Description
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Collection d’actions à effectuer une fois l’exception déclenchée.
id	string	ID d’une règle d’exception.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	Déclencheur de cette règle d’exception.

ExceptionTriggerKind

Discriminateurs pour les types de déclencheurs d’exception pris en charge.

Nom	Type	Description
queueLength	string	Valeur de discriminateur pour QueueLengthExceptionTrigger.
waitTime	string	Valeur de discriminateur pour WaitTimeExceptionTrigger.

LabelOperator

Décrit les opérations prises en charge sur les valeurs d’étiquette.

Nom	Type	Description
equal	string	Égal.
greaterThan	string	Plus grand que.
greaterThanOrEqual	string	Supérieur ou égal.
lessThan	string	Moins de.
lessThanOrEqual	string	Inférieur ou égal.
notEqual	string	Pas égal.

ManualReclassifyExceptionAction

Action qui reclassifie manuellement un travail en fournissant les sélecteurs de file d’attente, de priorité et de travail.

Nom	Type	Description
id	string	ID unique de l’action d’exception.
kind	string: manualReclassify	Discriminateur de type décrivant un sous-type d’ExceptionAction.
priority	integer	Priorité mise à jour.
queueId	string	Mise à jour de QueueId.
workerSelectors	RouterWorkerSelector[]	Mise à jour de WorkerSelectors.

QueueLengthExceptionTrigger

Déclencheur d’une action d’exception sur le dépassement de la longueur de la file d’attente.

Nom	Type	Description
kind	string: queueLength	Discriminateur de type décrivant un sous-type d’ExceptionTrigger.
threshold	integer	Seuil du nombre de travaux en avance dans la file d’attente pour que ce déclencheur se déclenche.

ReclassifyExceptionAction

Action qui modifie les étiquettes d’un travail, puis la reclassifie.

Nom	Type	Description
classificationPolicyId	string	Nouvelle stratégie de classification qui détermine les sélecteurs de file d’attente, de priorité et de travail.
id	string	ID unique de l’action d’exception.
kind	string: reclassify	Discriminateur de type décrivant un sous-type d’ExceptionAction.
labelsToUpsert		Dictionnaire contenant les étiquettes à mettre à jour (ou ajouter s’il n’existe pas) dans des paires clé-valeur. Les valeurs doivent être primitives : nombre, chaîne, booléen.

RouterWorkerSelector

Décrit une condition qui doit être remplie par rapport à un ensemble d’étiquettes pour la sélection de travail.

Nom	Type	Description
expedite	boolean	Envoie un travail à l’avant de la file d’attente tant que ce sélecteur est actif.
expiresAfterSeconds	number	Décrit la durée pendant laquelle ce sélecteur d’étiquette est valide en secondes.
expiresAt	string	Heure à laquelle ce sélecteur de travail expire au format UTC.
key	string	Clé d’étiquette à interroger.
labelOperator	LabelOperator	Décrit comment la valeur de l’étiquette est comparée à la valeur définie sur le sélecteur de travail.
status	RouterWorkerSelectorStatus	État du sélecteur de travail.
value		Valeur à comparer à la valeur d’étiquette réelle avec l’opérateur donné. Les valeurs doivent être primitives : nombre, chaîne, booléen.

RouterWorkerSelectorStatus

Décrit l’état d’un sélecteur de travail.

Nom	Type	Description
active	string	Le sélecteur de travail est valide.
expired	string	Le sélecteur de travail n’est pas valide.

WaitTimeExceptionTrigger

Déclencher une action d’exception sur le dépassement du temps d’attente.

Nom	Type	Description
kind	string: waitTime	Discriminateur de type décrivant un sous-type d’ExceptionTrigger.
thresholdSeconds	number	Seuil du délai d’attente pour ce déclencheur.

Partager via

Job Router Administration Operations - Upsert Exception Policy

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AadOauth2Auth

Étendues

Exemples

Creates an exception policy

Exemple de requête

Exemple de réponse

Updates an exception policy

Exemple de requête

Exemple de réponse

Définitions

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

Ressources supplémentaires