Queues - Get
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=2021-11-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
namespace
|
path | True |
string |
Nome dello spazio dei nomi |
queue
|
path | True |
string |
Nome della coda. |
resource
|
path | True |
string |
Nome del gruppo di risorse all'interno della sottoscrizione di Azure. |
subscription
|
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 di servizio. |
api-version
|
query | True |
string |
Versione API client. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Descrizione della coda restituita correttamente. |
|
Other Status Codes |
Risposta di errore del bus di servizio che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
QueueGet
Sample Request
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
Sample Response
{
"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 |
---|---|
created |
Tipo di identità che ha creato la risorsa. |
Entity |
Stato entità. |
Error |
Oggetto error. |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Risposta all'errore di gestione delle risorse. |
Message |
Dettagli conteggio messaggi. |
SBQueue |
Descrizione della risorsa della coda. |
system |
Metadati relativi alla creazione e all'ultima modifica della risorsa. |
createdByType
Tipo di identità che ha creato la risorsa.
Nome | Tipo | Descrizione |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EntityStatus
Stato entità.
Nome | Tipo | Descrizione |
---|---|---|
Active |
string |
|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
ReceiveDisabled |
string |
|
Renaming |
string |
|
Restoring |
string |
|
SendDisabled |
string |
|
Unknown |
string |
Error
Oggetto error.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorResponse
Risposta all'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
MessageCountDetails
Dettagli conteggio messaggi.
Nome | Tipo | Descrizione |
---|---|---|
activeMessageCount |
integer |
Numero di messaggi attivi nella coda, nell'argomento o nella sottoscrizione. |
deadLetterMessageCount |
integer |
Numero di messaggi non recapitabili. |
scheduledMessageCount |
integer |
Numero di messaggi pianificati. |
transferDeadLetterMessageCount |
integer |
Numero di messaggi trasferiti in lettere non recapitabili. |
transferMessageCount |
integer |
Numero di messaggi trasferiti a un'altra coda, argomento o sottoscrizione. |
SBQueue
Descrizione della risorsa della coda.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di 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 |
Ultima volta che è stato inviato un messaggio o l'ultima volta che è stata inviata una richiesta di ricezione a questa coda. |
properties.autoDeleteOnIdle |
string |
Intervallo di inattività ISO 8061 timeSpan dopo il quale la coda viene eliminata automaticamente. La durata minima è 5 minuti. |
properties.countDetails |
Dettagli conteggio messaggi. |
|
properties.createdAt |
string |
Ora esatta in cui è stato creato il messaggio. |
properties.deadLetteringOnMessageExpiration |
boolean |
Valore che indica se la coda include supporto per messaggi non recapitabili alla scadenza di un messaggio. |
properties.defaultMessageTimeToLive |
string |
IsO 8601 timepan del messaggio predefinito per il valore attivo. 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 |
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à express 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 |
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 |
Numero massimo di recapito. Una volta superato questo numero, il messaggio non verrà più recapito. il valore predefinito è 10. |
properties.maxMessageSizeInKilobytes |
integer |
Dimensione massima (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 |
Dimensione massima della coda in megabyte, ovvero la dimensione della memoria allocata per la coda. Il valore predefinito è 1024. |
properties.messageCount |
integer |
Numero di messaggi nella coda. |
properties.requiresDuplicateDetection |
boolean |
Valore che indica se la coda richiede il rilevamento dei duplicati. |
properties.requiresSession |
boolean |
Valore che indica se la coda supporta il concetto di sessioni. |
properties.sizeInBytes |
integer |
Dimensioni della coda, in byte. |
properties.status |
Enumera i valori possibili per lo stato di un'entità di messaggistica. |
|
properties.updatedAt |
string |
Ora esatta dell'aggiornamento del messaggio. |
systemData |
Metadati di sistema relativi a questa risorsa. |
|
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs" |
systemData
Metadati relativi alla creazione e all'ultima modifica della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string |
Timestamp della creazione di risorse (UTC). |
createdBy |
string |
Identità che ha creato la risorsa. |
createdByType |
Tipo di identità che ha creato la risorsa. |
|
lastModifiedAt |
string |
Tipo di identità che ha modificato l'ultima volta la risorsa. |
lastModifiedBy |
string |
Identità che ha modificato l'ultima volta la risorsa. |
lastModifiedByType |
Tipo di identità che ha modificato l'ultima volta la risorsa. |