Queues - Get

Référence

Service:: Service Bus

Version d'API:: 2024-01-01

Retourne une description de 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=2024-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Nom de l’espace de noms
queueName	path	True	string minLength: 1	Nom de la file d’attente.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
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 de chaque appel de service.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

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 pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

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

Exemple de réponse

Code d’état:: 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	État de l’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

Énumération

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

Valeur	Description
Application
Key
ManagedIdentity
User

EntityStatus

Énumération

État de l’entité.

Valeur	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

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

Object

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

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

ErrorResponse

Object

Réponse d’erreur de gestion des ressources.

Nom	Type	Description
error	Error	Objet d’erreur.

MessageCountDetails

Object

Détails du nombre de messages.

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

SBQueue

Object

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 (date-time)	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 (duration)	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 (date-time)	Heure exacte de création du message.
properties.deadLetteringOnMessageExpiration	boolean	Valeur qui indique si cette file d’attente a une prise en charge de lettres mortes lorsqu’un message expire.
properties.defaultMessageTimeToLive	string (duration)	Intervalle de temps de message par défaut ISO 8601 à valeur dynamique. Il s’agit de la durée d’expiration du message, à partir de laquelle 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 (duration)	Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection en double. La valeur par défaut est de 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 contient 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 sur plusieurs répartiteurs de messages.
properties.forwardDeadLetteredMessagesTo	string	Nom de file d’attente/rubrique pour transférer le message lettre morte
properties.forwardTo	string	Nom de file d’attente/rubrique pour transférer les messages
properties.lockDuration	string (duration)	Durée d’intervalle de temps ISO 8601 d’un verrou d’aperçu ; autrement dit, 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 de 1 minute.
properties.maxDeliveryCount	integer (int32)	Nombre maximal de livraisons. Un message est automatiquement mis hors service après ce nombre de livraisons. la valeur par défaut est 10.
properties.maxMessageSizeInKilobytes	integer (int64)	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 (int32)	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 (int64)	Nombre de messages dans la file d’attente.
properties.requiresDuplicateDetection	boolean	Valeur indiquant si cette file d’attente nécessite une détection en double.
properties.requiresSession	boolean	Valeur qui indique si la file d’attente prend en charge le concept de sessions.
properties.sizeInBytes	integer (int64)	Taille de la file d’attente, en octets.
properties.status	EntityStatus	Énumère les valeurs possibles pour l’état d’une entité de messagerie.
properties.updatedAt	string (date-time)	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

Object

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	Type d’identité qui a modifié la ressource pour la dernière fois.
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Queues - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

QueueGet

Exemple de requête

Exemple de réponse

Définitions

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Ressources supplémentaires