Queues - Get

Referenz

Dienst:: Service Bus

API-Version:: 2024-01-01

Gibt eine Beschreibung für die angegebene Warteschlange zurück.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string minLength: 6 maxLength: 50	Der Namespacename
queueName	path	True	string minLength: 1	Der Warteschlangenname.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SBQueue	Die Warteschlangenbeschreibung wurde erfolgreich zurückgegeben.
Other Status Codes	ErrorResponse	ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EntityStatus	Entitätsstatus.
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
MessageCountDetails	Details zur Nachrichtenanzahl.
SBQueue	Beschreibung der Warteschlangenressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EntityStatus

Enumeration

Entitätsstatus.

Wert	Beschreibung
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Die Fehlerantwort für die Ressourcenverwaltung.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

MessageCountDetails

Objekt

Details zur Nachrichtenanzahl.

Name	Typ	Beschreibung
activeMessageCount	integer (int64)	Anzahl der aktiven Nachrichten in der Warteschlange, im Thema oder im Abonnement.
deadLetterMessageCount	integer (int64)	Die Anzahl der Nachrichten, die inaktiv sind.
scheduledMessageCount	integer (int64)	Anzahl der geplanten Nachrichten.
transferDeadLetterMessageCount	integer (int64)	Die Anzahl der nachrichten, die in tote Briefe übertragen wurden.
transferMessageCount	integer (int64)	Die Anzahl der Nachrichten, die in eine andere Warteschlange, ein Thema oder ein Abonnement übertragen wurden.

SBQueue

Objekt

Beschreibung der Warteschlangenressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.accessedAt	string (date-time)	Beim letzten Senden einer Nachricht oder beim letzten Senden einer Empfangsanforderung an diese Warteschlange.
properties.autoDeleteOnIdle	string (duration)	ISO 8061 TimeSpan-Leerlaufintervall, nach dem die Warteschlange automatisch gelöscht wird. Die Mindestdauer beträgt 5 Minuten.
properties.countDetails	MessageCountDetails	Details zur Nachrichtenanzahl.
properties.createdAt	string (date-time)	Der genaue Zeitpunkt, zu dem die Nachricht erstellt wurde.
properties.deadLetteringOnMessageExpiration	boolean	Ein Wert, der angibt, ob diese Warteschlange unterstützung für inaktive Briefe hat, wenn eine Nachricht abläuft.
properties.defaultMessageTimeToLive	string (duration)	ISO 8601-Standardnachrichtenzeitbereich auf Livewert. Dies ist die Dauer, nach der die Nachricht ab dem Senden der Nachricht an Service Bus abläuft. Dies ist der Standardwert, der verwendet wird, wenn TimeToLive nicht für eine Nachricht selbst festgelegt ist.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	ISO 8601 timeSpan-Struktur, die die Dauer des doppelten Erkennungsverlaufs definiert. Der Standardwert ist 10 Minuten
properties.enableBatchedOperations	boolean	Wert, der angibt, ob serverseitige Batchvorgänge aktiviert sind.
properties.enableExpress	boolean	Ein Wert, der angibt, ob Express-Entitäten aktiviert sind. Eine Expresswarteschlange enthält eine Nachricht vorübergehend im Arbeitsspeicher, bevor sie in beständigen Speicher geschrieben wird.
properties.enablePartitioning	boolean	Ein Wert, der angibt, ob die Warteschlange über mehrere Nachrichtenbroker verteilt werden soll.
properties.forwardDeadLetteredMessagesTo	string	Warteschlangen-/Themenname zum Weiterleiten der Nachricht "Inaktiver Buchstabe"
properties.forwardTo	string	Warteschlangen-/Themenname zum Weiterleiten der Nachrichten
properties.lockDuration	string (duration)	ISO 8601-Zeitdauer einer Vorschausperre; d. h. die Zeitspanne, in der die Nachricht für andere Empfänger gesperrt ist. Der Maximalwert für LockDuration beträgt 5 Minuten; Der Standardwert ist 1 Minute.
properties.maxDeliveryCount	integer (int32)	Die maximale Lieferanzahl. Eine Nachricht wird nach dieser Anzahl von Lieferungen automatisch inaktiviert. Der Standardwert ist 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Maximale Größe (in KB) der Nachrichtennutzlast, die von der Warteschlange akzeptiert werden kann. Diese Eigenschaft wird heute nur in Premium verwendet, und der Standardwert ist 1024.
properties.maxSizeInMegabytes	integer (int32)	Die maximale Größe der Warteschlange in Megabyte, bei der es sich um die Größe des für die Warteschlange zugewiesenen Arbeitsspeichers handelt. Der Standardwert ist 1024.
properties.messageCount	integer (int64)	Die Anzahl der Nachrichten in der Warteschlange.
properties.requiresDuplicateDetection	boolean	Ein Wert, der angibt, ob diese Warteschlange eine duplizierte Erkennung erfordert.
properties.requiresSession	boolean	Ein Wert, der angibt, ob die Warteschlange das Konzept von Sitzungen unterstützt.
properties.sizeInBytes	integer (int64)	Die Größe der Warteschlange in Byte.
properties.status	EntityStatus	Listet die möglichen Werte für den Status einer Nachrichtenentität auf.
properties.updatedAt	string (date-time)	Die genaue Uhrzeit, zu der die Nachricht aktualisiert wurde.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Queues - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

QueueGet

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Zusätzliche Ressourcen