QueueClient クラス

  • リファレンス

定義

名前空間:
Azure.Storage.Queues
アセンブリ:
Azure.Storage.Queues.dll
パッケージ:
Azure.Storage.Queues v12.17.1
パッケージ:
Azure.Storage.Queues v12.18.0-beta.2
ソース:
QueueClient.cs
ソース:
QueueClient.cs

QueueClient は、キューを操作できる Azure Storage Queue サービスへの URI を表します。

public class QueueClient
type QueueClient = class
Public Class QueueClient
継承
Object
QueueClient

コンストラクター

QueueClient()

モック作成のために クラスの QueueClient 新しいインスタンスを初期化します。
QueueClient(String, String)

QueueClient クラスの新しいインスタンスを初期化します。
QueueClient(String, String, QueueClientOptions)

QueueClient クラスの新しいインスタンスを初期化します。
QueueClient(Uri, AzureSasCredential, QueueClientOptions)

QueueClient クラスの新しいインスタンスを初期化します。
QueueClient(Uri, QueueClientOptions)

QueueClient クラスの新しいインスタンスを初期化します。
QueueClient(Uri, StorageSharedKeyCredential, QueueClientOptions)

QueueClient クラスの新しいインスタンスを初期化します。
QueueClient(Uri, TokenCredential, QueueClientOptions)

QueueClient クラスの新しいインスタンスを初期化します。

プロパティ

AccountName

キュー クライアントに対応するストレージ アカウント名を取得します。
CanGenerateSasUri

クライアントが SAS を生成できるかどうかを判断します。 クライアントが で認証されている場合。StorageSharedKeyCredential
MaxPeekableMessages

QueueMaxMessagesPeek は、Peek の呼び出しごとに取得できるメッセージの最大数を示します。
MessageMaxBytes

メッセージの UTF-8 テキストに許容される最大バイト数を取得します。
MessagesUri

オブジェクトのメッセージで使用される Uri エンドポイントを取得します。
Name

キューの名前を取得します。
Uri

オブジェクトによって使用される Uri エンドポイントを取得します。

メソッド

ClearMessages(CancellationToken)

キューからすべてのメッセージを削除します。

詳細については、「 メッセージをクリアします。
ClearMessagesAsync(CancellationToken)

キューからすべてのメッセージを削除します。

詳細については、「 メッセージをクリアします。
Create(IDictionary<String,String>, CancellationToken)

キューを作成します。

詳細については、「 キューを作成します。
CreateAsync(IDictionary<String,String>, CancellationToken)

キューを作成します。

詳細については、「 キューを作成します。
CreateIfNotExists(IDictionary<String,String>, CancellationToken)

操作により CreateIfNotExists(IDictionary<String,String>, CancellationToken) 、指定したアカウントの下に新しいキューが作成されます。 キューが既に存在する場合、変更されません。

詳細については、「 キューを作成します。
CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken)

操作により CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) 、指定したアカウントの下に新しいキューが作成されます。 キューが既に存在する場合、変更されません。

詳細については、「 キューを作成します。
Delete(CancellationToken)

キューを削除します。

詳細については、「 キューの削除。
DeleteAsync(CancellationToken)

キューを削除します。

詳細については、「 キューの削除。
DeleteIfExists(CancellationToken)

指定 DeleteIfExists(CancellationToken) したキューが存在する場合、操作によって削除されます。

詳細については、「 キューの削除。
DeleteIfExistsAsync(CancellationToken)

指定 DeleteIfExistsAsync(CancellationToken) したキューが存在する場合、操作によって削除されます。

詳細については、「 キューの削除。
DeleteMessage(String, String, CancellationToken)

指定したメッセージをキューから完全に削除します。

詳細については、「 メッセージの削除。
DeleteMessageAsync(String, String, CancellationToken)

指定したメッセージをキューから完全に削除します。

詳細については、「 メッセージの削除。
Exists(CancellationToken)

操作を Exists(CancellationToken) で QueueClient 呼び出して、関連付けられているキューがストレージ サービス内のストレージ アカウントに存在するかどうかを確認できます。
ExistsAsync(CancellationToken)

操作を ExistsAsync(CancellationToken) で QueueClient 呼び出して、関連付けられているキューがストレージ サービス内のストレージ アカウントに存在するかどうかを確認できます。
GenerateSasUri(QueueSasBuilder)

は GenerateSasUri(QueueSasBuilder) 、 Uri 渡されたクライアントのプロパティとビルダーに基づいてキュー サービス SAS URI を生成する を返します。

詳細については、「 サービス SAS の構築
GenerateSasUri(QueueSasPermissions, DateTimeOffset)

は GenerateSasUri(QueueSasPermissions, DateTimeOffset) 、 Uri 渡されたクライアントのプロパティとパラメーターに基づいてキュー サービス Shared Access Signature (SAS) URI を生成する を返します。

詳細については、「 サービス SAS の構築。
GetAccessPolicy(CancellationToken)

Shared Access Signature で使用できるキューで指定された格納されているアクセス ポリシーの詳細を返します。

詳細については、「 キュー ACL を取得します。
GetAccessPolicyAsync(CancellationToken)

Shared Access Signature で使用できるキューで指定された格納されているアクセス ポリシーの詳細を返します。

詳細については、「 キュー ACL を取得します。
GetParentQueueServiceClientCore()

このQueueClientキュー サービスを指す新しい QueueServiceClient を作成します。 新しい QueueServiceClient では、 と同じ要求ポリシー パイプラインが使用されます QueueClient。
GetProperties(CancellationToken)

