Job Router Administration Operations - Upsert Exception Policy

Szolgáltatás:: Communication

API verzió:: 2023-11-01

Létrehoz vagy frissít egy kivételszabályzatot.

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

URI paraméterek

Név	Ban	Szükséges	Típus	Leírás
endpoint	path	True	string (uri)	A kommunikációs erőforrás URI-ja
exceptionPolicyId	path	True	string	Kivételszabályzat azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérés fejléce

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

Név	Szükséges	Típus	Leírás
If-Match		string	A kérés csak akkor folytatódhat, ha egy entitás megfelel ennek a sztringnek.
If-Unmodified-Since		string (date-time-rfc7231)	A kérés csak akkor folytatódhat, ha az entitást ez után nem módosították.

Kérő Testület

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

Név	Típus	Leírás
exceptionRules	ExceptionRule[]	A kivételszabályzat kivételszabályainak gyűjteménye.
name	string	A szabályzat rövid neve.

Válaszok

Név	Típus	Leírás
200 OK	ExceptionPolicy	A kérés sikeres volt. Fejlécek ETag: string Last-Modified: string
201 Created	ExceptionPolicy	A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre. Fejlécek ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

Név

Típus

Leírás

200 OK

ExceptionPolicy

A kérés sikeres volt.

Fejlécek

ETag: string
Last-Modified: string

201 Created

ExceptionPolicy

A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre.

Fejlécek

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

AadOauth2Auth

Az Azure Active Directory OAuth2 flow

Típus: oauth2
Flow: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

Név	Leírás
https://communication.azure.com/.default

Példák

Creates an exception policy

Updates an exception policy

Creates an exception policy

Mintakérés

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

Mintaválasz

Állapotkód:: 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"
}

Állapotkód:: 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

Mintakérés

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

Mintaválasz

Állapotkód:: 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"
}

Állapotkód:: 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"
}

Meghatározások

Név	Leírás
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.ErrorResponse	Hibaadatokat tartalmazó válasz.
Azure.Core.Foundations.InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.
CancelExceptionAction	Olyan művelet, amely megszakítottként jelöl meg egy feladatot.
ExceptionActionKind	Diszkriminatívak a támogatott kivételművelet-típusok esetében.
ExceptionPolicy	Olyan szabályzat, amely meghatározza a kivétel aktiválásakor végrehajtandó műveleteket.
ExceptionPolicyCreateOrUpdate	Olyan szabályzat, amely meghatározza a kivétel aktiválásakor végrehajtandó műveleteket.
ExceptionRule	Egy szabály, amely egy adott eseményindítón végrehajtandó műveleteket határoz meg.
ExceptionTriggerKind	Diszkriminatívak a támogatott kivételindító-típusok esetében.
LabelOperator	A címkeértékek támogatott műveleteit ismerteti.
ManualReclassifyExceptionAction	Olyan művelet, amely manuálisan átsorol egy feladatot az üzenetsor, a prioritás és a feldolgozóválasztók megadásával.
QueueLengthExceptionTrigger	Az üzenetsor hosszának túllépése esetén a kivételművelet aktiválása.
ReclassifyExceptionAction	Olyan művelet, amely módosítja a címkéket egy feladaton, majd újraosztályozza azt.
RouterWorkerSelector	Olyan feltételt ír le, amelyet a munkavégzők kiválasztásához szükséges címkékkel kell teljesíteni.
RouterWorkerSelectorStatus	A feldolgozóválasztó állapotát ismerteti.
WaitTimeExceptionTrigger	Kivételművelet aktiválása a várakozási idő túllépésekor.

Azure.Core.Foundations.Error

Tárgy

A hibaobjektum.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

Azure.Core.Foundations.ErrorResponse

Tárgy

Hibaadatokat tartalmazó válasz.

Név	Típus	Leírás
error	Azure.Core.Foundations.Error	A hibaobjektum.

Azure.Core.Foundations.InnerError

Tárgy

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. Az Azure REST API irányelvei szerint – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Név	Típus	Leírás
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

CancelExceptionAction

Tárgy

Olyan művelet, amely megszakítottként jelöl meg egy feladatot.

Név	Típus	Leírás
dispositionCode	string	Egy feladat eredményét jelzi, és töltse ki ezt a mezőt a saját egyéni értékeivel.
id	string	A kivételművelet egyedi azonosítója.
kind	string: cancel	A ExceptionAction altípusát leíró típuskriminatív.
note	string	Egy megjegyzés, amely hozzá lesz fűzve egy feladat jegyzetgyűjteményéhez az aktuális időbélyeggel.

ExceptionActionKind

Felsorolás

Diszkriminatívak a támogatott kivételművelet-típusok esetében.

Érték	Leírás
cancel	A CancelExceptionAction diszkriminatív értéke.
manualReclassify	A ManualReclassifyExceptionAction diszkriminatív értéke.
reclassify	A ReclassifyExceptionAction diszkriminatív értéke.

ExceptionPolicy

Tárgy

