Queues - Get

Ссылка

Service:: Service Bus

API Version:: 2021-11-01

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

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

Параметры URI

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

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

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


import com.azure.core.util.Context;

/** Samples for Queues Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
     */
    /**
     * Sample code: QueueGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void queueGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getQueues().getWithResponse("ArunMonocle",
            "sdk-Namespace-3174", "sdk-Queues-5647", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_queue_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.queues.get(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace-3174",
        queue_name="sdk-Queues-5647",
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
func ExampleQueuesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQueuesClient().Get(ctx, "ArunMonocle", "sdk-Namespace-3174", "sdk-Queues-5647", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SBQueue = armservicebus.SBQueue{
	// 	Name: to.Ptr("sdk-Queues-5647"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces/Queues"),
	// 	ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647"),
	// 	Properties: &armservicebus.SBQueueProperties{
	// 		AccessedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		AutoDeleteOnIdle: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:32.459Z"); return t}()),
	// 		DefaultMessageTimeToLive: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		DuplicateDetectionHistoryTimeWindow: to.Ptr("PT10M"),
	// 		EnableExpress: to.Ptr(false),
	// 		EnablePartitioning: to.Ptr(true),
	// 		LockDuration: to.Ptr("PT1M"),
	// 		MaxDeliveryCount: to.Ptr[int32](10),
	// 		MaxMessageSizeInKilobytes: to.Ptr[int64](10240),
	// 		MaxSizeInMegabytes: to.Ptr[int32](163840),
	// 		MessageCount: to.Ptr[int64](0),
	// 		RequiresDuplicateDetection: to.Ptr(false),
	// 		RequiresSession: to.Ptr(false),
	// 		SizeInBytes: to.Ptr[int64](0),
	// 		Status: to.Ptr(armservicebus.EntityStatusActive),
	// 		UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:34.624Z"); return t}()),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns a description for the specified queue.
 *
 * @summary Returns a description for the specified queue.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
 */
async function queueGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace-3174";
  const queueName = "sdk-Queues-5647";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.queues.get(resourceGroupName, namespaceName, queueName);
  console.log(result);
}

queueGet().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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	Объект error.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ об ошибке управления ресурсами.
MessageCountDetails	Сведения о количестве сообщений.
SBQueue	Описание ресурса очереди.
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

createdByType

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

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

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

Имя	Тип	Описание
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Объект error.

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

ErrorAdditionalInfo

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

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

ErrorResponse

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

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

MessageCountDetails

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

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

SBQueue

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

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

systemData

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

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

Share via

Queues - Get

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

QueueGet

Sample Request

Sample Response

Определения

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

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