QueueClient Clase

Definición

Espacio de nombres:

Azure.Storage.Queues

Ensamblado:

Azure.Storage.Queues.dll

Paquete:

Azure.Storage.Queues v12.17.1

Source:

QueueClient.cs

QueueClient representa un URI para el servicio de cola de Azure Storage que le permite manipular una cola.

public class QueueClient

type QueueClient = class

Public Class QueueClient

Herencia

Object

QueueClient

Constructores

QueueClient()	Inicializa una nueva instancia de la QueueClient clase para simular.
QueueClient(String, String)	Inicializa una nueva instancia de la clase QueueClient.
QueueClient(String, String, QueueClientOptions)	Inicializa una nueva instancia de la clase QueueClient.
QueueClient(Uri, AzureSasCredential, QueueClientOptions)	Inicializa una nueva instancia de la clase QueueClient.
QueueClient(Uri, QueueClientOptions)	Inicializa una nueva instancia de la clase QueueClient.
QueueClient(Uri, StorageSharedKeyCredential, QueueClientOptions)	Inicializa una nueva instancia de la clase QueueClient.
QueueClient(Uri, TokenCredential, QueueClientOptions)	Inicializa una nueva instancia de la clase QueueClient.

Propiedades

AccountName	Obtiene el nombre de la cuenta de almacenamiento correspondiente al cliente de cola.
CanGenerateSasUri	Determina si el cliente puede generar una SAS. Si el cliente se autentica con .StorageSharedKeyCredential
MaxPeekableMessages	QueueMaxMessagesPeek indica el número máximo de mensajes que puede recuperar con cada llamada a Peek.
MessageMaxBytes	Obtiene el número máximo de bytes permitidos para el texto UTF-8 de un mensaje.
MessagesUri	Obtiene el punto de conexión de URI utilizado por los mensajes del objeto.
Name	Obtiene el nombre de la cola.
Uri	Obtiene el punto de conexión de URI utilizado por el objeto .

Métodos

