ServiceBusAdministrationClient.GetSubscriptionsRuntimePropertiesAsync メソッド

定義

名前空間に存在するサブスクリプションのランタイム プロパティの一覧を取得します。

public virtual Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.SubscriptionRuntimeProperties> GetSubscriptionsRuntimePropertiesAsync (string topicName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSubscriptionsRuntimePropertiesAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.SubscriptionRuntimeProperties>
override this.GetSubscriptionsRuntimePropertiesAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Messaging.ServiceBus.Administration.SubscriptionRuntimeProperties>
Public Overridable Function GetSubscriptionsRuntimePropertiesAsync (topicName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SubscriptionRuntimeProperties)

パラメーター

topicName
String

Service Bus 名前空間を基準としたトピックの名前。

cancellationToken
CancellationToken

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

戻り値

AsyncPageable<T>サブスクリプションのランタイム プロパティを記述する 。

例外

操作がタイムアウトします。タイムアウト期間は、 クラスを 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 設定されます。

注釈

使用できる最大値は、1 ページあたり 100 です。

適用対象