Job Router Administration Operations - Upsert Exception Policy

Riferimento

Servizio:: Communication

Versione API:: 2023-11-01

Crea o aggiorna un criterio di eccezione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URI della risorsa di comunicazione
exceptionPolicyId	path	True	string	ID di un criterio di eccezione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
If-Match		string	La richiesta deve continuare solo se un'entità corrisponde a questa stringa.
If-Unmodified-Since		string date-time-rfc7231	La richiesta deve continuare solo se l'entità non è stata modificata dopo questa volta.

Corpo della richiesta

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

Nome	Tipo	Descrizione
exceptionRules	ExceptionRule[]	Raccolta di regole di eccezione per i criteri di eccezione.
name	string	Nome descrittivo di questo criterio.

Risposte

Nome	Tipo	Descrizione
200 OK	ExceptionPolicy	La richiesta ha avuto esito positivo. Intestazioni ETag: string Last-Modified: string
201 Created	ExceptionPolicy	La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa. Intestazioni ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

ExceptionPolicy

La richiesta ha avuto esito positivo.

Intestazioni

ETag: string
Last-Modified: string

201 Created

ExceptionPolicy

La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa.

Intestazioni

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

AadOauth2Auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://communication.azure.com/.default

Esempio

Creates an exception policy

Updates an exception policy

Creates an exception policy

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Azione che contrassegna un processo come annullato.
ExceptionActionKind	Discriminanti per i tipi di azione di eccezione supportati.
ExceptionPolicy	Criteri che definiscono le azioni da eseguire quando vengono attivate le eccezioni.
ExceptionPolicyCreateOrUpdate	Criteri che definiscono le azioni da eseguire quando vengono attivate le eccezioni.
ExceptionRule	Regola che definisce le azioni da eseguire su un trigger specifico.
ExceptionTriggerKind	Discriminanti per i tipi di trigger di eccezione supportati.
LabelOperator	Vengono descritte le operazioni supportate sui valori delle etichette.
ManualReclassifyExceptionAction	Azione che riclassifica manualmente un processo fornendo la coda, la priorità e i selettori di lavoro.
QueueLengthExceptionTrigger	Attivare un'azione di eccezione in caso di superamento della lunghezza della coda.
ReclassifyExceptionAction	Azione che modifica le etichette in un processo e quindi la riclassifica.
RouterWorkerSelector	Descrive una condizione che deve essere soddisfatta in base a un set di etichette per la selezione del ruolo di lavoro.
RouterWorkerSelectorStatus	Descrive lo stato di un selettore di lavoro.
WaitTimeExceptionTrigger	Attivare un'azione di eccezione in caso di superamento del tempo di attesa.

Azure.Core.Foundations.Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

CancelExceptionAction

Azione che contrassegna un processo come annullato.

Nome	Tipo	Descrizione
dispositionCode	string	Indica il risultato di un processo, popolare questo campo con i propri valori personalizzati.
id	string	ID univoco dell'azione di eccezione.
kind	string: cancel	Il discriminante del tipo che descrive un sottotipo di ExceptionAction.
note	string	Si noti che verrà aggiunto alla raccolta note di un processo con il timestamp corrente.

ExceptionActionKind

Discriminanti per i tipi di azione di eccezione supportati.

Nome	Tipo	Descrizione
cancel	string	Valore discriminatorio per CancelExceptionAction.
manualReclassify	string	Valore discriminatorio per ManualReclassifyExceptionAction.
reclassify	string	Valore discriminatorio per ReclassifyExceptionAction.

ExceptionPolicy

Criteri che definiscono le azioni da eseguire quando vengono attivate le eccezioni.

Nome	Tipo	Descrizione
etag	string	Tag di entità per questa risorsa.
exceptionRules	ExceptionRule[]	Raccolta di regole di eccezione per i criteri di eccezione.
id	string	ID di un criterio di eccezione.
name	string	Nome descrittivo di questo criterio.

ExceptionPolicyCreateOrUpdate

Criteri che definiscono le azioni da eseguire quando vengono attivate le eccezioni.

Nome	Tipo	Descrizione
exceptionRules	ExceptionRule[]	Raccolta di regole di eccezione per i criteri di eccezione.
name	string	Nome descrittivo di questo criterio.

