Queues - Get

Referenz

Dienst:: Service Bus

API-Version:: 2021-11-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=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string	Der Namespacename
queueName	path	True	string	Der Warteschlangenname.
resourceGroupName	path	True	string	Name der Ressourcengruppe innerhalb des Azure-Abonnements.
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	Client-API-Version.

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-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


import com.azure.core.util.Context;

/** Samples for Queues Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
     */
    /**
     * Sample code: QueueGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void queueGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getQueues().getWithResponse("ArunMonocle",
            "sdk-Namespace-3174", "sdk-Queues-5647", Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_queue_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.queues.get(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace-3174",
        queue_name="sdk-Queues-5647",
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
if __name__ == "__main__":
    main()

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

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
func ExampleQueuesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQueuesClient().Get(ctx, "ArunMonocle", "sdk-Namespace-3174", "sdk-Queues-5647", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SBQueue = armservicebus.SBQueue{
	// 	Name: to.Ptr("sdk-Queues-5647"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces/Queues"),
	// 	ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647"),
	// 	Properties: &armservicebus.SBQueueProperties{
	// 		AccessedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		AutoDeleteOnIdle: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:32.459Z"); return t}()),
	// 		DefaultMessageTimeToLive: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		DuplicateDetectionHistoryTimeWindow: to.Ptr("PT10M"),
	// 		EnableExpress: to.Ptr(false),
	// 		EnablePartitioning: to.Ptr(true),
	// 		LockDuration: to.Ptr("PT1M"),
	// 		MaxDeliveryCount: to.Ptr[int32](10),
	// 		MaxMessageSizeInKilobytes: to.Ptr[int64](10240),
	// 		MaxSizeInMegabytes: to.Ptr[int32](163840),
	// 		MessageCount: to.Ptr[int64](0),
	// 		RequiresDuplicateDetection: to.Ptr(false),
	// 		RequiresSession: to.Ptr(false),
	// 		SizeInBytes: to.Ptr[int64](0),
	// 		Status: to.Ptr(armservicebus.EntityStatusActive),
	// 		UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:34.624Z"); return t}()),
	// 	},
	// }
}

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

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns a description for the specified queue.
 *
 * @summary Returns a description for the specified queue.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
 */
async function queueGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace-3174";
  const queueName = "sdk-Queues-5647";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.queues.get(resourceGroupName, namespaceName, queueName);
  console.log(result);
}

queueGet().catch(console.error);

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äts-status.
Error	Das Fehlerobjekt.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Die Fehlerantwort für die Ressourcenverwaltung.
MessageCountDetails	Details zur Nachrichtenanzahl.
SBQueue	Beschreibung der Warteschlangenressource.
systemData	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	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	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	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	MessageCountDetails	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	EntityStatus	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	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	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	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