Job Router Administration Operations - Upsert Exception Policy

Referenz

Dienst:: Communication

API-Version:: 2023-11-01

Erstellt oder aktualisiert eine Ausnahmerichtlinie.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	URI Ihrer Kommunikationsressource
exceptionPolicyId	path	True	string	ID einer Ausnahmerichtlinie.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
If-Match		string	Die Anforderung sollte nur fortgesetzt werden, wenn eine Entität mit dieser Zeichenfolge übereinstimmt.
If-Unmodified-Since		string date-time-rfc7231	Die Anforderung sollte nur fortgesetzt werden, wenn die Entität nach diesem Zeitpunkt nicht geändert wurde.

Anforderungstext

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

Name	Typ	Beschreibung
exceptionRules	ExceptionRule[]	Eine Sammlung von Ausnahmeregeln für die Ausnahmerichtlinie.
name	string	Anzeigename dieser Richtlinie.

Antworten

Name	Typ	Beschreibung
200 OK	ExceptionPolicy	Die Anforderung ist erfolgreich. Header ETag: string Last-Modified: string
201 Created	ExceptionPolicy	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt. Header ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

ExceptionPolicy

Die Anforderung ist erfolgreich.

Header

ETag: string
Last-Modified: string

201 Created

ExceptionPolicy

Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.

Header

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Creates an exception policy

Updates an exception policy

Creates an exception policy

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Eine Aktion, die einen Auftrag als abgebrochen markiert.
ExceptionActionKind	Diskriminatoren für unterstützte Ausnahmeaktionstypen.
ExceptionPolicy	Eine Richtlinie, die Aktionen definiert, die ausgeführt werden sollen, wenn eine Ausnahme ausgelöst wird.
ExceptionPolicyCreateOrUpdate	Eine Richtlinie, die Aktionen definiert, die ausgeführt werden sollen, wenn eine Ausnahme ausgelöst wird.
ExceptionRule	Eine Regel, die Aktionen definiert, die auf einem bestimmten Trigger ausgeführt werden sollen.
ExceptionTriggerKind	Diskriminatoren für unterstützte Ausnahmetriggertypen.
LabelOperator	Beschreibt unterstützte Vorgänge für Bezeichnungswerte.
ManualReclassifyExceptionAction	Eine Aktion, die einen Auftrag manuell neu klassifiziert, indem die Warteschlangen-, Prioritäts- und Arbeitsauswahlen bereitgestellt werden.
QueueLengthExceptionTrigger	Trigger für eine Ausnahmeaktion bei Überschreitung der Warteschlangenlänge.
ReclassifyExceptionAction	Eine Aktion, mit der Bezeichnungen für einen Auftrag geändert und dann neu klassifiziert werden.
RouterWorkerSelector	Beschreibt eine Bedingung, die für eine Reihe von Bezeichnungen für die Arbeitsauswahl erfüllt werden muss.
RouterWorkerSelectorStatus	Beschreibt den Status einer Arbeitsauswahl.
WaitTimeExceptionTrigger	Trigger für eine Ausnahmeaktion beim Überschreiten der Wartezeit.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

CancelExceptionAction

Eine Aktion, die einen Auftrag als abgebrochen markiert.

Name	Typ	Beschreibung
dispositionCode	string	Gibt das Ergebnis eines Auftrags an, füllen Sie dieses Feld mit Ihren eigenen benutzerdefinierten Werten auf.
id	string	Eindeutige ID der Ausnahmeaktion.
kind	string: cancel	Der Typdiskriminator, der einen Untertyp von ExceptionAction beschreibt.
note	string	Beachten Sie, dass die Notizensammlung eines Auftrags mit dem aktuellen Zeitstempel angefügt wird.

ExceptionActionKind

Diskriminatoren für unterstützte Ausnahmeaktionstypen.

Name	Typ	Beschreibung
cancel	string	Diskriminatorwert für CancelExceptionAction.
manualReclassify	string	Diskriminatorwert für ManualReclassifyExceptionAction.
reclassify	string	Diskriminatorwert für ReclassifyExceptionAction.

ExceptionPolicy

Eine Richtlinie, die Aktionen definiert, die ausgeführt werden sollen, wenn eine Ausnahme ausgelöst wird.

Name	Typ	Beschreibung
etag	string	Das Entitätstag für diese Ressource.
exceptionRules	ExceptionRule[]	Eine Sammlung von Ausnahmeregeln für die Ausnahmerichtlinie.
id	string	ID einer Ausnahmerichtlinie.
name	string	Anzeigename dieser Richtlinie.

ExceptionPolicyCreateOrUpdate

Eine Richtlinie, die Aktionen definiert, die ausgeführt werden sollen, wenn eine Ausnahme ausgelöst wird.

Name	Typ	Beschreibung
exceptionRules	ExceptionRule[]	Eine Sammlung von Ausnahmeregeln für die Ausnahmerichtlinie.
name	string	Anzeigename dieser Richtlinie.