ExceptionRule

Regola che definisce le azioni da eseguire su un trigger specifico.

Nome	Tipo	Descrizione
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Raccolta di azioni da eseguire dopo l'attivazione dell'eccezione.
id	string	ID di una regola di eccezione.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	Trigger per questa regola di eccezione.

ExceptionTriggerKind

Discriminanti per i tipi di trigger di eccezione supportati.

Nome	Tipo	Descrizione
queueLength	string	Valore discriminatorio per QueueLengthExceptionTrigger.
waitTime	string	Valore discriminatorio per WaitTimeExceptionTrigger.

LabelOperator

Vengono descritte le operazioni supportate sui valori delle etichette.

Nome	Tipo	Descrizione
equal	string	Uguale.
greaterThan	string	Maggiore.
greaterThanOrEqual	string	Maggiore o uguale a.
lessThan	string	Meno di.
lessThanOrEqual	string	Minore o uguale a.
notEqual	string	Diverso da.

ManualReclassifyExceptionAction

Azione che riclassifica manualmente un processo fornendo la coda, la priorità e i selettori di lavoro.

Nome	Tipo	Descrizione
id	string	ID univoco dell'azione di eccezione.
kind	string: manualReclassify	Il discriminante del tipo che descrive un sottotipo di ExceptionAction.
priority	integer	Priorità aggiornata.
queueId	string	Id coda aggiornato.
workerSelectors	RouterWorkerSelector[]	WorkerSelectors aggiornato.

QueueLengthExceptionTrigger

Attivare un'azione di eccezione in caso di superamento della lunghezza della coda.

Nome	Tipo	Descrizione
kind	string: queueLength	Il discriminante del tipo che descrive un sottotipo di ExceptionTrigger.
threshold	integer	Soglia del numero di processi in anticipo nella coda per consentire l'attivazione del trigger.

ReclassifyExceptionAction

Azione che modifica le etichette in un processo e quindi la riclassifica.

Nome	Tipo	Descrizione
classificationPolicyId	string	Nuovi criteri di classificazione che determineranno i selettori di coda, priorità e ruolo di lavoro.
id	string	ID univoco dell'azione di eccezione.
kind	string: reclassify	Il discriminante del tipo che descrive un sottotipo di ExceptionAction.
labelsToUpsert		Dizionario contenente le etichette da aggiornare (o aggiungere se non esistente) in coppie chiave-valore. I valori devono essere valori primitivi: numero, stringa, booleano.

RouterWorkerSelector

Descrive una condizione che deve essere soddisfatta in base a un set di etichette per la selezione del ruolo di lavoro.

Nome	Tipo	Descrizione
expedite	boolean	Esegue il push di un processo all'inizio della coda, purché questo selettore sia attivo.
expiresAfterSeconds	number	Descrive per quanto tempo questo selettore di etichetta è valido in secondi.
expiresAt	string	Ora in cui il selettore del ruolo di lavoro scade in formato UTC.
key	string	Chiave dell'etichetta su cui eseguire una query.
labelOperator	LabelOperator	Descrive il modo in cui il valore dell'etichetta viene confrontato con il valore definito nel selettore di lavoro.
status	RouterWorkerSelectorStatus	Stato del selettore di lavoro.
value		Valore da confrontare con il valore effettivo dell'etichetta con l'operatore specificato. I valori devono essere valori primitivi: numero, stringa, booleano.

RouterWorkerSelectorStatus

Descrive lo stato di un selettore di lavoro.

Nome	Tipo	Descrizione
active	string	Il selettore di lavoro è valido.
expired	string	Selettore di lavoro non valido.

WaitTimeExceptionTrigger

Attivare un'azione di eccezione in caso di superamento del tempo di attesa.

Nome	Tipo	Descrizione
kind	string: waitTime	Il discriminante del tipo che descrive un sottotipo di ExceptionTrigger.
thresholdSeconds	number	Soglia per il tempo di attesa per questo trigger.

Condividi tramite

Job Router Administration Operations - Upsert Exception Policy

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

AadOauth2Auth

Ambiti

Esempio

Creates an exception policy

Esempio di richiesta

Risposta di esempio

Updates an exception policy

Esempio di richiesta

Risposta di esempio

Definizioni

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

Risorse aggiuntive