Olyan szabályzat, amely meghatározza a kivétel aktiválásakor végrehajtandó műveleteket.

Név	Típus	Leírás
etag	string	Az erőforrás entitáscímkéje.
exceptionRules	ExceptionRule[]	A kivételszabályzat kivételszabályainak gyűjteménye.
id	string	Kivételszabályzat azonosítója.
name	string	A szabályzat rövid neve.

ExceptionPolicyCreateOrUpdate

Tárgy

Olyan szabályzat, amely meghatározza a kivétel aktiválásakor végrehajtandó műveleteket.

Név	Típus	Leírás
exceptionRules	ExceptionRule[]	A kivételszabályzat kivételszabályainak gyűjteménye.
name	string	A szabályzat rövid neve.

ExceptionRule

Tárgy

Egy szabály, amely egy adott eseményindítón végrehajtandó műveleteket határoz meg.

Név	Típus	Leírás
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	A kivétel aktiválása után végrehajtandó műveletek gyűjteménye.
id	string	Kivételszabály azonosítója.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	A kivételszabály eseményindítója.

ExceptionTriggerKind

Felsorolás

Diszkriminatívak a támogatott kivételindító-típusok esetében.

Érték	Leírás
queueLength	A QueueLengthExceptionTrigger diszkriminatív értéke.
waitTime	A WaitTimeExceptionTrigger diszkriminatív értéke.

LabelOperator

Felsorolás

A címkeértékek támogatott műveleteit ismerteti.

Érték	Leírás
equal	Egyenlő.
notEqual	Nem egyenlő.
lessThan	Kevesebb, mint.
lessThanOrEqual	Kisebb vagy egyenlő.
greaterThan	Nagyobb, mint.
greaterThanOrEqual	Nagyobb vagy egyenlő.

ManualReclassifyExceptionAction

Tárgy

Olyan művelet, amely manuálisan átsorol egy feladatot az üzenetsor, a prioritás és a feldolgozóválasztók megadásával.

Név	Típus	Leírás
id	string	A kivételművelet egyedi azonosítója.
kind	string: manualReclassify	A ExceptionAction altípusát leíró típuskriminatív.
priority	integer (int32)	Frissített prioritás.
queueId	string	Frissített QueueId.
workerSelectors	RouterWorkerSelector[]	Frissített WorkerSelectors.

QueueLengthExceptionTrigger

Tárgy

Az üzenetsor hosszának túllépése esetén a kivételművelet aktiválása.

Név	Típus	Leírás
kind	string: queueLength	A ExceptionTrigger altípusát leíró típuskriminatív.
threshold	integer (int32)	Az üzenetsor azon feladatainak küszöbértéke, amely az eseményindító indításához szükséges.

ReclassifyExceptionAction

Tárgy

Olyan művelet, amely módosítja a címkéket egy feladaton, majd újraosztályozza azt.

Név	Típus	Leírás
classificationPolicyId	string	Az új besorolási szabályzat, amely meghatározza az üzenetsort, a prioritást és a feldolgozóválasztókat.
id	string	A kivételművelet egyedi azonosítója.
kind	string: reclassify	A ExceptionAction altípusát leíró típuskriminatív.
labelsToUpsert		A kulcs-érték párokban frissítendő (vagy ha nem létező) címkéket tartalmazó szótár. Az értékeknek primitív értékeknek kell lenniük : szám, sztring, logikai érték.

RouterWorkerSelector

Tárgy

Olyan feltételt ír le, amelyet a munkavégzők kiválasztásához szükséges címkékkel kell teljesíteni.

Név	Típus	Leírás
expedite	boolean	Leküld egy feladatot az üzenetsor elejére, amíg ez a választó aktív.
expiresAfterSeconds	number (double)	Azt ismerteti, hogy a címkeválasztó mennyi ideig érvényes másodpercekben.
expiresAt	string (date-time)	Az időpont, amikor ez a feldolgozó-választó UTC-ben lejár.
key	string	A lekérdezendő címkekulcs.
labelOperator	LabelOperator	Azt ismerteti, hogyan hasonlítja össze a címke értékét a feldolgozóválasztóban definiált értékkel.
status	RouterWorkerSelectorStatus	A feldolgozóválasztó állapota.
value		Az az érték, amelyet össze kell hasonlítani a tényleges címkeértékkel az adott operátorral. Az értékeknek primitív értékeknek kell lenniük : szám, sztring, logikai érték.

RouterWorkerSelectorStatus

Felsorolás

A feldolgozóválasztó állapotát ismerteti.

Érték	Leírás
active	A munkavégző választó érvényes.
expired	A munkavégző választó érvénytelen.

WaitTimeExceptionTrigger

Tárgy

Kivételművelet aktiválása a várakozási idő túllépésekor.

Név	Típus	Leírás
kind	string: waitTime	A ExceptionTrigger altípusát leíró típuskriminatív.
thresholdSeconds	number (double)	Az eseményindító várakozási idejének küszöbértéke.