SubscriptionClient クラス

定義

名前空間:

Microsoft.ServiceBus.Messaging

アセンブリ:

Microsoft.ServiceBus.dll

パッケージ:

WindowsAzure.ServiceBus v6.2.2

トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。

public abstract class SubscriptionClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient

type SubscriptionClient = class
    inherit MessagingEntityClient

Public MustInherit Class SubscriptionClient
Inherits MessagingEntityClient

継承

Object

ClientEntity

MessagingEntityClient

SubscriptionClient

例

// Create subscription client
SubscriptionClient mySubscriptionClient = 
factory.CreateSubscriptionClient(mySubscription);

// Receive messages
for (int count = 0; count < MsgCount; count++)
{
    var message = mySubscriptionClient.Receive();
    message.Complete();
}

プロパティ

IsClosed	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
MessagingFactory	このサブスクリプション クライアントの作成に使用されるメッセージング ファクトリを取得します。
Mode	受信したメッセージを処理するときのメッセージ受信モードを取得します。
Name	サブスクリプションの名前を取得します。
Path	ベース アドレスに対するキュー、トピック、またはサブスクリプションのパスを MessagingFactory 取得します。 (継承元 MessagingEntityClient)
PrefetchCount	メッセージの受信者が同時に要求できるメッセージ数を取得または設定します。
RetryPolicy	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
ThisLock	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
TopicPath	トピックの完全なパス名を取得します。

メソッド

