Queues - Get

Riferimento

Servizio:: Service Bus

Versione API:: 2024-01-01

Restituisce una descrizione per la coda specificata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namespaceName	path	True	string minLength: 6 maxLength: 50	Nome dello spazio dei nomi
queueName	path	True	string minLength: 1	Nome della coda.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	SBQueue	Descrizione della coda restituita correttamente.
Other Status Codes	ErrorResponse	Risposta di errore servicebus che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
EntityStatus	Stato entità.
Error	Oggetto error.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta di errore di gestione delle risorse.
MessageCountDetails	Dettagli conteggio messaggi.
SBQueue	Descrizione della risorsa della coda.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

EntityStatus

Enumerazione

Stato entità.

Valore	Descrizione
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Object

Risposta di errore di gestione delle risorse.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

MessageCountDetails

Object

Dettagli conteggio messaggi.

Nome	Tipo	Descrizione
activeMessageCount	integer (int64)	Numero di messaggi attivi nella coda, nell'argomento o nella sottoscrizione.
deadLetterMessageCount	integer (int64)	Numero di messaggi non recapitabili.
scheduledMessageCount	integer (int64)	Numero di messaggi pianificati.
transferDeadLetterMessageCount	integer (int64)	Numero di messaggi trasferiti in lettere non recapitabili.
transferMessageCount	integer (int64)	Numero di messaggi trasferiti a un'altra coda, argomento o sottoscrizione.

SBQueue

Object

Descrizione della risorsa della coda.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.accessedAt	string (date-time)	Ora dell'ultimo invio di un messaggio o dell'ultima volta in cui è stata inviata una richiesta di ricezione a questa coda.
properties.autoDeleteOnIdle	string (duration)	Intervallo di inattività ISO 8061 timeSpan dopo il quale la coda viene eliminata automaticamente. La durata minima è di 5 minuti.
properties.countDetails	MessageCountDetails	Dettagli conteggio messaggi.
properties.createdAt	string (date-time)	Ora esatta di creazione del messaggio.
properties.deadLetteringOnMessageExpiration	boolean	Valore che indica se la coda include il supporto di messaggi non recapitabili alla scadenza di un messaggio.
properties.defaultMessageTimeToLive	string (duration)	Intervallo di tempo predefinito per i messaggi ISO 8601 in tempo reale. Questa è la durata dopo la quale il messaggio scade, a partire dal momento in cui il messaggio viene inviato al bus di servizio. Questo è il valore predefinito usato quando TimeToLive non è impostato su un messaggio stesso.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Struttura timeSpan ISO 8601 che definisce la durata della cronologia di rilevamento duplicati. Il valore predefinito è 10 minuti.
properties.enableBatchedOperations	boolean	Valore che indica se le operazioni in batch sul lato server sono abilitate.
properties.enableExpress	boolean	Valore che indica se le entità rapide sono abilitate. Una coda rapida contiene temporaneamente un messaggio in memoria prima di scriverlo nell'archiviazione permanente.
properties.enablePartitioning	boolean	Valore che indica se la coda deve essere partizionata tra più broker di messaggi.
properties.forwardDeadLetteredMessagesTo	string	Nome coda/argomento per inoltrare il messaggio di messaggi non recapitabili
properties.forwardTo	string	Nome coda/argomento per inoltrare i messaggi
properties.lockDuration	string (duration)	DURATA ISO 8601 intervallo di tempo di un blocco a comparsa; ovvero la quantità di tempo in cui il messaggio è bloccato per altri ricevitori. Il valore massimo per LockDuration è 5 minuti; il valore predefinito è 1 minuto.
properties.maxDeliveryCount	integer (int32)	Numero massimo di recapito. Un messaggio viene automaticamente disattivato dopo questo numero di consegne. il valore predefinito è 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Dimensioni massime (in KB) del payload del messaggio che può essere accettato dalla coda. Questa proprietà viene usata solo in Premium e il valore predefinito è 1024.
properties.maxSizeInMegabytes	integer (int32)	Dimensione massima della coda in megabyte, ovvero la dimensione della memoria allocata per la coda. Il valore predefinito è 1024.
properties.messageCount	integer (int64)	Numero di messaggi nella coda.
properties.requiresDuplicateDetection	boolean	Valore che indica se la coda richiede il rilevamento duplicato.
properties.requiresSession	boolean	Valore che indica se la coda supporta il concetto di sessioni.
properties.sizeInBytes	integer (int64)	Dimensioni della coda, in byte.
properties.status	EntityStatus	Enumera i valori possibili per lo stato di un'entità di messaggistica.
properties.updatedAt	string (date-time)	Ora esatta in cui il messaggio è stato aggiornato.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Tipo di identità che ha modificato l'ultima volta la risorsa.
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Queues - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

QueueGet

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Risorse aggiuntive