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 參數

名稱	位於	必要	類型	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 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	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

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
EntityStatus	實體狀態。
Error	error 物件。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	資源管理錯誤回應。
MessageCountDetails	訊息計數詳細數據。
SBQueue	佇列資源的描述。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

EntityStatus

列舉型別

實體狀態。

值	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

error 物件。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

Object

資源管理錯誤回應。

名稱	類型	Description
error	Error	error 物件。

MessageCountDetails

Object

訊息計數詳細數據。

名稱	類型	Description
activeMessageCount	integer (int64)	佇列、主題或訂用帳戶中的作用中訊息數目。
deadLetterMessageCount	integer (int64)	寄不出的信件數目。
scheduledMessageCount	integer (int64)	排程的訊息數目。
transferDeadLetterMessageCount	integer (int64)	傳送到寄不出的信件的訊息數目。
transferMessageCount	integer (int64)	傳送至另一個佇列、主題或訂用帳戶的訊息數目。

SBQueue

Object

佇列資源的描述。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /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 預設訊息時間範圍到即時值。這是訊息到期的持續時間，從訊息傳送至服務總線時開始。這是當 TimeToLive 未在訊息本身上設定時所使用的預設值。
properties.duplicateDetectionHistoryTimeWindow	string (duration)	定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。預設值為 10 分鐘。
properties.enableBatchedOperations	boolean	值，指出是否啟用伺服器端批次作業。
properties.enableExpress	boolean	值，指出是否啟用 Express Entities。快速佇列會在將訊息寫入永續性記憶體之前，暫時將訊息儲存在記憶體中。
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)	佇列的大小上限，以 MB 為單位，這是為佇列配置的記憶體大小。預設值為 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

與建立和上次修改資源相關的元數據。

名稱	類型	Description
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

其他資源