Job Router Administration Operations - Upsert Queue

Usługa:

Communication

Wersja interfejsu API:

2023-11-01

Tworzy lub aktualizuje kolejkę.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
queueId	path	True	string	Identyfikator kolejki.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
If-Match		string	Żądanie powinno być kontynuowane tylko wtedy, gdy jednostka pasuje do tego ciągu.
If-Unmodified-Since		string date-time-rfc7231	Żądanie powinno być kontynuowane tylko wtedy, gdy jednostka nie została zmodyfikowana po tym czasie.

Treść żądania

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

Nazwa	Typ	Opis
distributionPolicyId	string	Identyfikator zasad dystrybucji, które określą, jak zadanie jest dystrybuowane do procesów roboczych.
exceptionPolicyId	string	Identyfikator zasad wyjątku określających różne reguły eskalacji zadań.
labels		Zestaw par klucz/wartość identyfikujący atrybuty używane przez aparaty reguł do podejmowania decyzji. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.
name	string	Przyjazna nazwa tej kolejki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RouterQueue	Żądanie zakończyło się pomyślnie. Nagłówki ETag: string Last-Modified: string
201 Created	RouterQueue	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób. Nagłówki ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

AadOauth2Auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://communication.azure.com/.default

Przykłady

Creates a queue

Updates a queue

Creates a queue

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

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

Kod stanu:

201

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

Updates a queue

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

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

Kod stanu:

201

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

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue	Kolejka, która może zawierać zadania do kierowania.
RouterQueueCreateOrUpdate	Kolejka, która może zawierać zadania do kierowania.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

RouterQueue

Kolejka, która może zawierać zadania do kierowania.

Nazwa	Typ	Opis
distributionPolicyId	string	Identyfikator zasad dystrybucji, które określą, jak zadanie jest dystrybuowane do procesów roboczych.
etag	string	Tag jednostki dla tego zasobu.
exceptionPolicyId	string	Identyfikator zasad wyjątku określających różne reguły eskalacji zadań.
id	string	Identyfikator kolejki.
labels		Zestaw par klucz/wartość identyfikujący atrybuty używane przez aparaty reguł do podejmowania decyzji. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.
name	string	Przyjazna nazwa tej kolejki.

RouterQueueCreateOrUpdate

Kolejka, która może zawierać zadania do kierowania.

Nazwa	Typ	Opis
distributionPolicyId	string	Identyfikator zasad dystrybucji, które określą, jak zadanie jest dystrybuowane do procesów roboczych.
exceptionPolicyId	string	Identyfikator zasad wyjątku określających różne reguły eskalacji zadań.
labels		Zestaw par klucz/wartość identyfikujący atrybuty używane przez aparaty reguł do podejmowania decyzji. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.
name	string	Przyjazna nazwa tej kolejki.