Queues - Get
Zwraca opis określonej kolejki.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}?api-version=2021-11-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
namespace
|
path | True |
string |
Nazwa przestrzeni nazw |
queue
|
path | True |
string |
Nazwa kolejki. |
resource
|
path | True |
string |
Nazwa grupy zasobów w ramach subskrypcji platformy Azure. |
subscription
|
path | True |
string |
Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pomyślnie zwrócony opis kolejki. |
|
Other Status Codes |
Odpowiedź o błędzie serviceBus opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
QueueGet
Przykładowe żądanie
GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647?api-version=2021-11-01
Przykładowa odpowiedź
{
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647",
"name": "sdk-Queues-5647",
"type": "Microsoft.ServiceBus/Namespaces/Queues",
"properties": {
"lockDuration": "PT1M",
"maxSizeInMegabytes": 163840,
"maxMessageSizeInKilobytes": 10240,
"requiresDuplicateDetection": false,
"requiresSession": false,
"defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
"duplicateDetectionHistoryTimeWindow": "PT10M",
"maxDeliveryCount": 10,
"sizeInBytes": 0,
"messageCount": 0,
"status": "Active",
"autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
"enablePartitioning": true,
"enableExpress": false,
"createdAt": "2017-05-26T18:07:32.4592931Z",
"updatedAt": "2017-05-26T18:07:34.6243761Z",
"accessedAt": "0001-01-01T00:00:00Z"
}
}
Definicje
Nazwa | Opis |
---|---|
created |
Typ tożsamości, która utworzyła zasób. |
Entity |
Stan jednostki. |
Error |
Obiekt error. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Odpowiedź na błąd zarządzania zasobami. |
Message |
Szczegóły liczby komunikatów. |
SBQueue |
Opis zasobu kolejki. |
system |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
createdByType
Typ tożsamości, która utworzyła zasób.
Nazwa | Typ | Opis |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EntityStatus
Stan jednostki.
Nazwa | Typ | Opis |
---|---|---|
Active |
string |
|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
ReceiveDisabled |
string |
|
Renaming |
string |
|
Restoring |
string |
|
SendDisabled |
string |
|
Unknown |
string |
Error
Obiekt error.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorResponse
Odpowiedź na błąd zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt error. |
MessageCountDetails
Szczegóły liczby komunikatów.
Nazwa | Typ | Opis |
---|---|---|
activeMessageCount |
integer |
Liczba aktywnych komunikatów w kolejce, temacie lub subskrypcji. |
deadLetterMessageCount |
integer |
Liczba wiadomości utraconych. |
scheduledMessageCount |
integer |
Liczba zaplanowanych komunikatów. |
transferDeadLetterMessageCount |
integer |
Liczba wiadomości przeniesionych na martwe litery. |
transferMessageCount |
integer |
Liczba komunikatów przeniesionych do innej kolejki, tematu lub subskrypcji. |
SBQueue
Opis zasobu kolejki.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Lokalizacja geograficzna, w której znajduje się zasób |
name |
string |
Nazwa zasobu |
properties.accessedAt |
string |
Czas ostatniego wysłania komunikatu lub ostatniego wysłania żądania odbioru do tej kolejki. |
properties.autoDeleteOnIdle |
string |
Interwał bezczynności zakresu czasu ISO 8061, po którym kolejka jest automatycznie usuwana. Minimalny czas trwania wynosi 5 minut. |
properties.countDetails |
Szczegóły liczby komunikatów. |
|
properties.createdAt |
string |
Dokładny czas utworzenia wiadomości. |
properties.deadLetteringOnMessageExpiration |
boolean |
Wartość wskazująca, czy ta kolejka ma obsługę utraconych komunikatów po wygaśnięciu komunikatu. |
properties.defaultMessageTimeToLive |
string |
Domyślny przedział czasu komunikatu ISO 8601 na wartość dynamiczną. Jest to czas trwania, po upływie którego komunikat wygaśnie, począwszy od momentu wysłania komunikatu do usługi Service Bus. Jest to wartość domyślna używana, gdy właściwość TimeToLive nie jest ustawiona dla samego komunikatu. |
properties.duplicateDetectionHistoryTimeWindow |
string |
Struktura timeSpan ISO 8601, która definiuje czas trwania historii wykrywania duplikatów. Wartość domyślna to 10 minut. |
properties.enableBatchedOperations |
boolean |
Wartość wskazująca, czy operacje wsadowe po stronie serwera są włączone. |
properties.enableExpress |
boolean |
Wartość wskazująca, czy jednostki ekspresowe są włączone. Kolejka ekspresowa przechowuje komunikat w pamięci tymczasowo przed zapisaniem go w magazynie trwałym. |
properties.enablePartitioning |
boolean |
Wartość wskazująca, czy kolejka ma być partycjonowana na wielu brokerach komunikatów. |
properties.forwardDeadLetteredMessagesTo |
string |
Nazwa kolejki/tematu do przekazywania komunikatu utraconych komunikatów |
properties.forwardTo |
string |
Nazwa kolejki/tematu do przekazywania komunikatów |
properties.lockDuration |
string |
Czas trwania przedziału czasu ISO 8601 zajrzeć do blokady; oznacza to, że czas blokowania komunikatu dla innych odbiorników. Maksymalna wartość parametru LockDuration wynosi 5 minut; wartość domyślna to 1 minuta. |
properties.maxDeliveryCount |
integer |
Maksymalna liczba dostaw. Komunikat jest automatycznie martwy po tej liczbie dostaw. wartość domyślna to 10. |
properties.maxMessageSizeInKilobytes |
integer |
Maksymalny rozmiar (w KB) ładunku komunikatu, który można zaakceptować przez kolejkę. Ta właściwość jest obecnie używana tylko w warstwie Premium, a wartość domyślna to 1024. |
properties.maxSizeInMegabytes |
integer |
Maksymalny rozmiar kolejki w megabajtach, czyli rozmiar pamięci przydzielonej do kolejki. Wartość domyślna to 1024. |
properties.messageCount |
integer |
Liczba komunikatów w kolejce. |
properties.requiresDuplicateDetection |
boolean |
Wartość wskazująca, czy ta kolejka wymaga wykrywania duplikatów. |
properties.requiresSession |
boolean |
Wartość wskazująca, czy kolejka obsługuje koncepcję sesji. |
properties.sizeInBytes |
integer |
Rozmiar kolejki w bajtach. |
properties.status |
Wylicza możliwe wartości stanu jednostki obsługi komunikatów. |
|
properties.updatedAt |
string |
Dokładny czas aktualizacji wiadomości. |
systemData |
Metadane systemowe odnoszące się do tego zasobu. |
|
type |
string |
Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs" |
systemData
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Nazwa | Typ | Opis |
---|---|---|
createdAt |
string |
Sygnatura czasowa tworzenia zasobów (UTC). |
createdBy |
string |
Tożsamość, która utworzyła zasób. |
createdByType |
Typ tożsamości, która utworzyła zasób. |
|
lastModifiedAt |
string |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |
lastModifiedBy |
string |
Tożsamość, która ostatnio zmodyfikowała zasób. |
lastModifiedByType |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |