Job Router Administration Operations - Upsert Exception Policy

Service:

Communication

API-versie:

2023-11-01

Hiermee maakt of werkt u een uitzonderingsbeleid bij.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	URI van uw communicatieresource
exceptionPolicyId	path	True	string	Id van een uitzonderingsbeleid.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
If-Match		string	De aanvraag mag alleen worden voortgezet als een entiteit overeenkomt met deze tekenreeks.
If-Unmodified-Since		string date-time-rfc7231	De aanvraag moet alleen worden voortgezet als de entiteit na deze tijd niet is gewijzigd.

Aanvraagbody

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

Name	Type	Description
exceptionRules	ExceptionRule[]	Een verzameling uitzonderingsregels voor het uitzonderingsbeleid.
name	string	Beschrijvende naam van dit beleid.

Antwoorden

Name	Type	Description
200 OK	ExceptionPolicy	De aanvraag is voltooid. Kopteksten ETag: string Last-Modified: string
201 Created	ExceptionPolicy	De aanvraag is geslaagd en er is een nieuwe resource gemaakt. Kopteksten ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

AadOauth2Auth

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Creates an exception policy

Updates an exception policy

Creates an exception policy

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Een actie waarmee een taak wordt gemarkeerd als geannuleerd.
ExceptionActionKind	Discriminators voor ondersteunde uitzonderingsactietypen.
ExceptionPolicy	Een beleid dat acties definieert die moeten worden uitgevoerd wanneer een uitzondering wordt geactiveerd.
ExceptionPolicyCreateOrUpdate	Een beleid dat acties definieert die moeten worden uitgevoerd wanneer een uitzondering wordt geactiveerd.
ExceptionRule	Een regel waarmee acties worden gedefinieerd die moeten worden uitgevoerd op een specifieke trigger.
ExceptionTriggerKind	Discriminators voor ondersteunde typen uitzonderingstriggers.
LabelOperator	Beschrijft ondersteunde bewerkingen op labelwaarden.
ManualReclassifyExceptionAction	Een actie die een taak handmatig opnieuw classificeert door de wachtrij, prioriteit en werkrolkiezers op te geven.
QueueLengthExceptionTrigger	Trigger voor een uitzonderingsactie voor het overschrijden van de wachtrijlengte.
ReclassifyExceptionAction	Een actie waarmee labels voor een taak worden gewijzigd en deze vervolgens opnieuw classificeert.
RouterWorkerSelector	Beschrijft een voorwaarde waaraan moet worden voldaan voor een set labels voor werkrolselectie.
RouterWorkerSelectorStatus	Beschrijft de status van een werkrolkiezer.
WaitTimeExceptionTrigger	Trigger voor een uitzonderingsactie voor het overschrijden van de wachttijd.

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

CancelExceptionAction

Een actie waarmee een taak wordt gemarkeerd als geannuleerd.

Name	Type	Description
dispositionCode	string	Geeft het resultaat van een taak aan, vul dit veld in met uw eigen aangepaste waarden.
id	string	Unieke id van de uitzonderingsactie.
kind	string: cancel	Het typediscriminator dat een subtype ExceptionAction beschrijft.
note	string	Een notitie die wordt toegevoegd aan de notitiesverzameling van een taak met de huidige tijdstempel.

ExceptionActionKind

Discriminators voor ondersteunde uitzonderingsactietypen.

Name	Type	Description
cancel	string	Discriminatorwaarde voor CancelExceptionAction.
manualReclassify	string	Discriminatorwaarde voor ManualReclassifyExceptionAction.
reclassify	string	Discriminatorwaarde voor ReclassifyExceptionAction.

ExceptionPolicy

Een beleid dat acties definieert die moeten worden uitgevoerd wanneer een uitzondering wordt geactiveerd.

Name	Type	Description
etag	string	De entiteitstag voor deze resource.
exceptionRules	ExceptionRule[]	Een verzameling uitzonderingsregels voor het uitzonderingsbeleid.
id	string	Id van een uitzonderingsbeleid.
name	string	Beschrijvende naam van dit beleid.

ExceptionPolicyCreateOrUpdate

Een beleid dat acties definieert die moeten worden uitgevoerd wanneer een uitzondering wordt geactiveerd.

