Queues - Get

Reference

Služba:: Service Bus

Verze rozhraní API:: 2024-01-01

Vrátí popis pro zadanou frontu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Název oboru názvů
queueName	path	True	string minLength: 1	Název fronty.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	SBQueue	Popis fronty byl úspěšně vrácen.
Other Status Codes	ErrorResponse	Odpověď na chybu ServiceBus popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
EntityStatus	Stav entity
Error	Objekt chyby.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu správy prostředků.
MessageCountDetails	Podrobnosti o počtu zpráv
SBQueue	Popis prostředku fronty
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

EntityStatus

Výčet

Stav entity

Hodnota	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Objekt

Objekt chyby.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Objekt

Odpověď na chybu správy prostředků.

Name	Typ	Description
error	Error	Objekt chyby.

MessageCountDetails

Objekt

Podrobnosti o počtu zpráv

Name	Typ	Description
activeMessageCount	integer (int64)	Počet aktivních zpráv ve frontě, tématu nebo odběru
deadLetterMessageCount	integer (int64)	Početzprávýchch
scheduledMessageCount	integer (int64)	Počet naplánovaných zpráv
transferDeadLetterMessageCount	integer (int64)	Počet zpráv přenesených na mrtvá písmena
transferMessageCount	integer (int64)	Počet zpráv přenesených do jiné fronty, tématu nebo odběru

SBQueue

Objekt

Popis prostředku fronty

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.accessedAt	string (date-time)	Čas posledního odeslání zprávy nebo posledního odeslání žádosti o přijetí této fronty.
properties.autoDeleteOnIdle	string (duration)	Interval nečinnosti timeSpan ISO 8061, po kterém se fronta automaticky odstraní. Minimální doba trvání je 5 minut.
properties.countDetails	MessageCountDetails	Podrobnosti o počtu zpráv
properties.createdAt	string (date-time)	Přesný čas vytvoření zprávy.
properties.deadLetteringOnMessageExpiration	boolean	Hodnota, která označuje, jestli má tato fronta podporu nedoručených zpráv, když vyprší platnost zprávy.
properties.defaultMessageTimeToLive	string (duration)	Výchozí časový rozsah zprávy ISO 8601 na hodnotu live. Jedná se o dobu, po které vyprší platnost zprávy, počínaje odesláním zprávy do služby Service Bus. Toto je výchozí hodnota použitá v případě, že TimeToLive není nastaven na samotnou zprávu.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Struktura ISO 8601 timeSpan, která definuje dobu trvání historie detekce duplicit. Výchozí hodnota je 10 minut.
properties.enableBatchedOperations	boolean	Hodnota označující, jestli jsou povolené dávkové operace na straně serveru.
properties.enableExpress	boolean	Hodnota, která označuje, jestli jsou povolené expresní entity. Expresní fronta uchovává zprávu dočasně v paměti před zápisem do trvalého úložiště.
properties.enablePartitioning	boolean	Hodnota, která označuje, jestli má být fronta rozdělena mezi více zprostředkovatelů zpráv.
properties.forwardDeadLetteredMessagesTo	string	Název fronty nebo tématu pro přeposlání zprávy o nedoručených zprávách
properties.forwardTo	string	Název fronty nebo tématu pro přeposílání zpráv
properties.lockDuration	string (duration)	Doba trvání časového intervalu ISO 8601 pro náhled zámku; to znamená, že doba, po kterou je zpráva uzamčena pro ostatní příjemce. Maximální hodnota lockDuration je 5 minut; výchozí hodnota je 1 minuta.
properties.maxDeliveryCount	integer (int32)	Maximální počet doručení. Po tomto počtu dodávek se zpráva automaticky zamřená. výchozí hodnota je 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Maximální velikost datové části zprávy (v kB), kterou může fronta přijmout. Tato vlastnost se dnes používá jenom v Premium a výchozí hodnota je 1024.
properties.maxSizeInMegabytes	integer (int32)	Maximální velikost fronty v megabajtech, což je velikost paměti přidělené frontě. Výchozí hodnota je 1024.
properties.messageCount	integer (int64)	Počet zpráv ve frontě
properties.requiresDuplicateDetection	boolean	Hodnota označující, jestli tato fronta vyžaduje detekci duplicit.
properties.requiresSession	boolean	Hodnota, která označuje, jestli fronta podporuje koncept relací.
properties.sizeInBytes	integer (int64)	Velikost fronty vbajch
properties.status	EntityStatus	Vytvoří výčet možných hodnot pro stav entity zasílání zpráv.
properties.updatedAt	string (date-time)	Přesný čas, kdy byla zpráva aktualizována.
systemData	systemData	Systémová meta data týkající se tohoto prostředku.
type	string	Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Typ identity, která naposledy změnila prostředek.
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Queues - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

QueueGet

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Další materiály