Queues - Get

Service:

Service Bus

API Version:

2021-11-01

Retourne une description pour la file d’attente spécifiée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
namespaceName	path	True	string	Nom de l’espace de noms
queueName	path	True	string	le nom de la file d’attente ;
resourceGroupName	path	True	string	Nom du groupe de ressources au sein de l’abonnement Azure.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version d’API client.

Réponses

Nom	Type	Description
200 OK	SBQueue	Description de la file d’attente retournée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur ServiceBus décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
EntityStatus	Status d’entité.
Error	Objet d’erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur de gestion des ressources.
MessageCountDetails	Détails du nombre de messages.
SBQueue	Description de la ressource de file d’attente.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Status d’entité.

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

Error

Objet d’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur de gestion des ressources.

Nom	Type	Description
error	Error	Objet d’erreur.

MessageCountDetails

Détails du nombre de messages.

Nom	Type	Description
activeMessageCount	integer	Nombre de messages actifs dans la file d’attente, la rubrique ou l’abonnement.
deadLetterMessageCount	integer	Nombre de messages qui sont en lettres mortes.
scheduledMessageCount	integer	Nombre de messages planifiés.
transferDeadLetterMessageCount	integer	Nombre de messages transférés en lettres mortes.
transferMessageCount	integer	Nombre de messages transférés vers une autre file d’attente, rubrique ou abonnement.

SBQueue

Description de la ressource de file d’attente.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties.accessedAt	string	La dernière fois qu’un message a été envoyé ou la dernière fois qu’une demande de réception a été envoyée à cette file d’attente.
properties.autoDeleteOnIdle	string	Intervalle d’inactivité iso 8061 timeSpan après lequel la file d’attente est automatiquement supprimée. La durée minimale est de 5 minutes.
properties.countDetails	MessageCountDetails	Détails du nombre de messages.
properties.createdAt	string	Heure exacte à laquelle le message a été créé.
properties.deadLetteringOnMessageExpiration	boolean	Valeur qui indique si cette file d’attente a la prise en charge des lettres mortes lorsqu’un message expire.
properties.defaultMessageTimeToLive	string	Intervalle de temps de message par défaut ISO 8601 à valeur dynamique. Il s’agit de la durée après laquelle le message expire, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même.
properties.duplicateDetectionHistoryTimeWindow	string	Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection en double. La valeur par défaut est 10 minutes.
properties.enableBatchedOperations	boolean	Valeur qui indique si les opérations par lots côté serveur sont activées.
properties.enableExpress	boolean	Valeur qui indique si les entités Express sont activées. Une file d’attente express conserve temporairement un message en mémoire avant de l’écrire dans un stockage persistant.
properties.enablePartitioning	boolean	Valeur qui indique si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages.
properties.forwardDeadLetteredMessagesTo	string	Nom de la file d’attente/de la rubrique pour transférer le message lettre morte
properties.forwardTo	string	Nom de la file d’attente/de la rubrique pour transférer les messages
properties.lockDuration	string	Durée de la période ISO 8601 d’un peek-lock ; c’est-à-dire la durée pendant laquelle le message est verrouillé pour d’autres récepteurs. La valeur maximale de LockDuration est de 5 minutes ; la valeur par défaut est 1 minute.
properties.maxDeliveryCount	integer	Nombre maximal de remises. Un message devient une lettre morte après ce nombre de remises. la valeur par défaut est 10.
properties.maxMessageSizeInKilobytes	integer	Taille maximale (en Ko) de la charge utile du message qui peut être acceptée par la file d’attente. Cette propriété est utilisée uniquement dans Premium aujourd’hui et la valeur par défaut est 1024.
properties.maxSizeInMegabytes	integer	Taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée pour la file d’attente. La valeur par défaut est 1024.
properties.messageCount	integer	Nombre des messages présents dans la file d'attente.
properties.requiresDuplicateDetection	boolean	Valeur indiquant si cette file d’attente nécessite une détection dupliquée.
properties.requiresSession	boolean	Valeur qui indique si la file d’attente prend en charge le concept de sessions.
properties.sizeInBytes	integer	Taille de la file d’attente, en octets.
properties.status	EntityStatus	Énumère les valeurs possibles pour le status d’une entité de messagerie.
properties.updatedAt	string	Heure exacte à laquelle le message a été mis à jour.
systemData	systemData	Métadonnées système relatives à cette ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Type d’identité qui a modifié la dernière ressource.
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.