Name	Type	Description
exceptionRules	ExceptionRule[]	Een verzameling uitzonderingsregels voor het uitzonderingsbeleid.
name	string	Beschrijvende naam van dit beleid.

ExceptionRule

Een regel waarmee acties worden gedefinieerd die moeten worden uitgevoerd op een specifieke trigger.

Name	Type	Description
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Een verzameling acties die moeten worden uitgevoerd zodra de uitzondering wordt geactiveerd.
id	string	Id van een uitzonderingsregel.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	De trigger voor deze uitzonderingsregel.

ExceptionTriggerKind

Discriminators voor ondersteunde typen uitzonderingstriggers.

Name	Type	Description
queueLength	string	Discriminatorwaarde voor QueueLengthExceptionTrigger.
waitTime	string	Discriminatorwaarde voor WaitTimeExceptionTrigger.

LabelOperator

Beschrijft ondersteunde bewerkingen op labelwaarden.

Name	Type	Description
equal	string	Gelijk.
greaterThan	string	Groter dan.
greaterThanOrEqual	string	Groter dan of gelijk aan.
lessThan	string	Kleiner dan.
lessThanOrEqual	string	Kleiner dan of gelijk aan.
notEqual	string	Niet gelijk aan.

ManualReclassifyExceptionAction

Een actie die een taak handmatig opnieuw classificeert door de wachtrij, prioriteit en werkrolkiezers op te geven.

Name	Type	Description
id	string	Unieke id van de uitzonderingsactie.
kind	string: manualReclassify	Het typediscriminator dat een subtype ExceptionAction beschrijft.
priority	integer	Prioriteit bijgewerkt.
queueId	string	QueueId bijgewerkt.
workerSelectors	RouterWorkerSelector[]	WorkerSelectors bijgewerkt.

QueueLengthExceptionTrigger

Trigger voor een uitzonderingsactie voor het overschrijden van de wachtrijlengte.

Name	Type	Description
kind	string: queueLength	Het typediscriminator dat een subtype ExceptionTrigger beschrijft.
threshold	integer	Drempelwaarde van het aantal taken dat in de wachtrij staat om deze trigger te activeren.

ReclassifyExceptionAction

Een actie waarmee labels voor een taak worden gewijzigd en deze vervolgens opnieuw classificeert.

Name	Type	Description
classificationPolicyId	string	Het nieuwe classificatiebeleid waarmee de wachtrij, prioriteit en werkrolselectors worden bepaald.
id	string	Unieke id van de uitzonderingsactie.
kind	string: reclassify	Het typediscriminator dat een subtype ExceptionAction beschrijft.
labelsToUpsert		Woordenlijst met de labels die moeten worden bijgewerkt (of als deze niet aanwezig zijn) in sleutel-waardeparen. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

RouterWorkerSelector

Beschrijft een voorwaarde waaraan moet worden voldaan voor een set labels voor werkrolselectie.

Name	Type	Description
expedite	boolean	Hiermee wordt een taak naar de voorzijde van de wachtrij gepusht zolang deze selector actief is.
expiresAfterSeconds	number	Beschrijft hoe lang deze labelkiezer in seconden geldig is.
expiresAt	string	Het tijdstip waarop deze werkrolkiezer in UTC verloopt.
key	string	De labelsleutel om een query op uit te voeren.
labelOperator	LabelOperator	Beschrijft hoe de waarde van het label wordt vergeleken met de waarde die is gedefinieerd in de werkrolkiezer.
status	RouterWorkerSelectorStatus	Status van de werkrolkiezer.
value		De waarde die moet worden vergeleken met de werkelijke labelwaarde met de opgegeven operator. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

RouterWorkerSelectorStatus

Beschrijft de status van een werkrolkiezer.

Name	Type	Description
active	string	De werkrolkiezer is geldig.
expired	string	Werkrolkiezer is ongeldig.

WaitTimeExceptionTrigger

Trigger voor een uitzonderingsactie voor het overschrijden van de wachttijd.

Name	Type	Description
kind	string: waitTime	Het typediscriminator dat een subtype ExceptionTrigger beschrijft.
thresholdSeconds	number	Drempelwaarde voor wachttijd voor deze trigger.