Queues - Get

Service:

Service Bus

API Version:

2021-11-01

Retourneert een beschrijving voor de opgegeven wachtrij.

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

URI-parameters

Name	In	Vereist	Type	Description
namespaceName	path	True	string	De naam van de naamruimte
queueName	path	True	string	De naam van de wachtrij.
resourceGroupName	path	True	string	Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	SBQueue	De beschrijving van de wachtrij is geretourneerd.
Other Status Codes	ErrorResponse	ServiceBus-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

QueueGet

Sample Request

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

Sample Response

Status code:

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
EntityStatus	Entiteitsstatus.
Error	Het foutobject.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Het foutantwoord voor resourcebeheer.
MessageCountDetails	Details van het aantal berichten.
SBQueue	Beschrijving van wachtrijresource.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Entiteitsstatus.

Name	Type	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Het foutobject.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Het foutantwoord voor resourcebeheer.

Name	Type	Description
error	Error	Het foutobject.

MessageCountDetails

Details van het aantal berichten.

Name	Type	Description
activeMessageCount	integer	Aantal actieve berichten in de wachtrij, het onderwerp of het abonnement.
deadLetterMessageCount	integer	Aantal berichten met een onbestelbare brief.
scheduledMessageCount	integer	Aantal geplande berichten.
transferDeadLetterMessageCount	integer	Het aantal berichten dat is overgebracht naar onbestelbare letters.
transferMessageCount	integer	Het aantal berichten dat is overgebracht naar een andere wachtrij, onderwerp of abonnement.

SBQueue

Beschrijving van wachtrijresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.accessedAt	string	De laatste keer dat een bericht is verzonden of de laatste keer dat er een ontvangstaanvraag voor deze wachtrij is ingediend.
properties.autoDeleteOnIdle	string	ISO 8061 timeSpan inactief interval waarna de wachtrij automatisch wordt verwijderd. De minimale duur is vijf minuten.
properties.countDetails	MessageCountDetails	Details van het aantal berichten.
properties.createdAt	string	De exacte tijd waarop het bericht is gemaakt.
properties.deadLetteringOnMessageExpiration	boolean	Een waarde die aangeeft of deze wachtrij ondersteuning voor onbestelbare berichten heeft wanneer een bericht verloopt.
properties.defaultMessageTimeToLive	string	Iso 8601 standaard bericht timespan to live waarde. Dit is de duur waarna het bericht verloopt, te beginnen vanaf het moment dat het bericht naar Service Bus wordt verzonden. Dit is de standaardwaarde die wordt gebruikt wanneer TimeToLive niet is ingesteld voor een bericht zelf.
properties.duplicateDetectionHistoryTimeWindow	string	ISO 8601 timeSpan-structuur die de duur van de geschiedenis van de dubbele detectie definieert. De standaardwaarde is 10 minuten.
properties.enableBatchedOperations	boolean	Waarde die aangeeft of batchbewerkingen aan de serverzijde zijn ingeschakeld.
properties.enableExpress	boolean	Een waarde die aangeeft of Express-entiteiten zijn ingeschakeld. Een snelle wachtrij bevat een bericht tijdelijk in het geheugen voordat het naar permanente opslag wordt geschreven.
properties.enablePartitioning	boolean	Een waarde die aangeeft of de wachtrij moet worden gepartitioneerd over meerdere berichtbrokers.
properties.forwardDeadLetteredMessagesTo	string	Wachtrij-/onderwerpnaam voor het doorsturen van het onbestelbare bericht
properties.forwardTo	string	Wachtrij-/onderwerpnaam voor het doorsturen van de berichten
properties.lockDuration	string	ISO 8601 tijdsduur van een peek-lock; dat wil gezegd, de hoeveelheid tijd dat het bericht is vergrendeld voor andere ontvangers. De maximumwaarde voor LockDuration is 5 minuten; de standaardwaarde is 1 minuut.
properties.maxDeliveryCount	integer	Het maximale aantal leveringen. Een bericht wordt na dit aantal leveringen automatisch in een impasse gezet. de standaardwaarde is 10.
properties.maxMessageSizeInKilobytes	integer	Maximale grootte (in kB) van de nettolading van het bericht die kan worden geaccepteerd door de wachtrij. Deze eigenschap wordt momenteel alleen gebruikt in Premium en de standaardwaarde is 1024.
properties.maxSizeInMegabytes	integer	De maximale grootte van de wachtrij in megabytes. Dit is de grootte van het geheugen dat voor de wachtrij is toegewezen. De standaardwaarde is 1024.
properties.messageCount	integer	Het aantal berichten in de wachtrij.
properties.requiresDuplicateDetection	boolean	Een waarde die aangeeft of voor deze wachtrij dubbele detectie is vereist.
properties.requiresSession	boolean	Een waarde die aangeeft of de wachtrij het concept van sessies ondersteunt.
properties.sizeInBytes	integer	De grootte van de wachtrij, in bytes.
properties.status	EntityStatus	Inventariseert de mogelijke waarden voor de status van een berichtenentiteit.
properties.updatedAt	string	De exacte tijd waarop het bericht is bijgewerkt.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het type identiteit dat de resource het laatst heeft gewijzigd.
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.