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

Name	In(다음 안에)	필수	형식	Description
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 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

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

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

QueueGet

샘플 요청

HTTP

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

dotnet

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

정의

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

createdByType

열거형

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

값	Description
Application
Key
ManagedIdentity
User

EntityStatus

열거형

엔터티 상태입니다.

값	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

오류 개체입니다.

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

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

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

Name	형식	Description
error	Error	오류 개체입니다.

MessageCountDetails

Object

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

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

SBQueue

Object

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

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties.accessedAt	string (date-time)	메시지를 마지막으로 보낸 시간 또는 이 큐에 대한 수신 요청이 마지막으로 있었던 시간입니다.
properties.autoDeleteOnIdle	string (duration)	ISO 8061 timeSpan 유휴 간격 후 큐가 자동으로 삭제됩니다. 최소 기간은 5분입니다.
properties.countDetails	MessageCountDetails	메시지 개수 세부 정보입니다.
properties.createdAt	string (date-time)	메시지가 만들어진 정확한 시간입니다.
properties.deadLetteringOnMessageExpiration	boolean	메시지가 만료되면 이 큐에 배달 못 한 편지 지원이 있는지 여부를 나타내는 값입니다.
properties.defaultMessageTimeToLive	string (duration)	ISO 8601 기본 메시지 시간 범위는 라이브 값입니다. 메시지가 Service Bus로 전송되는 시점부터 시작하여 메시지가 만료되는 기간입니다. TimeToLive가 메시지 자체에 설정되지 않은 경우 사용되는 기본값입니다.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	중복 검색 기록의 기간을 정의하는 ISO 8601 timeSpan 구조체입니다. 기본값은 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)	큐에서 수락할 수 있는 메시지 페이로드의 최대 크기(KB)입니다. 이 속성은 현재 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

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

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