Queues - Get

Başvuru

Hizmet:: Service Bus

API Sürümü:: 2024-01-01

Belirtilen kuyruk için bir açıklama döndürür.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Ad alanı adı
queueName	path	True	string minLength: 1	Kuyruk adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	SBQueue	Kuyruk açıklaması başarıyla döndürüldü.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan ServiceBus hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
EntityStatus	Varlık durumu.
Error	Hata nesnesi.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorResponse	Kaynak yönetimi hata yanıtı.
MessageCountDetails	İleti Sayısı Ayrıntıları.
SBQueue	Kuyruk Kaynağının açıklaması.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
Application
Key
ManagedIdentity
User

EntityStatus

Listeleme

Varlık durumu.

Değer	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Hata nesnesi.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorResponse[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorResponse

Object

Kaynak yönetimi hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

MessageCountDetails

Object

İleti Sayısı Ayrıntıları.

Name	Tür	Description
activeMessageCount	integer (int64)	Kuyruk, konu veya abonelikteki etkin iletilerin sayısı.
deadLetterMessageCount	integer (int64)	Teslim edilemeyen ileti sayısı.
scheduledMessageCount	integer (int64)	Zamanlanmış ileti sayısı.
transferDeadLetterMessageCount	integer (int64)	Geçersiz harflere aktarılan ileti sayısı.
transferMessageCount	integer (int64)	Başka bir kuyruğa, konuya veya aboneliğe aktarılan ileti sayısı.

SBQueue

Object

Kuyruk Kaynağının açıklaması.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.accessedAt	string (date-time)	Bir iletinin en son gönderildiği veya bu kuyruğa en son bir alma isteği gönderildiği zaman.
properties.autoDeleteOnIdle	string (duration)	KUYRUĞUn otomatik olarak silindiği ISO 8061 timeSpan boşta kalma aralığı. En düşük süre 5 dakikadır.
properties.countDetails	MessageCountDetails	İleti Sayısı Ayrıntıları.
properties.createdAt	string (date-time)	İletinin oluşturulduğu tam saat.
properties.deadLetteringOnMessageExpiration	boolean	İletinin süresi dolduğunda bu kuyruğun teslim edilemeyen ileti desteği olup olmadığını gösteren değer.
properties.defaultMessageTimeToLive	string (duration)	ISO 8601 varsayılan ileti zaman aralığı canlı değerdir. Bu süre, iletinin Service Bus'a gönderilmesinden başlayarak iletinin süresinin dolmasına neden olan süredir. Bu, TimeToLive iletinin kendisinde ayarlanmadığında kullanılan varsayılan değerdir.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Yinelenen algılama geçmişinin süresini tanımlayan ISO 8601 timeSpan yapısı. Varsayılan değer 10 dakikadır.
properties.enableBatchedOperations	boolean	Sunucu tarafı toplu işlemlerin etkinleştirilip etkinleştirilmediğini gösteren değer.
properties.enableExpress	boolean	Express Varlıklarının etkinleştirilip etkinleştirilmediğini gösteren değer. Hızlı kuyruk, bir iletiyi kalıcı depolamaya yazmadan önce geçici olarak bellekte tutar.
properties.enablePartitioning	boolean	Kuyruğun birden çok ileti aracısı arasında bölümlenip bölümlenmeyeceğini gösteren değer.
properties.forwardDeadLetteredMessagesTo	string	Teslim Edilemeyen İleti iletisini iletmek için Kuyruk/Konu adı
properties.forwardTo	string	İletileri iletmek için Kuyruk/Konu adı
properties.lockDuration	string (duration)	Bir peek-lock'un ISO 8601 zaman aralığı süresi; diğer bir deyişle, iletinin diğer alıcılar için kilitlendiği süre. LockDuration için en yüksek değer 5 dakikadır; varsayılan değer 1 dakikadır.
properties.maxDeliveryCount	integer (int32)	Maksimum teslimat sayısı. Bu sayıda teslimat sonrasında ileti otomatik olarak geçersizdir. varsayılan değer 10'dur.
properties.maxMessageSizeInKilobytes	integer (int64)	Kuyruk tarafından kabul edilebilecek ileti yükünün en büyük boyutu (KB cinsinden). Bu özellik bugün yalnızca Premium'da kullanılır ve varsayılan değer 1024'dür.
properties.maxSizeInMegabytes	integer (int32)	Kuyruğun megabayt cinsinden boyut üst sınırı; bu, kuyruk için ayrılan belleğin boyutudur. Varsayılan değer 1024'dür.
properties.messageCount	integer (int64)	Kuyruktaki iletilerin sayısı.
properties.requiresDuplicateDetection	boolean	Bu kuyruğun yinelenen algılama gerektip gerektirmediğini belirten bir değer.
properties.requiresSession	boolean	Kuyruğun oturum kavramını destekleyip desteklemediğini gösteren değer.
properties.sizeInBytes	integer (int64)	Kuyruğun bayt cinsinden boyutu.
properties.status	EntityStatus	Bir mesajlaşma varlığının durumu için olası değerleri numaralandırır.
properties.updatedAt	string (date-time)	İletinin tam olarak güncelleştirilildiği saat.
systemData	systemData	Bu kaynakla ilgili sistem meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.EventHub/Namespaces" veya "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağı en son değiştiren kimlik türü.
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

Aracılığıyla paylaş

Queues - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

QueueGet

Örnek isteği

Örnek yanıt

Tanımlar

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Ek kaynaklar