Partager via

Job Router Administration Operations - Upsert Queue

  • Référence
Service:
Communication
Version d'API:
2023-11-01

Crée ou met à jour une file d’attente.

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

URI de votre ressource communication
queueId
 path True

string

ID d’une file d’attente.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

En-tête de la demande

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

Nom Obligatoire Type Description
If-Match

string

La demande ne doit se poursuivre que si une entité correspond à cette chaîne.
If-Unmodified-Since

string

date-time-rfc7231

La demande ne doit se poursuivre que si l’entité n’a pas été modifiée après ce délai.

Corps de la demande

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

Nom Type Description
distributionPolicyId

string

ID d’une stratégie de distribution qui détermine la façon dont un travail est distribué aux workers.
exceptionPolicyId

string

ID d’une stratégie d’exception qui détermine diverses règles d’escalade de travail.
labels

Ensemble de paires clé/valeur qui identifient les attributs utilisés par les moteurs de règles pour prendre des décisions. Les valeurs doivent être des valeurs primitives : nombre, chaîne, booléen.
name

string

Nom convivial de cette file d’attente.

Réponses

Nom Type Description
200 OK

RouterQueue

La demande a réussi.

En-têtes

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

RouterQueue

La demande a réussi et une nouvelle ressource a été créée en conséquence.

En-têtes

  • ETag: string
  • Last-Modified: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Exemples

Creates a queue
Updates a queue

Creates a queue

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
Code d’état:
201 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Updates a queue

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
Code d’état:
201 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Définitions

Nom Description
Azure.Core.Foundations.Error

Objet error.
Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue

File d’attente qui peut contenir des travaux à router.
RouterQueueCreateOrUpdate

File d’attente qui peut contenir des travaux à router.

Azure.Core.Foundations.Error

Objet error.

Nom Type Description
code

string

Un des ensembles de codes d’erreur définis par le serveur.
details

Azure.Core.Foundations.Error[]

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message

string

Représentation lisible de l’erreur.
target

string

Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom Type Description
error

Azure.Core.Foundations.Error

Objet error.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom Type Description
code

string

Un des ensembles de codes d’erreur définis par le serveur.
innererror

Azure.Core.Foundations.InnerError

Erreur interne.

RouterQueue

File d’attente qui peut contenir des travaux à router.

Nom Type Description
distributionPolicyId

string

ID d’une stratégie de distribution qui détermine la façon dont un travail est distribué aux workers.
etag

string

Balise d’entité pour cette ressource.
exceptionPolicyId

string

ID d’une stratégie d’exception qui détermine diverses règles d’escalade de travail.
id

string

ID d’une file d’attente.
labels

Ensemble de paires clé/valeur qui identifient les attributs utilisés par les moteurs de règles pour prendre des décisions. Les valeurs doivent être des valeurs primitives : nombre, chaîne, booléen.
name

string

Nom convivial de cette file d’attente.

RouterQueueCreateOrUpdate

File d’attente qui peut contenir des travaux à router.

Nom Type Description
distributionPolicyId

string

ID d’une stratégie de distribution qui détermine la façon dont un travail est distribué aux workers.
exceptionPolicyId

string

ID d’une stratégie d’exception qui détermine diverses règles d’escalade de travail.
labels

Ensemble de paires clé/valeur qui identifient les attributs utilisés par les moteurs de règles pour prendre des décisions. Les valeurs doivent être des valeurs primitives : nombre, chaîne, booléen.
name

string

Nom convivial de cette file d’attente.