Queues - Get

Odwołanie

Usługa:: Service Bus

Wersja interfejsu API:: 2024-01-01

Zwraca opis określonej kolejki.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}?api-version=2024-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string minLength: 6 maxLength: 50	Nazwa przestrzeni nazw
queueName	path	True	string minLength: 1	Nazwa kolejki.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	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 minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SBQueue	Opis kolejki został pomyślnie zwrócony.
Other Status Codes	ErrorResponse	Odpowiedź o błędzie usługi ServiceBus opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu 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

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=2024-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Queues/SBQueueGet.json
// this example is just showing the usage of "Queues_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusQueueResource created on azure
// for more information of creating ServiceBusQueueResource, please refer to the document of ServiceBusQueueResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-3174";
string queueName = "sdk-Queues-5647";
ResourceIdentifier serviceBusQueueResourceId = ServiceBusQueueResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, queueName);
ServiceBusQueueResource serviceBusQueue = client.GetServiceBusQueueResource(serviceBusQueueResourceId);

// invoke the operation
ServiceBusQueueResource result = await serviceBusQueue.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceBusQueueData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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
createdByType	Typ tożsamości, która utworzyła zasób.
EntityStatus	Stan jednostki.
Error	Obiekt błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd zarządzania zasobami.
MessageCountDetails	Szczegóły liczby komunikatów.
SBQueue	Opis zasobu kolejki.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

EntityStatus

Wyliczanie

Stan jednostki.

Wartość	Opis
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Objekt

Odpowiedź na błąd zarządzania zasobami.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

MessageCountDetails

Objekt

Szczegóły liczby komunikatów.

Nazwa	Typ	Opis
activeMessageCount	integer (int64)	Liczba aktywnych komunikatów w kolejce, temacie lub subskrypcji.
deadLetterMessageCount	integer (int64)	Liczba wiadomości, które nie zostały wysłane.
scheduledMessageCount	integer (int64)	Liczba zaplanowanych komunikatów.
transferDeadLetterMessageCount	integer (int64)	Liczba wiadomości przeniesionych na martwe litery.
transferMessageCount	integer (int64)	Liczba komunikatów przeniesionych do innej kolejki, tematu lub subskrypcji.

SBQueue

Objekt

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 (date-time)	Czas ostatniego wysłania komunikatu lub ostatniego żądania odebrania do tej kolejki.
properties.autoDeleteOnIdle	string (duration)	Interwał bezczynności przedziału czasu ISO 8061, po którym kolejka zostanie automatycznie usunięta. Minimalny czas trwania wynosi 5 minut.
properties.countDetails	MessageCountDetails	Szczegóły liczby komunikatów.
properties.createdAt	string (date-time)	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 (duration)	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 (duration)	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 express są włączone. Kolejka ekspresowa tymczasowo przechowuje komunikat w pamięci 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 wiadomości
properties.forwardTo	string	Nazwa kolejki/tematu do przekazywania komunikatów
properties.lockDuration	string (duration)	Czas trwania przedziału czasu ISO 8601 dla zajrzyj 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 (int32)	Maksymalna liczba dostaw. Komunikat jest automatycznie martwy po tej liczbie dostaw. wartość domyślna to 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Maksymalny rozmiar (w KB) ładunku komunikatu, który można zaakceptować przez kolejkę. Ta właściwość jest używana tylko w warstwie Premium dzisiaj, a wartość domyślna to 1024.
properties.maxSizeInMegabytes	integer (int32)	Maksymalny rozmiar kolejki w megabajtach, czyli rozmiar pamięci przydzielonej do kolejki. Wartość domyślna to 1024.
properties.messageCount	integer (int64)	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 (int64)	Rozmiar kolejki w bajtach.
properties.status	EntityStatus	Wylicza możliwe wartości stanu jednostki obsługi komunikatów.
properties.updatedAt	string (date-time)	Dokładny czas aktualizacji komunikatu.
systemData	systemData	Metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Queues - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

QueueGet

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Dodatkowe zasoby