ServiceBusAdministrationClient.GetSubscriptionAsync メソッド

定義

名前空間:

Azure.Messaging.ServiceBus.Administration

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

ソース:

ServiceBusAdministrationClient.cs

サービス名前空間からサブスクリプションを取得します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.SubscriptionProperties>> GetSubscriptionAsync (string topicName, string subscriptionName, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetSubscriptionAsync (topicName As String, subscriptionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SubscriptionProperties))

パラメーター

topicName

String

Service Bus 名前空間に対する相対トピックの名前。

subscriptionName

String

サブスクリプション名。

cancellationToken

CancellationToken

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

戻り値

Task<Response<SubscriptionProperties>>

SubscriptionProperties サブスクリプションに関する情報を含みます。

例外

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

ServiceBusException

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