ServiceBusAdministrationClient.GetQueueRuntimePropertiesAsync メソッド

リファレンス

定義

名前空間:: Azure.Messaging.ServiceBus.Administration

アセンブリ:: Azure.Messaging.ServiceBus.dll

パッケージ:: Azure.Messaging.ServiceBus v7.17.5

Source:: ServiceBusAdministrationClient.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

キューのランタイムプロパティを取得します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueRuntimeProperties>> GetQueueRuntimePropertiesAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueueRuntimePropertiesAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueRuntimeProperties>>
override this.GetQueueRuntimePropertiesAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueRuntimeProperties>>

Public Overridable Function GetQueueRuntimePropertiesAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueRuntimeProperties))

パラメーター

name: String

Service Bus 名前空間に対する相対的なキューの名前。

cancellationToken: CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。

戻り値

Task<Response<QueueRuntimeProperties>>

QueueRuntimeProperties キューに関するランタイムプロパティを格納しています。

例外

ServiceTimeout

操作がタイムアウトします。タイムアウト期間は、クラスを ServiceBusAdministrationClientOptions 介して初期化されます (「Retry プロパティ」を参照してください)。タイムアウト値が比較的低い場合は、この例外を回避するためにタイムアウトの値を増やす必要がある場合があります。

MessagingEntityNotFound

この名前のキューは存在しません。

ServiceBusy

サーバーがビジーです。操作を再試行する前に、待つ必要があります。

ArgumentNullException

キュー名が null または空です。

ArgumentOutOfRangeException

キュー名が最大許容長を超えています。

ArgumentException

それ以外の場合、キュー名は無効です。

UnauthorizedAccessException

この操作を実行するためのアクセス許可が不十分です。チェックして、この操作をServiceBusAdministrationClient実行するために必要な要求があることを確認する必要があります。 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-sas#rights-required-for-service-bus-operations