ManagementClient.GetSubscriptionsAsync メソッド

定義

名前空間:

Microsoft.Azure.ServiceBus.Management

アセンブリ:

Microsoft.Azure.ServiceBus.dll

パッケージ:

Microsoft.Azure.ServiceBus v5.2.0

ソース:

ManagementClient.cs

トピックに存在するサブスクリプションの一覧を取得します。

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription>> GetSubscriptionsAsync (string topicPath, int count = 100, int skip = 0, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSubscriptionsAsync : string * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription>>
override this.GetSubscriptionsAsync : string * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Management.SubscriptionDescription>>

Public Overridable Function GetSubscriptionsAsync (topicPath As String, Optional count As Integer = 100, Optional skip As Integer = 0, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of SubscriptionDescription))

パラメーター

topicPath

String

すべてのサブスクリプションを取得する必要があるトピック パス。

count

Int32

フェッチするサブスクリプションの数。 既定値は 100 です。 使用できる最大値は 100 です。

skip

Int32

スキップするサブスクリプションの数。 既定値は 0 です。 負の値にすることはできません。

cancellationToken

CancellationToken

戻り値

Task<IList<SubscriptionDescription>>

IList<T> サブスクリプションの一覧を含む。

例外

ArgumentOutOfRangeException

パラメーターが範囲外の場合。

ServiceBusTimeoutException

操作がタイムアウトします。タイムアウト期間は、 クラスを ServiceBusConnection 介して初期化されます。 タイムアウト値が比較的小さい場合は、この例外を回避するために、タイムアウトの値を増やす必要がある場合があります。

UnauthorizedAccessException

この操作を実行するための十分なアクセス許可がありません。 チェックして、この操作をManagementClient実行するための正しいTokenProvider資格情報があることを確認する必要があります。

ServerBusyException

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

ServiceBusException

内部エラーまたは予期しない例外が発生しました。

注釈

と skipを操作することで、エンティティの一覧のページをcountシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。