Abandon(Guid)	メッセージを破棄し、メッセージ ロックの所有権を放棄します。
Abandon(Guid, IDictionary<String,Object>)	メッセージを破棄し、メッセージ ロックの所有権を放棄します。
AbandonAsync(Guid)	メッセージを非同期的に破棄し、メッセージ ロックの所有権を放棄します。
AbandonAsync(Guid, IDictionary<String,Object>)	メッセージを非同期的に破棄し、メッセージ ロックの所有権を放棄します。
Abort()	メッセージング エンティティに対して中止機能を実行します。 (継承元 ClientEntity)
AcceptMessageSession()	1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを受け入れます。
AcceptMessageSession(Boolean)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSession(Boolean, TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSession(String)	指定されたセッション識別子を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを受け入れます。
AcceptMessageSession(String, Boolean)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSession(String, Boolean, TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSession(String, Guid)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSession(String, Guid, TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSession(String, TimeSpan)	指定されたセッション識別子と待機時間を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを受け入れます。
AcceptMessageSession(TimeSpan)	指定したサーバー待機時間を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを受け入れます。
AcceptMessageSessionAsync()	指定したサーバー待機時間を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを非同期で受け入れます。
AcceptMessageSessionAsync(Boolean)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSessionAsync(Boolean, TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSessionAsync(String)	指定したサーバー待機時間を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを非同期で受け入れます。
AcceptMessageSessionAsync(String, Boolean)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSessionAsync(String, Boolean, TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSessionAsync(String, Guid)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSessionAsync(String, Guid, TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
AcceptMessageSessionAsync(String, TimeSpan)	指定したサーバー待機時間を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを非同期で受け入れます。
AcceptMessageSessionAsync(TimeSpan)	指定したサーバー待機時間を使用して、1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを非同期で受け入れます。
AddRule(RuleDescription)	指定した規則の説明を使用して、 SubscriptionDescription に新しい規則を追加します。
AddRule(String, Filter)	指定した名前とフィルター式を使用して、現在のサブスクリプションにルールを追加します。
AddRuleAsync(RuleDescription)	指定した規則の説明を使用して、 SubscriptionDescription に新しい規則を非同期的に追加します。
AddRuleAsync(String, Filter)	指定した名前とフィルター式を使用して、現在のサブスクリプションにルールを非同期的に追加します。
Close()	エンティティの使用の完了を通知するクリーンアップ メッセージを Service Bus に送信します。 (継承元 ClientEntity)
CloseAsync()	クリーンアップ メッセージを Service Bus に非同期的に送信して、エンティティの使用の完了を通知します。 (継承元 ClientEntity)
Complete(Guid)	メッセージの処理を完了します。
CompleteAsync(Guid)	メッセージの処理を非同期的に完了します。
CompleteBatch(IEnumerable<Guid>)	バッチの処理を完了します。
CompleteBatchAsync(IEnumerable<Guid>)	バッチの処理を非同期的に完了します。
Create(String, String)	指定した名前とトピック パスを使用して、 の SubscriptionClient 新しいコピーを作成します。
Create(String, String, ReceiveMode)	指定した名前、トピック パス、およびモードを使用して、 の SubscriptionClient 新しいコピーを作成します。
CreateFromConnectionString(String, String, String)	指定したトピック パスと名前を持つ接続文字列から の SubscriptionClient 新しいコピーを作成します。
CreateFromConnectionString(String, String, String, ReceiveMode)	指定したトピック パス、名前、モードを使用して、接続文字列から の SubscriptionClient 新しいコピーを作成します。
CreateWithAzureActiveDirectory(Uri, String, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType)	認証コールバック を使用して、 の SubscriptionClient 新しいインスタンスを作成します。
CreateWithManagedIdentity(Uri, String, String, ReceiveMode, Nullable<TimeSpan>, TransportType)	Azure マネージド ID 認証を使用して、 SubscriptionClient の新しいインスタンスを作成します。
DeadLetter(Guid)	配信不能メッセージを配信不能キューに移動します。
DeadLetter(Guid, IDictionary<String,Object>)	配信不能メッセージを配信不能キューに移動します。
DeadLetter(Guid, String, String)	配信不能メッセージを配信不能キューに移動します。
DeadLetterAsync(Guid)	配信不能メッセージを配信不能キューに非同期的に移動します。
DeadLetterAsync(Guid, IDictionary<String,Object>)	配信不能メッセージを配信不能キューに非同期的に移動します。
DeadLetterAsync(Guid, String, String)	配信不能メッセージを配信不能キューに非同期的に移動します。
Defer(Guid)	メッセージの処理を中断します。
Defer(Guid, IDictionary<String,Object>)	メッセージの処理を中断します。
DeferAsync(Guid)	メッセージの処理を非同期的に中断します。
DeferAsync(Guid, IDictionary<String,Object>)	メッセージの処理を非同期的に中断します。
Fault()	内部使用専用です。 このクラスから継承しないでください。 (継承元 ClientEntity)
FormatDeadLetterPath(String, String)	指定したトピック パスとサブスクリプション名を使用して、形式名の配信不能パスを作成します。
FormatSubscriptionPath(String, String)	指定したトピック パスとサブスクリプション名を使用して、形式名のサブスクリプション パスを作成します。
GetMessageSessions()	1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを取得します。
GetMessageSessions(DateTime)	以降 lastUpdatedTimeにセッション状態が更新されたすべてのメッセージ セッションを取得します。
GetMessageSessionsAsync()	1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを非同期的に取得します。
GetMessageSessionsAsync(DateTime)	1 つのトランザクションで処理するために関連メッセージをグループ化できるメッセージ セッションを非同期的に取得します。
OnAbort()	中止アクションを実行します。
OnBeginAcceptMessageSession(String, ReceiveMode, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object)	BeginAcceptMessageSession 操作の呼び出し時に実行されます。
OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)	BeginAddRule 操作を呼び出すと実行されます。
OnBeginClose(TimeSpan, AsyncCallback, Object)	終了開始アクションを実行します。
OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)	レシーバーの作成開始アクションを実行します。
OnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)	レシーバーの作成開始アクションを実行します。
OnBeginGetMessageSessions(DateTime, AsyncCallback, Object)	BeginGetMessageSessions 操作を呼び出すと実行されます。
OnBeginGetRules(Int32, Int32, TimeSpan, AsyncCallback, Object)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
OnBeginOpen(TimeSpan, AsyncCallback, Object)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)	ランタイム クライアント プロトコルを使用して、 から SubscriptionDescription をRuleDescription削除します。
OnBeginRemoveRulesByTag(String, TimeSpan, AsyncCallback, Object)	タグを使用して、ランタイム クライアント プロトコルを介して から SubscriptionDescription を削除RuleDescriptionします。
OnClose(TimeSpan)	閉じるアクションを実行します。
OnClosed()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
OnEndAcceptMessageSession(IAsyncResult)	EndAcceptMessageSession 操作を呼び出すと実行されます。
OnEndAddRule(IAsyncResult)	への非同期呼び出しを OnBeginAddRule(RuleDescription, TimeSpan, AsyncCallback, Object)終了します。
OnEndClose(IAsyncResult)	終了終了アクションを実行します。
OnEndCreateReceiver(IAsyncResult)	受信側の作成の終了アクションを実行します。
OnEndGetMessageSessions(IAsyncResult)	メッセージの取得の終了アクションを実行します。
OnEndGetRules(IAsyncResult)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
OnEndOpen(IAsyncResult)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
OnEndRemoveRule(IAsyncResult)	への非同期呼び出しを OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)終了します。
OnEndRemoveRules(IAsyncResult)	への非同期呼び出しを OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object)終了します。
OnFaulted()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
OnMessage(Action<BrokeredMessage>)	イベント ドリブン メッセージ ポンプでメッセージを処理します。
OnMessage(Action<BrokeredMessage>, OnMessageOptions)	特定のオプション セット OnMessageOptions を使用して、イベント ドリブン メッセージ ポンプでメッセージを処理します。
OnMessageAsync(Func<BrokeredMessage,Task>)	メッセージを非同期的に処理します。
OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)	メッセージを非同期的に処理します。
OnOpen(TimeSpan)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
OnOpened()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
Peek()	キュー内の最初のメッセージを削除せずに を返します。
Peek(Int64)	キュー内の最初のメッセージを削除せずに を返します。
PeekAsync()	キュー内の最初のメッセージを削除せずに非同期的に を返します。
PeekAsync(Int64)	キュー内の最初のメッセージを削除せずに非同期的に を返します。
PeekBatch(Int32)	バッチ内の最初のメッセージを削除せずに を返します。
PeekBatch(Int64, Int32)	バッチ内の最初のメッセージを削除せずに を返します。
PeekBatchAsync(Int32)	バッチ内の最初のメッセージを削除せずに非同期的に を返します。
PeekBatchAsync(Int64, Int32)	バッチ内の最初のメッセージを削除せずに非同期的に を返します。
Receive()	を使用してメッセージを受信します Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver。
Receive(Int64)	を使用して遅延メッセージを受信します Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver。 このメソッドは、通常のメッセージではなく、遅延メッセージに対してのみ機能します。
Receive(TimeSpan)	を使用してメッセージを受信します Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver。
ReceiveAsync()	を使用してメッセージを非同期的に受信します Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver。
ReceiveAsync(Int64)	を使用してメッセージを非同期的に受信します Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver。 このメソッドは、通常のメッセージではなく、遅延メッセージに対してのみ機能します。
ReceiveAsync(TimeSpan)	を使用してメッセージを非同期的に受信します Microsoft.ServiceBus.Messaging.SubscriptionClient.InternalReceiver。
ReceiveBatch(IEnumerable<Int64>)	非同期操作の後にバッチを受信します。
ReceiveBatch(Int32)	非同期操作の後にバッチを受信します。
ReceiveBatch(Int32, TimeSpan)	非同期操作の後にバッチを受信します。
ReceiveBatchAsync(IEnumerable<Int64>)	一連のメッセージを非同期的に受信します (バッチ処理用)。
ReceiveBatchAsync(Int32)	一連のメッセージを非同期的に受信します (バッチ処理用)。
ReceiveBatchAsync(Int32, TimeSpan)	一連のメッセージを非同期的に受信します (バッチ処理用)。
RegisterSessionHandler(Type)	クライアント セッションのハンドラーを登録します。
RegisterSessionHandler(Type, SessionHandlerOptions)	クライアント セッションのハンドラーを登録します。
RegisterSessionHandlerAsync(Type)	クライアント セッションのハンドラーを非同期に登録します。
RegisterSessionHandlerAsync(Type, SessionHandlerOptions)	クライアント セッションのハンドラーを非同期に登録します。
RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)	クライアント セッションのハンドラー ファクトリを登録します。
RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)	クライアント セッションのハンドラー ファクトリを登録します。
RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)	クライアント セッションのハンドラー ファクトリを非同期に登録します。
RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)	クライアント セッションのハンドラー ファクトリを非同期に登録します。
RemoveRule(String)	によって記述されているルールを ruleName削除します。
RemoveRuleAsync(String)	によって記述されたルールを非同期的に ruleName削除します。
RenewMessageLock(Guid)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
RenewMessageLockAsync(Guid)	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。
ThrowIfClosed()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
ThrowIfDisposed()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
ThrowIfDisposedOrImmutable()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
ThrowIfDisposedOrNotOpen()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)
ThrowIfFaulted()	トピック サブスクリプションに関連する実行時操作で使用されるアンカー クラスを表します。 (継承元 ClientEntity)