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 매개 변수

Name	In(다음 안에)	필수	형식	Description
namespaceName	path	True	string	네임스페이스 이름
queueName	path	True	string	큐 이름입니다.
resourceGroupName	path	True	string	Azure 구독 내의 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	SBQueue	큐 설명이 성공적으로 반환되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 ServiceBus 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
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"
  }
}

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
EntityStatus	엔터티 상태.
Error	Error 개체.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorResponse	리소스 관리 오류 응답입니다.
MessageCountDetails	메시지 수 세부 정보입니다.
SBQueue	큐 리소스에 대한 설명입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

엔터티 상태.

Name	형식	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Error 개체.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorResponse[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorResponse

리소스 관리 오류 응답입니다.

Name	형식	Description
error	Error	Error 개체.

MessageCountDetails

메시지 수 세부 정보입니다.

Name	형식	Description
activeMessageCount	integer	큐, 토픽 또는 구독의 활성 메시지 수입니다.
deadLetterMessageCount	integer	배달 못한 편지가 있는 메시지 수입니다.
scheduledMessageCount	integer	예약된 메시지 수입니다.
transferDeadLetterMessageCount	integer	배달 못한 편지로 전송된 메시지 수입니다.
transferMessageCount	integer	다른 큐, 토픽 또는 구독으로 전송된 메시지 수입니다.

SBQueue

큐 리소스에 대한 설명입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /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 기본 메시지 시간 범위를 라이브 값으로 설정합니다. 메시지가 Service Bus로 전송되는 시점부터 시작하여 메시지가 만료되는 기간입니다. TimeToLive가 메시지 자체에 설정되지 않은 경우 사용되는 기본값입니다.
properties.duplicateDetectionHistoryTimeWindow	string	중복 검색 기록의 기간을 정의하는 ISO 8601 timeSpan 구조체입니다. 기본값은 10분입니다.
properties.enableBatchedOperations	boolean	서버 쪽 일괄 처리 작업을 사용할 수 있는지 여부를 나타내는 값입니다.
properties.enableExpress	boolean	Express 엔터티를 사용할 수 있는지 여부를 나타내는 값입니다. 빠른 큐는 영구 스토리지에 쓰기 전에 일시적으로 메모리에 메시지를 보관합니다.
properties.enablePartitioning	boolean	큐를 여러 메시지 브로커 간에 분할할지 여부를 나타내는 값입니다.
properties.forwardDeadLetteredMessagesTo	string	배달 못 한 편지 메시지를 전달할 큐/토픽 이름
properties.forwardTo	string	메시지를 전달할 큐/토픽 이름
properties.lockDuration	string	피킹 잠금의 ISO 8601 시간 범위 기간; 즉, 다른 수신기에 대해 메시지가 잠긴 시간입니다. LockDuration의 최대값은 5분입니다. 기본값은 1분입니다.
properties.maxDeliveryCount	integer	최대 배달 수입니다. 메시지는 이 배달 횟수가 지난 후 자동으로 배달 못한 편지로 설정됩니다. 기본값은 10입니다.
properties.maxMessageSizeInKilobytes	integer	큐에서 수락할 수 있는 메시지 페이로드의 최대 크기(KB)입니다. 이 속성은 현재 Premium에서만 사용되며 기본값은 1024입니다.
properties.maxSizeInMegabytes	integer	큐의 최대 크기(MB)로, 큐에 할당된 메모리 크기입니다. 기본값은 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

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스를 마지막으로 수정한 ID 유형입니다.
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

Queues - Get

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

QueueGet

Sample Request

Sample Response

정의

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

추가 리소스