Queues - Get

Referencia

Szolgáltatás:: Service Bus

API-verzió:: 2024-01-01

A megadott üzenetsor leírását adja vissza.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	A névtér neve
queueName	path	True	string minLength: 1	Az üzenetsor neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	SBQueue	Az üzenetsor leírása sikeresen visszaadva.
Other Status Codes	ErrorResponse	ServiceBus-hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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

Mintaválasz

Állapotkó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"
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
EntityStatus	Entitás állapota.
Error	A hibaobjektum.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Az erőforrás-kezelési hibaválasz.
MessageCountDetails	Üzenetszám részletei.
SBQueue	A várólista-erőforrás leírása.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

EntityStatus

Enumerálás

Entitás állapota.

Érték	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Objektum

A hibaobjektum.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Objektum

Az erőforrás-kezelési hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

MessageCountDetails

Objektum

Üzenetszám részletei.

Name	Típus	Description
activeMessageCount	integer (int64)	Az üzenetsor, a témakör vagy az előfizetés aktív üzeneteinek száma.
deadLetterMessageCount	integer (int64)	A halottként írt üzenetek száma.
scheduledMessageCount	integer (int64)	Ütemezett üzenetek száma.
transferDeadLetterMessageCount	integer (int64)	A halott levelekbe átvitt üzenetek száma.
transferMessageCount	integer (int64)	Egy másik üzenetsorba, témakörbe vagy előfizetésbe átvitt üzenetek száma.

SBQueue

Objektum

A várólista-erőforrás leírása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.accessedAt	string (date-time)	Az üzenet legutóbbi elküldésekor vagy az üzenetsorra irányuló legutóbbi fogadási kéréskor.
properties.autoDeleteOnIdle	string (duration)	ISO 8061 timeSpan tétlen intervallum, amely után az üzenetsor automatikusan törlődik. A minimális időtartam 5 perc.
properties.countDetails	MessageCountDetails	Üzenetszám részletei.
properties.createdAt	string (date-time)	Az üzenet létrehozásának pontos időpontja.
properties.deadLetteringOnMessageExpiration	boolean	Egy érték, amely azt jelzi, hogy az üzenetsor támogatja-e a kézbesítetlen levelek támogatását egy üzenet lejáratakor.
properties.defaultMessageTimeToLive	string (duration)	AZ ISO 8601 alapértelmezett üzenetideje élő értékre. Ez az az időtartam, amely után az üzenet lejár, attól kezdve, hogy az üzenet el lesz küldve a Service Busnak. Ez az alapértelmezett érték, amikor a TimeToLive nincs beállítva egy üzeneten.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	ISO 8601 timeSpan struktúra, amely meghatározza az ismétlődő észlelési előzmények időtartamát. Az alapértelmezett érték 10 perc.
properties.enableBatchedOperations	boolean	Az érték azt jelzi, hogy a kiszolgálóoldali kötegelt műveletek engedélyezve vannak-e.
properties.enableExpress	boolean	Egy érték, amely jelzi, hogy engedélyezve vannak-e az Express-entitások. Az expressz üzenetsorok ideiglenesen a memóriában tárolnak egy üzenetet, mielőtt állandó tárolóba írják.
properties.enablePartitioning	boolean	Egy érték, amely jelzi, hogy az üzenetsor több üzenetközvetítő között particionálásra kerül-e.
properties.forwardDeadLetteredMessagesTo	string	Üzenetsor/témakör neve a Kézbesítetlen levél üzenet továbbításához
properties.forwardTo	string	Üzenetsor/témakör neve az üzenetek továbbításához
properties.lockDuration	string (duration)	A betekintő zárolás ISO 8601-szeres időtartama; vagyis az az idő, amikor az üzenet más fogadók számára zárolva van. A LockDuration maximális értéke 5 perc; az alapértelmezett érték 1 perc.
properties.maxDeliveryCount	integer (int32)	A maximális szállítási szám. A megadott számú kézbesítés után a rendszer automatikusan leáll egy üzenetet. alapértelmezett érték 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Az üzenet hasznos adatainak maximális mérete (KB-ban), amelyet az üzenetsor elfogadhat. Ez a tulajdonság jelenleg csak a Premiumban használatos, alapértelmezett értéke pedig 1024.
properties.maxSizeInMegabytes	integer (int32)	Az üzenetsor maximális mérete megabájtban, azaz az üzenetsorhoz lefoglalt memória mérete. Az alapértelmezett érték 1024.
properties.messageCount	integer (int64)	Az üzenetsorban lévő üzenetek száma.
properties.requiresDuplicateDetection	boolean	Egy érték, amely jelzi, hogy az üzenetsor duplikált észlelést igényel-e.
properties.requiresSession	boolean	Egy érték, amely jelzi, hogy az üzenetsor támogatja-e a munkamenetek fogalmát.
properties.sizeInBytes	integer (int64)	Az üzenetsor mérete bájtban.
properties.status	EntityStatus	Számba adja az üzenetküldő entitás állapotának lehetséges értékeit.
properties.updatedAt	string (date-time)	Az üzenet frissítésének pontos időpontja.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Pl. "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrást legutóbb módosító identitás típusa.
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Queues - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

QueueGet

Mintakérelem

Mintaválasz

Definíciók

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

További források