Condividi tramite

Job Router Administration Operations - Upsert Queue

  • Riferimento
Servizio:
Communication
Versione API:
2023-11-01

Crea o aggiorna una coda.

PATCH {endpoint}/routing/queues/{queueId}?api-version=2023-11-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

URI della risorsa di comunicazione
queueId
 path True

string

ID di una coda.
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
distributionPolicyId

string

ID di un criterio di distribuzione che determinerà la modalità di distribuzione di un processo ai ruoli di lavoro.
exceptionPolicyId

string

ID di un criterio di eccezione che determina varie regole di escalation dei processi.
labels

Set di coppie chiave/valore che identificano gli attributi usati dai motori delle regole per prendere decisioni. I valori devono essere valori primitivi: numero, stringa, booleano.
name

string

Nome descrittivo di questa coda.

Risposte

Nome Tipo Descrizione
200 OK

RouterQueue

La richiesta ha avuto esito positivo.

Intestazioni

  • ETag: string
  • Last-Modified: string
201 Created

RouterQueue

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 a queue
Updates a queue

Creates a queue

Esempio di richiesta

PATCH https://contoso.westus.communications.azure.com/routing/queues/QueueId?api-version=2023-11-01

{
  "distributionPolicyId": "MainDistributionPolicy",
  "name": "Main",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy"
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
Codice di stato:
201 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Updates a queue

Esempio di richiesta

PATCH https://contoso.westus.communications.azure.com/routing/queues/MainQueue?api-version=2023-11-01

{
  "distributionPolicyId": "MainDistributionPolicy",
  "name": "Main"
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
Codice di stato:
201 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "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.
RouterQueue

Coda che può contenere processi da instradare.
RouterQueueCreateOrUpdate

Coda che può contenere processi da instradare.

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.

RouterQueue

Coda che può contenere processi da instradare.

Nome Tipo Descrizione
distributionPolicyId

string

ID di un criterio di distribuzione che determinerà la modalità di distribuzione di un processo ai ruoli di lavoro.
etag

string

Tag di entità per questa risorsa.
exceptionPolicyId

string

ID di un criterio di eccezione che determina varie regole di escalation dei processi.
id

string

ID di una coda.
labels

Set di coppie chiave/valore che identificano gli attributi usati dai motori delle regole per prendere decisioni. I valori devono essere valori primitivi: numero, stringa, booleano.
name

string

Nome descrittivo di questa coda.

RouterQueueCreateOrUpdate

Coda che può contenere processi da instradare.

Nome Tipo Descrizione
distributionPolicyId

string

ID di un criterio di distribuzione che determinerà la modalità di distribuzione di un processo ai ruoli di lavoro.
exceptionPolicyId

string

ID di un criterio di eccezione che determina varie regole di escalation dei processi.
labels

Set di coppie chiave/valore che identificano gli attributi usati dai motori delle regole per prendere decisioni. I valori devono essere valori primitivi: numero, stringa, booleano.
name

string

Nome descrittivo di questa coda.