你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

QueueClient 类

定义

命名空间:

Azure.Storage.Queues

程序集:

Azure.Storage.Queues.dll

包:

Azure.Storage.Queues v12.17.1

Source:

QueueClient.cs

QueueClient 表示 Azure 存储队列服务的 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 指示每次调用“速览”时可以检索的最大消息数。
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 根据传递的客户端属性和参数， (SAS) URI 生成队列服务共享访问签名。 有关详细信息，请参阅 构造服务 SAS。
GetAccessPolicy(CancellationToken)	返回有关队列上指定的任何存储访问策略的详细信息，这些策略可与共享访问签名一起使用。 有关详细信息，请参阅 获取队列 ACL。
GetAccessPolicyAsync(CancellationToken)	返回有关队列上指定的任何存储访问策略的详细信息，这些策略可与共享访问签名一起使用。 有关详细信息，请参阅 获取队列 ACL。
GetParentQueueServiceClientCore()	创建一个指向此QueueClient队列服务的新 QueueServiceClient 。 新的 QueueServiceClient 使用与 相同的请求策略管道 QueueClient。
GetProperties(CancellationToken)	检索指定队列上的队列属性和用户定义的元数据和属性。 元数据以名称-值对的形式与队列相关联。 有关详细信息，请参阅 获取队列元数据。
GetPropertiesAsync(CancellationToken)	检索指定队列上的队列属性和用户定义的元数据和属性。 元数据以名称-值对的形式与队列相关联。 有关详细信息，请参阅 获取队列元数据。
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)	引发 MessageDecodingFailed 事件。
PeekMessage(CancellationToken)	从队列前面检索一条消息，但不会更改消息的可见性。 有关详细信息，请参阅 速览消息。
PeekMessageAsync(CancellationToken)	从队列前面检索一条消息，但不会更改消息的可见性。 有关详细信息，请参阅 速览消息。
PeekMessages(Nullable<Int32>, CancellationToken)	从队列前面检索一个或多个消息，但不会更改消息的可见性。 有关详细信息，请参阅 速览消息。
PeekMessagesAsync(Nullable<Int32>, CancellationToken)	从队列前面检索一个或多个消息，但不会更改消息的可见性。 有关详细信息，请参阅 速览消息。
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)	从队列前面接收一条消息。 有关详细信息，请参阅 获取消息。
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	从队列前面检索一条消息。 有关详细信息，请参阅 获取消息。
ReceiveMessages()	从队列前面接收一个或多个消息。 有关详细信息，请参阅 获取消息。
ReceiveMessages(CancellationToken)	从队列的前面接收一个或多个消息。 有关详细信息，请参阅 获取消息。
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	从队列的前面接收一个或多个消息。 有关详细信息，请参阅 获取消息。
ReceiveMessagesAsync()	从队列的前面检索一个或多个消息。 有关详细信息，请参阅 获取消息。
ReceiveMessagesAsync(CancellationToken)	从队列的前面检索一个或多个消息。 有关详细信息，请参阅 获取消息。
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	从队列的前面检索一个或多个消息。 有关详细信息，请参阅 获取消息。
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	将新消息添加到队列的后面。 可见性超时指定消息对取消排队和 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)	将新消息添加到队列的后面。 可见性超时指定消息对取消排队和 Peek 操作不可见的时间长度。 消息必须采用某种格式，以便可以包含在具有 UTF-8 编码的 XML 请求中。 否则 MessageEncoding ，可以将 选项设置为 Base64 以处理不合规的消息。 对于版本 2011-08-18 及更新版本，编码的消息大小最大为 64 KiB，对于以前版本，其大小为 8 KiB。 有关详细信息，请参阅 放置消息。
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	将新消息添加到队列的后面。 可见性超时指定消息对取消排队和 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)	将新消息添加到队列的后面。 可见性超时指定消息对取消排队和 Peek 操作不可见的时间长度。 消息必须采用某种格式，以便可以包含在具有 UTF-8 编码的 XML 请求中。 否则 MessageEncoding ，可以将 选项设置为 Base64 以处理不合规的消息。 对于版本 2011-08-18 及更新版本，编码的消息大小最大为 64 KiB，对于以前版本，其大小为 8 KiB。 有关详细信息，请参阅 放置消息。
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync 为可能与共享访问签名一起使用的队列设置存储访问策略。 有关详细信息，请参阅 设置队列 ACL。
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync 为可能与共享访问签名一起使用的队列设置存储访问策略。 有关详细信息，请参阅 设置队列 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。