QueueClient クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
キュー クライアント オブジェクトを表します。
public abstract class QueueClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient
type QueueClient = class
inherit MessagingEntityClient
Public MustInherit Class QueueClient
Inherits MessagingEntityClient
- 継承
プロパティ
IsClosed |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
MessagingFactory |
メッセージング ファクトリを取得または設定します。 |
Mode |
受信したメッセージを処理するときのメッセージ受信モードを取得します。 |
Path |
ベース アドレスに対するキュー、トピック、またはサブスクリプションのパスを MessagingFactory 取得します。 (継承元 MessagingEntityClient) |
PrefetchCount |
キュー レシーバーが同時に要求できるメッセージの数を取得または設定します。 |
RetryPolicy |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
ThisLock |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
メソッド
Abandon(Guid) |
メッセージを破棄し、メッセージ ロックの所有権を放棄します。 |
Abandon(Guid, IDictionary<String,Object>) |
メッセージを破棄し、メッセージ ロックの所有権を放棄します。 |
AbandonAsync(Guid) |
メッセージを非同期的に破棄し、メッセージ ロックの所有権を放棄します。 |
AbandonAsync(Guid, IDictionary<String,Object>) |
メッセージを非同期的に破棄し、メッセージ ロックの所有権を放棄します。 |
Abort() |
メッセージング エンティティに対して中止機能を実行します。 (継承元 ClientEntity) |
AcceptMessageSession() |
1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(Boolean) |
排他モードかどうかに関係なく、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(Boolean, TimeSpan) |
排他モードかどうかに関係なく、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(String) |
指定されたセッション識別子を使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(String, Boolean) |
排他モードかどうかを指定して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(String, Boolean, TimeSpan) |
特定のセッション識別子を排他モードにするかどうかを指定して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(String, Guid) |
特定のセッション識別子とセッション ロック トークンを使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にする、排他ではないロックされたセッションを受け入れます。 |
AcceptMessageSession(String, Guid, TimeSpan) |
特定のセッション識別子とセッション ロック トークンを使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にする、排他ではないロックされたセッションを受け入れます。 |
AcceptMessageSession(String, TimeSpan) |
特定のセッション識別子と待機時間を使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSession(TimeSpan) |
指定したサーバー待機時間を使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSessionAsync() |
1 つのトランザクションで処理するための関連メッセージのグループ化を可能にするメッセージ セッションを非同期に受け入れます。 |
AcceptMessageSessionAsync(Boolean) |
排他モードと待機時間のどちらで 1 つのトランザクションで処理するために関連メッセージをグループ化できるようにするメッセージ セッションを非同期的に受け入れます。 |
AcceptMessageSessionAsync(Boolean, TimeSpan) |
排他モードと待機時間のどちらで 1 つのトランザクションで処理するために関連メッセージをグループ化できるようにするメッセージ セッションを非同期的に受け入れます。 |
AcceptMessageSessionAsync(String) |
指定されたセッション識別子を使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にするメッセージ セッションを非同期に受け入れます。 |
AcceptMessageSessionAsync(String, Boolean) |
特定のセッション識別子を排他モードにするかどうかを指定して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSessionAsync(String, Boolean, TimeSpan) |
特定のセッション識別子を排他モードにするかどうかを指定して、1 つのトランザクションで処理するための関連メッセージのグループ化を許可するメッセージ セッションを受け入れます。 |
AcceptMessageSessionAsync(String, Guid) |
特定のセッション識別子とセッション ロック トークンを使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にする、排他ではないロックされたセッションを受け入れます。 |
AcceptMessageSessionAsync(String, Guid, TimeSpan) |
特定のセッション識別子とセッション ロック トークンを使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にする、排他ではないロックされたセッションを受け入れます。 |
AcceptMessageSessionAsync(String, TimeSpan) |
指定されたセッション識別子と待機時間を使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にするメッセージ セッションを非同期に受け入れます。 |
AcceptMessageSessionAsync(TimeSpan) |
指定したサーバー待機時間を使用して、1 つのトランザクションで処理するための関連メッセージのグループ化を可能にするメッセージ セッションを非同期に受け入れます。 |
CancelScheduledMessageAsync(Int64) |
スケジュールされたメッセージを取り消します |
Close() |
クリーンアップ メッセージを Service Bus に送信して、エンティティの使用の完了を通知します。 (継承元 ClientEntity) |
CloseAsync() |
クリーンアップ メッセージを Service Bus に非同期的に送信して、エンティティの使用の完了を通知します。 (継承元 ClientEntity) |
Complete(Guid) |
メッセージの処理を完了します。 |
CompleteAsync(Guid) |
メッセージの処理を非同期に完了します。 |
CompleteBatch(IEnumerable<Guid>) |
メッセージ バッチの処理を完了します。 |
CompleteBatchAsync(IEnumerable<Guid>) |
メッセージ バッチの処理を非同期に完了します。 |
Create(String) |
指定したパスを使用して の QueueClient 新しいコピーを作成します。 |
Create(String, ReceiveMode) |
指定したパスとモードで の QueueClient 新しいコピーを作成します。 |
CreateFromConnectionString(String) |
指定した接続文字列を使用して の QueueClient 新しいインスタンスを作成します。 |
CreateFromConnectionString(String, ReceiveMode) |
指定した接続文字列と受信モードを使用して の新しいインスタンス QueueClient を作成します。 |
CreateFromConnectionString(String, String) |
指定したキュー パスを持つ接続文字列から の QueueClient 新しいコピーを作成します。 このオーバーロードは、接続文字列で プロパティが使用されていない場合にのみ使用 EntityPath します。 |
CreateFromConnectionString(String, String, ReceiveMode) |
指定したパスとモードを使用して、接続文字列から の新しいインスタンス QueueClient を作成します。 このオーバーロードは、接続文字列で プロパティが使用されていない場合にのみ使用 EntityPath します。 |
CreateWithAzureActiveDirectory(Uri, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType) |
Azure Active Directory 認証コンテキストを使用して の QueueClient 新しいインスタンスを作成します。 |
CreateWithManagedIdentity(Uri, String, ReceiveMode, Nullable<TimeSpan>, TransportType) |
Azure マネージド ID 認証を使用して の QueueClient 新しいインスタンスを作成します。 |
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) |
指定した配信不能キュー パスから形式名を作成します。 |
FormatTransferDeadLetterPath(String) |
キュー クライアント オブジェクトを表します。 |
GetMessageSessions() |
メッセージ セッションを取得し、キューのセッションを参照できるようにします。 キュー内のアクティブなメッセージを含むセッションのみが返されます。 配信不能キュー上のセッション、または SessionState が "アクティブ" であり、この呼び出しでメッセージが返されないセッション。 |
GetMessageSessions(DateTime) |
以降 |
GetMessageSessionsAsync() |
メッセージ セッションを非同期的に取得し、キュー上のセッションを参照できるようにします。 キュー内のアクティブなメッセージを含むセッションのみが返されます。 配信不能キュー上のセッション、または SessionState が "アクティブ" であり、この呼び出しでメッセージが返されないセッション。 |
GetMessageSessionsAsync(DateTime) |
以降 |
OnAbort() |
Abort イベントの呼び出し時に実行されます。 |
OnBeginAcceptMessageSession(String, ReceiveMode, Int32, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object) |
キュー クライアント オブジェクトを表します。 |
OnBeginClose(TimeSpan, AsyncCallback, Object) |
Close 操作が呼び出されたときに実行されます。 |
OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object) |
レシーバーの作成開始アクションを実行します。 |
OnBeginCreateReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object) |
レシーバーの作成開始アクションを実行します。 |
OnBeginCreateSender(TimeSpan, AsyncCallback, Object) |
送信者の作成開始アクションを実行します。 |
OnBeginGetMessageSessions(DateTime, AsyncCallback, Object) |
BeginGetMessageSessions アクションを実行します。 |
OnBeginOpen(TimeSpan, AsyncCallback, Object) |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
OnClose(TimeSpan) |
Close アクションの呼び出し時に実行されます。 |
OnClosed() |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
OnEndAcceptMessageSession(IAsyncResult) |
EndAcceptMessageSession 操作の呼び出し時に実行されます。 |
OnEndClose(IAsyncResult) |
終了終了アクションを実行します。 |
OnEndCreateReceiver(IAsyncResult) |
end create receiver アクションを実行します。 |
OnEndCreateSender(IAsyncResult) |
end create sender アクションを実行します。 |
OnEndGetMessageSessions(IAsyncResult) |
メッセージの最後の取得アクションを実行します。 |
OnEndOpen(IAsyncResult) |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
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.QueueClient.InternalReceiver。 |
Receive(Int64) |
を使用して遅延メッセージを受信します Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver。 このメソッドは、通常のメッセージではなく、遅延メッセージに対してのみ機能します。 |
Receive(TimeSpan) |
を使用してメッセージを受信します Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver。 |
ReceiveAsync() |
を使用してメッセージを非同期に受信します Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver。 |
ReceiveAsync(Int64) |
を使用して遅延メッセージを非同期的に受信します Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver。 このメソッドは、通常のメッセージではなく、遅延メッセージに対してのみ機能します。 |
ReceiveAsync(TimeSpan) |
を使用してメッセージを非同期的に受信します Microsoft.ServiceBus.Messaging.QueueClient.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) |
メッセージ セッション ハンドラー ファクトリを非同期に登録します。 |
RenewMessageLock(Guid) |
キュー クライアント オブジェクトを表します。 |
RenewMessageLockAsync(Guid) |
キュー クライアント オブジェクトを表します。 |
ScheduleMessageAsync(BrokeredMessage, DateTimeOffset) |
スケジュールされたメッセージを送信する |
Send(BrokeredMessage) |
を使用してメッセージを送信します Microsoft.ServiceBus.Messaging.QueueClient.InternalSender。 |
SendAsync(BrokeredMessage) |
を使用してメッセージを非同期的に送信します Microsoft.ServiceBus.Messaging.QueueClient.InternalSender。 |
SendBatch(IEnumerable<BrokeredMessage>) |
一連のブローカー メッセージを送信します (バッチ処理用)。 |
SendBatchAsync(IEnumerable<BrokeredMessage>) |
一連のブローカー メッセージを非同期的に送信します (バッチ処理用)。 |
ThrowIfClosed() |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
ThrowIfDisposed() |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
ThrowIfDisposedOrImmutable() |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
ThrowIfDisposedOrNotOpen() |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
ThrowIfFaulted() |
キュー クライアント オブジェクトを表します。 (継承元 ClientEntity) |
適用対象
Azure SDK for .NET