ServiceBusAdministrationClient.GetQueueAsync メソッド

定義

サービス名前空間からキューを取得します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>> GetQueueAsync (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member GetQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>>
override this.GetQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>>
Public Overridable Function GetQueueAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueProperties))

パラメーター

name
String

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

cancellationToken
CancellationToken

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

戻り値

QueueProperties キューに関する情報を格納しています。

例外

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

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

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

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

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

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

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

  • 指定したエンティティが見つかりませんでした。 Reasonこの場合、 は にMessagingEntityNotFound設定されます。
  • 操作がタイムアウトしました。 Reason この場合、 は に ServiceTimeout 設定されます。
  • サーバーがビジーです。 操作を再試行する前に、待つ必要があります。 この場合、エラーの理由は に ServiceBusy 設定されます。
  • 内部エラーまたは予期しない例外が発生します。 この場合、エラーの理由は に GeneralError 設定されます。

適用対象