Sdílet prostřednictvím

Job Router Administration Operations - Upsert Queue

  • Reference
Služba:
Communication
Verze rozhraní API:
2023-11-01

Vytvoří nebo aktualizuje frontu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string

Identifikátor URI vašeho komunikačního prostředku
queueId
 path True

string

ID fronty.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

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

Name Vyžadováno Typ Description
If-Match

string

Požadavek by měl pokračovat pouze v případě, že entita odpovídá tomuto řetězci.
If-Unmodified-Since

string

date-time-rfc7231

Požadavek by měl pokračovat pouze v případě, že po této době nebyla entita změněna.

Text požadavku

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

Name Typ Description
distributionPolicyId

string

ID distribuční zásady, která určí, jak se úloha distribuuje pracovníkům.
exceptionPolicyId

string

ID zásady výjimky, která určuje různá pravidla eskalace úloh.
labels

Sada párů klíč/hodnota, které identifikují atributy používané moduly pravidel k rozhodování. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.
name

string

Popisný název této fronty

Odpovědi

Name Typ Description
200 OK

RouterQueue

Požadavek byl úspěšný.

Hlavičky

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

RouterQueue

Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

Hlavičky

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

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

AadOauth2Auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Creates a queue
Updates a queue

Creates a queue

Ukázkový požadavek

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

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

Ukázková odpověď

Stavový kód:
200 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
Stavový kód:
201 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Updates a queue

Ukázkový požadavek

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

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

Ukázková odpověď

Stavový kód:
200 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
Stavový kód:
201 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Definice

Name Description
Azure.Core.Foundations.Error

Objekt chyby.
Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue

Fronta, která může obsahovat úlohy, které se mají směrovat.
RouterQueueCreateOrUpdate

Fronta, která může obsahovat úlohy, které se mají směrovat.

Azure.Core.Foundations.Error

Objekt chyby.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

Azure.Core.Foundations.Error[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message

string

Čitelné znázornění chyby člověkem.
target

string

Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name Typ Description
error

Azure.Core.Foundations.Error

Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
innererror

Azure.Core.Foundations.InnerError

Vnitřní chyba.

RouterQueue

Fronta, která může obsahovat úlohy, které se mají směrovat.

Name Typ Description
distributionPolicyId

string

ID distribuční zásady, která určí, jak se úloha distribuuje pracovníkům.
etag

string

Značka entity pro tento prostředek.
exceptionPolicyId

string

ID zásady výjimky, která určuje různá pravidla eskalace úloh.
id

string

ID fronty.
labels

Sada párů klíč/hodnota, které identifikují atributy používané moduly pravidel k rozhodování. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.
name

string

Popisný název této fronty

RouterQueueCreateOrUpdate

Fronta, která může obsahovat úlohy, které se mají směrovat.

Name Typ Description
distributionPolicyId

string

ID distribuční zásady, která určí, jak se úloha distribuuje pracovníkům.
exceptionPolicyId

string

ID zásady výjimky, která určuje různá pravidla eskalace úloh.
labels

Sada párů klíč/hodnota, které identifikují atributy používané moduly pravidel k rozhodování. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.
name

string

Popisný název této fronty