指定したキューのキュー のプロパティとユーザー定義のメタデータとプロパティを取得します。 メタデータは、名前と値のペアとしてキューに関連付けられています。

詳細については、「 キュー メタデータを取得します。
GetPropertiesAsync(CancellationToken)

指定したキューのキュー のプロパティとユーザー定義のメタデータとプロパティを取得します。 メタデータは、名前と値のペアとしてキューに関連付けられています。

詳細については、「 キュー メタデータを取得します。
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)

イベントを MessageDecodingFailed 発生させます。
PeekMessage(CancellationToken)

キューの先頭から 1 つのメッセージを取得しますが、メッセージの可視性は変更しません。

詳細については、「 [メッセージのピーク] を選択します。
PeekMessageAsync(CancellationToken)

キューの先頭から 1 つのメッセージを取得しますが、メッセージの可視性は変更しません。

詳細については、「 [メッセージのピーク] を選択します。
PeekMessages(Nullable<Int32>, CancellationToken)

キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。

詳細については、「 [メッセージのピーク] を選択します。
PeekMessagesAsync(Nullable<Int32>, CancellationToken)

キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。

詳細については、「 [メッセージのピーク] を選択します。
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)

キューの先頭から 1 つのメッセージを受信します。

詳細については、「 メッセージを取得します。
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)

キューの先頭から 1 つのメッセージを取得します。

詳細については、「 メッセージを取得します。
ReceiveMessages()

キューの先頭から 1 つ以上のメッセージを受信します。

詳細については、「 メッセージを取得します。
ReceiveMessages(CancellationToken)

キューの先頭から 1 つ以上のメッセージを受信します。

詳細については、「 メッセージを取得します。
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)

キューの先頭から 1 つ以上のメッセージを受信します。

詳細については、「 メッセージを取得します。
ReceiveMessagesAsync()

キューの先頭から 1 つ以上のメッセージを取得します。

詳細については、「 メッセージを取得します。
ReceiveMessagesAsync(CancellationToken)

キューの先頭から 1 つ以上のメッセージを取得します。

詳細については、「 メッセージを取得します。
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)

キューの先頭から 1 つ以上のメッセージを取得します。

詳細については、「 メッセージを取得します。
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

キューの背面に新しいメッセージを追加します。 表示タイムアウトは、メッセージが Dequeue 操作と Peek 操作に対して非表示にする必要がある期間を指定します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessage(String)

キューの背面に新しいメッセージを追加します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessage(String, CancellationToken)

キューの背面に新しいメッセージを追加します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessage(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

キューの背面に新しいメッセージを追加します。 表示タイムアウトは、メッセージが Dequeue 操作と Peek 操作に対して非表示にする必要がある期間を指定します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

キューの背面に新しいメッセージを追加します。 表示タイムアウトは、メッセージが Dequeue 操作と Peek 操作に対して非表示にする必要がある期間を指定します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessageAsync(String)

キューの背面に新しいメッセージを追加します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessageAsync(String, CancellationToken)

キューの背面に新しいメッセージを追加します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SendMessageAsync(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)

キューの背面に新しいメッセージを追加します。 表示タイムアウトは、メッセージが Dequeue 操作と Peek 操作に対して非表示にする必要がある期間を指定します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージを配置します。
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)

SetAccessPolicyAsync は、Shared Access Signature で使用できるキューに格納されているアクセス ポリシーを設定します。

詳細については、「 キュー ACL を設定します。
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)

SetAccessPolicyAsync は、Shared Access Signature で使用できるキューに格納されているアクセス ポリシーを設定します。

詳細については、「 キュー ACL を設定します。
SetMetadata(IDictionary<String,String>, CancellationToken)

指定したキューにユーザー定義メタデータを設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。

詳細については、「 キュー メタデータを設定します。
SetMetadataAsync(IDictionary<String,String>, CancellationToken)

指定したキューにユーザー定義メタデータを設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。

詳細については、「 キュー メタデータを設定します。
UpdateMessage(String, String, BinaryData, TimeSpan, CancellationToken)

メッセージの可視性のタイムアウトと内容を変更します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージの更新。
UpdateMessage(String, String, String, TimeSpan, CancellationToken)

メッセージの可視性のタイムアウトと内容を変更します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージの更新。
UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)

メッセージの可視性のタイムアウトと内容を変更します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンでは 8 KiB です。

詳細については、「 メッセージの更新。
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)

メッセージの可視性のタイムアウトと内容を変更します。

メッセージは、UTF-8 エンコードされた XML 要求に含めることができる形式である必要があります。 それ以外の場合 MessageEncoding は、 オプションを に Base64 設定して、準拠していないメッセージを処理できます。 エンコードされたメッセージのサイズは、バージョン 2011-08-18 以降では最大 64 KiB、以前のバージョンの場合は 8 KiB です。

詳細については、「 メッセージを更新します。
WithClientSideEncryptionOptionsCore(ClientSideEncryptionOptions)

クラスの新しいインスタンスを作成し QueueClient 、同じ内部をすべて維持しますが、新しい ClientSideEncryptionOptionsを指定します。

拡張メソッド

GetParentQueueServiceClient(QueueClient)

このQueueClientキュー サービスを指す新しい QueueServiceClient を作成します。 新しい QueueServiceClient では、 と同じ要求ポリシー パイプラインが使用されます QueueClient。
WithClientSideEncryptionOptions(QueueClient, ClientSideEncryptionOptions)

クラスの新しいインスタンスを作成し QueueClient 、同じ内部をすべて維持しますが、新しい ClientSideEncryptionOptionsを指定します。

適用対象