Tworzenie kolejki

Ważne

Ten interfejs API jest przestarzały i wycofany od 11.1.2021 r. i nie powinien już być używany.

Tworzy nową kolejkę. Po utworzeniu manifest zasobu kolejki jest niezmienny. Ta operacja jest idempotentna. Powtarzanie wywołania tworzenia po pomyślnym utworzeniu kolejki o tej samej nazwie powoduje wyświetlenie komunikatu o błędzie 409 Konflikt.

Żądanie

Metoda Identyfikator URI żądania Wersja PROTOKOŁU HTTP
PUT https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/{Namespace}/Queues/{Queue Path} HTTP/1.1

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Nagłówek żądania Opis
Content-Type application/xml;type=entry; charset=utf-8
x-ms-version 2012-03-01

Żądanie wymaga również certyfikatu klienta. Ten certyfikat musi być zgodny z certyfikatem przekazanym dla tej konkretnej subskrypcji.

Treść żądania

W poniższej tabeli opisano kluczowe elementy treści żądania:

Nazwa właściwości Typ Wymagane Opis
MaxQueueSizeInMegaBytes Liczba całkowita bez znaku Wymagane Ten parametr określa maksymalny rozmiar kolejki w megabajtach. Każda próba ściągnięcia komunikatu, który powoduje, że kolejka przekroczy tę wartość, kończy się niepowodzeniem. Tylko zawartość użytkownika jest liczone do tej wartości. Tabelę ustawianą w czasie tworzenia kolejki i w czasie wykonywania:

- Zakres: 1–5*1024.

- Wartość domyślna: 1*1024.
QueueSizeinBytes Liczba całkowita bez znaku Tylko do odczytu. Nie jest wymagane podczas tworzenia. Ten parametr odzwierciedla rzeczywiste bajty, które komunikaty w kolejce zajmują obecnie limit przydziału kolejki.

Zakres: 0 –MaxTopicSizeinMegaBytes
QueueDepth Liczba całkowita bez znaku Tylko do odczytu. Nie jest wymagane podczas tworzenia. Ten parametr pokazuje liczbę komunikatów aktualnie w kolejce.
DefaultMessageTimeToLive Data/godzina XML Opcjonalnie wartość domyślna to 14 dni. W zależności od tego, czy włączono obsługę utraconych komunikatów, jeśli komunikat został zapisany w kolejce przez więcej niż określony czas, zostanie on automatycznie przeniesiony do kolejki utraconych komunikatów lub usunięty. Ta wartość jest zastępowana przez czas wygaśnięcia określony w komunikacie, jeśli czas wygaśnięcia komunikatu jest mniejszy niż czas wygaśnięcia ustawiony w kolejce. Ta wartość jest niezmienna po utworzeniu kolejki:

- Zakres: 1 sekunda – 14 dni.

— Ustawienie domyślne: 14 dni.
LockDuration Data/godzina XML Opcjonalnie wartość domyślna to 30 sekund. To ustawienie określa czas w sekundach, dla którego komunikat powinien być zablokowany do przetwarzania przez odbiornik. Po upływie tego okresu komunikat zostanie odblokowany i będzie dostępny do użycia przez następny odbiornik. Ustaw tabelę tylko w czasie tworzenia kolejki:

- Zakres: 0–5 min. 0 oznacza, że komunikat nie jest zablokowany.

— Wartość domyślna: 30 sekund.
Wymagasesja Wartość logiczna Opcjonalne Ustawiana jest tylko w czasie tworzenia kolejki. Jeśli ustawiono wartość true, kolejka jest świadoma sesji i obsługiwana SessionReceiver jest tylko ta wartość. Kolejki obsługujące sesję nie są obsługiwane za pośrednictwem interfejsu REST.

- Wartość domyślna: Fałsz.
RequiresDuplicateDetection Wartość logiczna Opcjonalne Ustawiana jest tylko w czasie tworzenia kolejki.

— Wartość domyślna dla trwałej kolejki: false.
EnableDeadLetteringOnMessageExpiration Wartość logiczna Opcjonalne Ustawiana jest tylko w czasie tworzenia kolejki.

- Wartość domyślna: false.

To pole określa sposób obsługi komunikatu przez usługę Service Bus z wygasłym czasem wygaśnięcia. Jeśli wartość true i komunikat wygaśnie, usługa Service Bus przenosi komunikat z kolejki do kolejki w kolejce utraconych komunikatów. Jeśli jest to fałsz, komunikat zostanie trwale usunięty z kolejki.
DuplicateDetectionHistoryTimeWindow Przedział czasu Opcjonalny. Właściwość określająca przedział czasu, w którym usługa Service Bus wykrywa duplikowanie komunikatów.

- Zakres: 1 sekunda–7 dni.

— Ustawienie domyślne: 10 minut.
Stan Ciąg Tylko do odczytu. Nie jest wymagane podczas tworzenia. Może być jedną z następujących wartości:

  • Aktywna
  • Tworzenie
  • Usuwanie
  • ReceiveDisabled
  • SendDisabled
  • Disabled
  • Zmienianie nazw
  • Przywracanie
  • Nieznane

Reakcja

Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.

Kody odpowiedzi

Uwaga

Jeśli utworzysz kolejkę o nazwie zawierającej znaki specjalne lub zakodowane (na przykład "test? Name=value&", który jest kodowany do "test%3FName%3Dvalue%26"), jest generowany nieprawidłowy wyjątek żądania (400).

Kod Opis
201 Utworzono kolejkę.
400 Nieprawidłowa treść żądania.
401 Niepowodzenie autoryzacji.
403 Przekroczono limit przydziału; kolejka nie została utworzona.
409 Określona kolejka już istnieje (lub określona ścieżka jest już zajęta).
500 Błąd wewnętrzny.

Aby uzyskać informacje o kodach stanu, zobacz Kody stanu i błędów.

Nagłówki odpowiedzi

Brak.

Treść odpowiedzi

Zwracany jest opis kolejki. Jeśli brakuje ich w żądaniu PUT, niektóre właściwości opisu mogą zawierać wartości domyślne.

  • Last updated on