ExceptionRule

Eine Regel, die Aktionen definiert, die auf einem bestimmten Trigger ausgeführt werden sollen.

Name	Typ	Beschreibung
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Eine Sammlung von Aktionen, die ausgeführt werden sollen, sobald die Ausnahme ausgelöst wird.
id	string	ID einer Ausnahmeregel.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	Der Trigger für diese Ausnahmeregel.

ExceptionTriggerKind

Diskriminatoren für unterstützte Ausnahmetriggertypen.

Name	Typ	Beschreibung
queueLength	string	Diskriminatorwert für QueueLengthExceptionTrigger.
waitTime	string	Diskriminatorwert für WaitTimeExceptionTrigger.

LabelOperator

Beschreibt unterstützte Vorgänge für Bezeichnungswerte.

Name	Typ	Beschreibung
equal	string	Gleich.
greaterThan	string	Größer als.
greaterThanOrEqual	string	Größer oder gleich.
lessThan	string	Weniger als.
lessThanOrEqual	string	Kleiner oder gleich.
notEqual	string	Nicht gleich.

ManualReclassifyExceptionAction

Eine Aktion, die einen Auftrag manuell neu klassifiziert, indem die Warteschlangen-, Prioritäts- und Arbeitsauswahlen bereitgestellt werden.

Name	Typ	Beschreibung
id	string	Eindeutige ID der Ausnahmeaktion.
kind	string: manualReclassify	Der Typdiskriminator, der einen Untertyp von ExceptionAction beschreibt.
priority	integer	Priorität aktualisiert.
queueId	string	QueueId wurde aktualisiert.
workerSelectors	RouterWorkerSelector[]	WorkerSelectors wurde aktualisiert.

QueueLengthExceptionTrigger

Trigger für eine Ausnahmeaktion bei Überschreitung der Warteschlangenlänge.

Name	Typ	Beschreibung
kind	string: queueLength	Der Typdiskriminator, der einen Untertyp von ExceptionTrigger beschreibt.
threshold	integer	Schwellenwert für die Anzahl der Aufträge, die in der Warteschlange voraus sind, damit dieser Auslöser ausgelöst wird.

ReclassifyExceptionAction

Eine Aktion, mit der Bezeichnungen für einen Auftrag geändert und dann neu klassifiziert werden.

Name	Typ	Beschreibung
classificationPolicyId	string	Die neue Klassifizierungsrichtlinie, die Warteschlangen-, Prioritäts- und Arbeitsauswahlen bestimmt.
id	string	Eindeutige ID der Ausnahmeaktion.
kind	string: reclassify	Der Typdiskriminator, der einen Untertyp von ExceptionAction beschreibt.
labelsToUpsert		Wörterbuch, das die Bezeichnungen enthält, die in Schlüsselwertpaaren aktualisiert (oder hinzugefügt werden sollen, falls nicht vorhanden). Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.

RouterWorkerSelector

Beschreibt eine Bedingung, die für eine Reihe von Bezeichnungen für die Arbeitsauswahl erfüllt werden muss.

Name	Typ	Beschreibung
expedite	boolean	Verschiebt einen Auftrag an die Vorderseite der Warteschlange, solange diese Auswahl aktiv ist.
expiresAfterSeconds	number	Beschreibt, wie lange dieser Bezeichnungsmarkierer in Sekunden gültig ist.
expiresAt	string	Die Uhrzeit, zu der diese Arbeitsauswahl in UTC abläuft.
key	string	Der Bezeichnungsschlüssel, nach dem abgefragt werden soll.
labelOperator	LabelOperator	Beschreibt, wie der Wert der Beschriftung mit dem für die Arbeitsauswahl definierten Wert verglichen wird.
status	RouterWorkerSelectorStatus	Status der Arbeitsauswahl.
value		Der Wert, der mit dem tatsächlichen Beschriftungswert mit dem angegebenen Operator verglichen werden soll. Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.

RouterWorkerSelectorStatus

Beschreibt den Status einer Arbeitsauswahl.

Name	Typ	Beschreibung
active	string	Die Arbeitsauswahl ist gültig.
expired	string	Die Arbeitsauswahl ist ungültig.

WaitTimeExceptionTrigger

Trigger für eine Ausnahmeaktion beim Überschreiten der Wartezeit.

Name	Typ	Beschreibung
kind	string: waitTime	Der Typdiskriminator, der einen Untertyp von ExceptionTrigger beschreibt.
thresholdSeconds	number	Schwellenwert für Wartezeit für diesen Auslöser.

Freigeben über

Job Router Administration Operations - Upsert Exception Policy

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

AadOauth2Auth

Bereiche

Beispiele

Creates an exception policy

Beispielanforderung

Beispiel für eine Antwort

Updates an exception policy

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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

Zusätzliche Ressourcen