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 サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	SBQueue	キューの説明が正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する ServiceBus エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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	リソースを作成した ID の種類。
EntityStatus	エンティティの状態。
Error	エラーオブジェクト。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	リソース管理エラー応答。
MessageCountDetails	メッセージ数の詳細。
SBQueue	キューリソースの説明。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
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	リソースの完全修飾リソース 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)	キューの最大サイズ (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

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースを最後に変更した ID の種類。
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Queues - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

QueueGet

要求のサンプル

応答のサンプル

定義

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

その他のリソース