ClearMessages(CancellationToken)	Elimina todos los mensajes de una cola. Para obtener más información, vea Borrar mensajes.
ClearMessagesAsync(CancellationToken)	Elimina todos los mensajes de una cola. Para obtener más información, vea Borrar mensajes.
Create(IDictionary<String,String>, CancellationToken)	Crea una cola. Para obtener más información, vea Crear cola.
CreateAsync(IDictionary<String,String>, CancellationToken)	Crea una cola. Para obtener más información, vea Crear cola.
CreateIfNotExists(IDictionary<String,String>, CancellationToken)	La CreateIfNotExists(IDictionary<String,String>, CancellationToken) operación crea una nueva cola en la cuenta especificada. Si la cola ya existe, no se cambia. Para obtener más información, vea Crear cola.
CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken)	La CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) operación crea una nueva cola en la cuenta especificada. Si la cola ya existe, no se cambia. Para obtener más información, vea Crear cola.
Delete(CancellationToken)	Elimina una cola. Para obtener más información, vea Eliminar cola.
DeleteAsync(CancellationToken)	Elimina una cola. Para obtener más información, vea Eliminar cola.
DeleteIfExists(CancellationToken)	La DeleteIfExists(CancellationToken) operación elimina la cola especificada si existe. Para obtener más información, vea Eliminar cola.
DeleteIfExistsAsync(CancellationToken)	La DeleteIfExistsAsync(CancellationToken) operación elimina la cola especificada si existe. Para obtener más información, vea Eliminar cola.
DeleteMessage(String, String, CancellationToken)	Quita permanentemente el mensaje especificado de su cola. Para obtener más información, vea Eliminar mensaje.
DeleteMessageAsync(String, String, CancellationToken)	Quita permanentemente el mensaje especificado de su cola. Para obtener más información, vea Eliminar mensaje.
Exists(CancellationToken)	Se Exists(CancellationToken) puede llamar a la operación en para QueueClient ver si la cola asociada existe en la cuenta de almacenamiento del servicio de almacenamiento.
ExistsAsync(CancellationToken)	Se ExistsAsync(CancellationToken) puede llamar a la operación en para QueueClient ver si la cola asociada existe en la cuenta de almacenamiento del servicio de almacenamiento.
GenerateSasUri(QueueSasBuilder)	GenerateSasUri(QueueSasBuilder) devuelve un Uri objeto que genera un URI de SAS de Queue Service basado en las propiedades del cliente y el generador pasados. Para obtener más información, vea Construcción de una SAS de servicio
GenerateSasUri(QueueSasPermissions, DateTimeOffset)	GenerateSasUri(QueueSasPermissions, DateTimeOffset) devuelve un Uri que genera un URI de firma de acceso compartido (SAS) de Queue Service basado en las propiedades y parámetros del cliente pasados. Para obtener más información, vea Construcción de una SAS de servicio.
GetAccessPolicy(CancellationToken)	Devuelve detalles sobre las directivas de acceso almacenadas especificadas en la cola que se pueden usar con firmas de acceso compartido. Para obtener más información, vea Obtiene la ACL de cola.
GetAccessPolicyAsync(CancellationToken)	Devuelve detalles sobre las directivas de acceso almacenadas especificadas en la cola que se pueden usar con firmas de acceso compartido. Para obtener más información, vea Obtiene la ACL de cola.
GetParentQueueServiceClientCore()	Cree un nuevo QueueServiceClient que apunte a este QueueClientservicio de cola. El nuevo QueueServiceClient usa la misma canalización de directiva de solicitud que .QueueClient
GetProperties(CancellationToken)	Recupera las propiedades de la cola y los metadatos y propiedades definidos por el usuario en la cola especificada. Los metadatos se asocian con la cola como pares nombre-valor. Para obtener más información, vea Obtener metadatos de cola.
GetPropertiesAsync(CancellationToken)	Recupera las propiedades de la cola y los metadatos y propiedades definidos por el usuario en la cola especificada. Los metadatos se asocian con la cola como pares nombre-valor. Para obtener más información, vea Obtener metadatos de cola.
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)	Provoca el MessageDecodingFailed evento .
PeekMessage(CancellationToken)	Recupera un mensaje de la parte delantera de la cola, pero no modifica la visibilidad del mensaje. Para obtener más información, vea Ver mensajes.
PeekMessageAsync(CancellationToken)	Recupera un mensaje de la parte delantera de la cola, pero no modifica la visibilidad del mensaje. Para obtener más información, vea Ver mensajes.
PeekMessages(Nullable<Int32>, CancellationToken)	Recupera uno o varios mensajes de la parte delantera de la cola, pero no modifica la visibilidad del mensaje. Para obtener más información, vea Ver mensajes.
PeekMessagesAsync(Nullable<Int32>, CancellationToken)	Recupera uno o varios mensajes de la parte delantera de la cola, pero no modifica la visibilidad del mensaje. Para obtener más información, vea Ver mensajes.
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)	Recibe un mensaje de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Recupera un mensaje de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessages()	Recibe uno o varios mensajes de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessages(CancellationToken)	Recibe uno o varios mensajes de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Recibe uno o varios mensajes de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessagesAsync()	Recupera uno o varios mensajes de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessagesAsync(CancellationToken)	Recupera uno o varios mensajes de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Recupera uno o varios mensajes de la parte delantera de la cola. Para obtener más información, vea Obtener mensajes.
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Agrega un nuevo mensaje a la parte posterior de una cola. El tiempo de espera de visibilidad especifica cuánto tiempo debe ser invisible el mensaje para las operaciones Dequeue y Peek. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessage(String)	Agrega un nuevo mensaje a la parte posterior de una cola. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessage(String, CancellationToken)	Agrega un nuevo mensaje a la parte posterior de una cola. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessage(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Agrega un nuevo mensaje a la parte posterior de una cola. El tiempo de espera de visibilidad especifica cuánto tiempo debe ser invisible el mensaje para las operaciones Dequeue y Peek. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Agrega un nuevo mensaje a la parte posterior de una cola. El tiempo de espera de visibilidad especifica cuánto tiempo debe ser invisible el mensaje para las operaciones Dequeue y Peek. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessageAsync(String)	Agrega un nuevo mensaje a la parte posterior de una cola. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessageAsync(String, CancellationToken)	Agrega un nuevo mensaje a la parte posterior de una cola. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SendMessageAsync(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Agrega un nuevo mensaje a la parte posterior de una cola. El tiempo de espera de visibilidad especifica cuánto tiempo debe ser invisible el mensaje para las operaciones Dequeue y Peek. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Coloque mensaje.
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync establece directivas de acceso almacenadas para la cola que se pueden usar con firmas de acceso compartido. Para obtener más información, vea Establezca la ACL de cola.
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync establece directivas de acceso almacenadas para la cola que se pueden usar con firmas de acceso compartido. Para obtener más información, vea Establezca la ACL de cola.
SetMetadata(IDictionary<String,String>, CancellationToken)	Establece los metadatos definidos por el usuario en la cola especificada. Los metadatos se asocian con la cola como pares nombre-valor. Para obtener más información, vea Establecer metadatos de cola.
SetMetadataAsync(IDictionary<String,String>, CancellationToken)	Establece los metadatos definidos por el usuario en la cola especificada. Los metadatos se asocian con la cola como pares nombre-valor. Para obtener más información, vea Establecer metadatos de cola.
UpdateMessage(String, String, BinaryData, TimeSpan, CancellationToken)	Cambia el tiempo de espera y el contenido de la visibilidad de un mensaje. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Actualizar mensaje.
UpdateMessage(String, String, String, TimeSpan, CancellationToken)	Cambia el tiempo de espera y el contenido de la visibilidad de un mensaje. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Actualizar mensaje.
UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)	Cambia el tiempo de espera y el contenido de la visibilidad de un mensaje. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Actualizar mensaje.
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)	Cambia el tiempo de espera y el contenido de la visibilidad de un mensaje. Un mensaje debe estar en un formato tal que se pueda incluir en una solicitud XML con codificación UTF-8. De lo contrario MessageEncoding , la opción se puede establecer en Base64 para controlar mensajes no compatibles. El mensaje codificado puede tener un tamaño de hasta 64 KiB para las versiones 2011-08-18 y posteriores, o 8 KiB para versiones anteriores. Para obtener más información, vea Actualizar mensaje.
WithClientSideEncryptionOptionsCore(ClientSideEncryptionOptions)	Crea una nueva instancia de la QueueClient clase , manteniendo todos los mismos elementos internos, pero especificando .ClientSideEncryptionOptions

Métodos de extensión

GetParentQueueServiceClient(QueueClient)	Cree un nuevo QueueServiceClient que apunte a este QueueClientservicio de cola. El nuevo QueueServiceClient usa la misma canalización de directiva de solicitud que .QueueClient
WithClientSideEncryptionOptions(QueueClient, ClientSideEncryptionOptions)	Crea una nueva instancia de la QueueClient clase , manteniendo todos los mismos elementos internos, pero especificando .ClientSideEncryptionOptions