Queues - Get

Ссылка

Служба:: Service Bus

Версия API:: 2024-01-01

Возвращает описание указанной очереди.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
namespaceName	path	True	string minLength: 6 maxLength: 50	Имя пространства имен
queueName	path	True	string minLength: 1	Имя очереди.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	SBQueue	Описание очереди успешно возвращено.
Other Status Codes	ErrorResponse	Ответ об ошибке ServiceBus, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Пример ответа

Код состояния:: 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"
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
EntityStatus	Состояние сущности.
Error	Объект ошибки.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ об ошибке управления ресурсами.
MessageCountDetails	Сведения о счетчике сообщений.
SBQueue	Описание ресурса очереди.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

EntityStatus

Перечисление

Состояние сущности.

Значение	Описание
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Объект ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Object

Ответ об ошибке управления ресурсами.

Имя	Тип	Описание
error	Error	Объект ошибки.

MessageCountDetails

Object

Сведения о счетчике сообщений.

Имя	Тип	Описание
activeMessageCount	integer (int64)	Количество активных сообщений в очереди, разделе или подписке.
deadLetterMessageCount	integer (int64)	Число сообщений, которые являются недоставленными.
scheduledMessageCount	integer (int64)	Количество запланированных сообщений.
transferDeadLetterMessageCount	integer (int64)	Количество сообщений, передаваемых в мертвые буквы.
transferMessageCount	integer (int64)	Количество сообщений, передаваемых в другую очередь, раздел или подписку.

SBQueue

Object

Описание ресурса очереди.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.accessedAt	string (date-time)	При последнем отправке сообщения или последнему запросу на получение в эту очередь.
properties.autoDeleteOnIdle	string (duration)	Интервал простоя области времени ISO 8061, после которого очередь автоматически удаляется. Минимальная длительность составляет 5 минут.
properties.countDetails	MessageCountDetails	Сведения о счетчике сообщений.
properties.createdAt	string (date-time)	Точное время создания сообщения.
properties.deadLetteringOnMessageExpiration	boolean	Значение, указывающее, поддерживает ли эта очередь недоставленную букву при истечении срока действия сообщения.
properties.defaultMessageTimeToLive	string (duration)	По умолчанию для интервала времени сообщения ISO 8601 в режиме реального времени. Это длительность, после которой истекает срок действия сообщения, начиная с момента отправки сообщения в служебную шину. Это значение по умолчанию, используемое, если TimeToLive не задан в самом сообщении.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Структура интервала времени ISO 8601, определяющая длительность журнала обнаружения дубликата. Значение по умолчанию равно 10 минутам.
properties.enableBatchedOperations	boolean	Значение, указывающее, включены ли пакетные операции на стороне сервера.
properties.enableExpress	boolean	Значение, указывающее, включены ли сущности Express. Экспресс-очередь временно хранит сообщение в памяти перед записью в постоянное хранилище.
properties.enablePartitioning	boolean	Значение, указывающее, следует ли секционировать очередь по нескольким брокерам сообщений.
properties.forwardDeadLetteredMessagesTo	string	Имя очереди и раздела для пересылки сообщения "Недоставленная буква"
properties.forwardTo	string	Имя очереди и раздела для пересылки сообщений
properties.lockDuration	string (duration)	Длительность интервала времени ISO 8601 при просмотре блокировки; т. е. время блокировки сообщения для других получателей. Максимальное значение для LockDuration составляет 5 минут; Значение по умолчанию — 1 минуту.
properties.maxDeliveryCount	integer (int32)	Максимальное число доставки. После этого количества поставок сообщение автоматически становится недоставленным. Значение по умолчанию — 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Максимальный размер (в КБ) полезных данных сообщения, которые можно принять в очереди. Это свойство используется только в Premium сегодня, а по умолчанию — 1024.
properties.maxSizeInMegabytes	integer (int32)	Максимальный размер очереди в мегабайтах, который является размером памяти, выделенной для очереди. Значение по умолчанию — 1024.
properties.messageCount	integer (int64)	Количество сообщений в очереди.
properties.requiresDuplicateDetection	boolean	Значение, указывающее, требуется ли для этой очереди обнаружение повторяющихся данных.
properties.requiresSession	boolean	Значение, указывающее, поддерживает ли очередь концепцию сеансов.
properties.sizeInBytes	integer (int64)	Размер очереди в байтах.
properties.status	EntityStatus	Перечисляет возможные значения состояния сущности обмена сообщениями.
properties.updatedAt	string (date-time)	Точное время обновления сообщения.
systemData	systemData	Системные метаданные, относящиеся к этому ресурсу.
type	string	Тип ресурса. Например, "Microsoft.EventHub/Namespaces" или "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Тип удостоверения, который последний раз изменил ресурс.
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Queues - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

QueueGet

Образец запроса

Пример ответа

Определения

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Дополнительные ресурсы