Job Router Administration Operations - Get Exception Policy

Référence

Service:: Communication

Version d'API:: 2023-11-01

Récupère une stratégie d’exception existante par ID.

GET {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.

Réponses

Nom	Type	Description
200 OK	ExceptionPolicy	La demande a réussi. 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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Exemples

Retrieves an existing exception policy by Id

Exemple de requête

HTTP

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

Exemple de réponse

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

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 relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Action qui marque une tâche comme annulée.
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.
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 en cas de dépassement de la longueur de la file d’attente.
ReclassifyExceptionAction	Action qui modifie les étiquettes d’un travail, puis le reclassifie.
RouterWorkerSelector	Décrit une condition qui doit être remplie par rapport à un ensemble d’étiquettes pour la sélection de worker.
RouterWorkerSelectorStatus	Décrit la status d’un sélecteur de travail.
WaitTimeExceptionTrigger	Déclencher une action d’exception en cas de dépassement du temps d’attente.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur les 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 relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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

CancelExceptionAction

Action qui marque une tâche comme annulée.

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	Note 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 du discriminateur pour CancelExceptionAction.
manualReclassify	string	Valeur du discriminateur pour ManualReclassifyExceptionAction.
reclassify	string	Valeur du 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.

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 du discriminateur pour QueueLengthExceptionTrigger.
waitTime	string	Valeur du 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	Supérieur à.
greaterThanOrEqual	string	Supérieur ou égal à.
lessThan	string	Inférieur à.
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	Id de file d’attente mis à jour.
workerSelectors	RouterWorkerSelector[]	WorkerSelectors mis à jour.

QueueLengthExceptionTrigger

Déclencheur d’une action d’exception en cas de 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 à venir dans la file d’attente vers pour que ce déclencheur se déclenche.

ReclassifyExceptionAction

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

Nom	Type	Description
classificationPolicyId	string	Nouvelle stratégie de classification qui déterminera 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 si elles n’existent pas) dans les 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 worker.

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 de validité de ce sélecteur d’étiquette en secondes.
expiresAt	string	Heure à laquelle ce sélecteur de travail expire en UTC.
key	string	Clé d’étiquette sur laquelle interroger.
labelOperator	LabelOperator	Décrit comment la valeur de l’étiquette est comparée à la valeur définie sur le sélecteur worker.
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 la status 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 en cas de 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 temps d’attente pour ce déclencheur.

Partager via

Job Router Administration Operations - Get Exception Policy

Paramètres URI

Réponses

Exemples

Retrieves an existing exception policy by Id

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

ExceptionRule

ExceptionTriggerKind

LabelOperator

ManualReclassifyExceptionAction

QueueLengthExceptionTrigger

ReclassifyExceptionAction

RouterWorkerSelector

RouterWorkerSelectorStatus

WaitTimeExceptionTrigger

Ressources supplémentaires