Queues - Get
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=2021-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
namespace
|
path | True |
string |
Der Namespacename |
queue
|
path | True |
string |
Der Warteschlangenname. |
resource
|
path | True |
string |
Name der Ressourcengruppe innerhalb des Azure-Abonnements. |
subscription
|
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 |
Client-API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Warteschlangenbeschreibung wurde erfolgreich zurückgegeben. |
|
Other Status Codes |
ServiceBus-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
QueueGet
Beispielanforderung
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
Beispiel für eine Antwort
{
"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 |
---|---|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Entity |
Entitäts-status. |
Error |
Das Fehlerobjekt. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerantwort für die Ressourcenverwaltung. |
Message |
Details zur Nachrichtenanzahl. |
SBQueue |
Beschreibung der Warteschlangenressource. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EntityStatus
Entitäts-status.
Name | Typ | Beschreibung |
---|---|---|
Active |
string |
|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
ReceiveDisabled |
string |
|
Renaming |
string |
|
Restoring |
string |
|
SendDisabled |
string |
|
Unknown |
string |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorResponse
Die Fehlerantwort für die Ressourcenverwaltung.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
MessageCountDetails
Details zur Nachrichtenanzahl.
Name | Typ | Beschreibung |
---|---|---|
activeMessageCount |
integer |
Anzahl der aktiven Nachrichten in der Warteschlange, im Thema oder im Abonnement. |
deadLetterMessageCount |
integer |
Anzahl der Nachrichten, die unzustellbar sind. |
scheduledMessageCount |
integer |
Anzahl der geplanten Nachrichten. |
transferDeadLetterMessageCount |
integer |
Anzahl der Nachrichten, die in unzustellbare Briefe übertragen werden. |
transferMessageCount |
integer |
Anzahl der Nachrichten, die an eine andere Warteschlange, ein anderes Thema oder ein anderes Abonnement übertragen werden. |
SBQueue
Beschreibung der Warteschlangenressource.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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 |
Beim letzten Senden einer Nachricht oder beim letzten Senden einer Empfangsanforderung an diese Warteschlange. |
properties.autoDeleteOnIdle |
string |
ISO 8061 timeSpan-Leerlaufintervall, nach dem die Warteschlange automatisch gelöscht wird. Die Mindestdauer ist fünf Minuten. |
properties.countDetails |
Details zur Nachrichtenanzahl. |
|
properties.createdAt |
string |
Der genaue Zeitpunkt, zu dem die Nachricht erstellt wurde. |
properties.deadLetteringOnMessageExpiration |
boolean |
Ein -Wert, der angibt, ob diese Warteschlange unterstützung für unzustellbare Nachrichten hat, wenn eine Nachricht abläuft. |
properties.defaultMessageTimeToLive |
string |
ISO 8601-Standardzeitbereich für Nachrichten auf Livewert. Dies ist die Dauer, nach der die Nachricht ab dem Zeitpunkt abläuft, nach dem die Nachricht an Service Bus gesendet wird. Dies ist der Standardwert, der verwendet wird, wenn TimeToLive nicht für eine Nachricht selbst festgelegt ist. |
properties.duplicateDetectionHistoryTimeWindow |
string |
ISO 8601 timeSpan-Struktur, die die Dauer des Duplikaterkennungsverlaufs definiert. Der Standardwert beträgt 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 den persistenten Speicher geschrieben wird. |
properties.enablePartitioning |
boolean |
Ein -Wert, der angibt, ob die Warteschlange über mehrere Nachrichtenbroker partitioniert werden soll. |
properties.forwardDeadLetteredMessagesTo |
string |
Warteschlangen-/Themenname zum Weiterleiten der Nachricht "Unzustellbarer Brief" |
properties.forwardTo |
string |
Warteschlangen-/Themenname zum Weiterleiten der Nachrichten |
properties.lockDuration |
string |
ISO 8601 Dauer einer Peek-Sperre; 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 |
Die maximale Anzahl der Übermittlungen. Eine Nachricht wird nach dieser Anzahl an Übermittlungen automatisch als unzustellbar gekennzeichnet. Der Standardwert ist 10. |
properties.maxMessageSizeInKilobytes |
integer |
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 |
Die maximale Größe der Warteschlange in Megabyte, d. h. die Größe des für die Warteschlange zugewiesenen Arbeitsspeichers. Der Standardwert ist 1024. |
properties.messageCount |
integer |
Die Anzahl der Nachrichten in der Warteschlange. |
properties.requiresDuplicateDetection |
boolean |
Ein Wert, der angibt, ob für diese Warteschlange eine Duplikaterkennung erforderlich ist. |
properties.requiresSession |
boolean |
Ein -Wert, der angibt, ob die Warteschlange das Konzept von Sitzungen unterstützt. |
properties.sizeInBytes |
integer |
Die Größe der Warteschlange in Bytes. |
properties.status |
Listet die möglichen Werte für die status einer Messagingentität auf. |
|
properties.updatedAt |
string |
Die genaue Uhrzeit, zu der die Nachricht aktualisiert wurde. |
systemData |
Die Systemmetadaten zu dieser Ressource. |
|
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs" |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |