QueueClient Classe

Definição

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Pacote:

Azure.Storage.Queues v12.17.1

Origem:

QueueClient.cs

Um QueueClient representa um URI para o serviço fila de armazenamento do Azure, permitindo que você manipule uma fila.

public class QueueClient

type QueueClient = class

Public Class QueueClient

Herança

Object

QueueClient

Construtores

QueueClient()	Inicializa uma nova instância da QueueClient classe para simulação.
QueueClient(String, String)	Inicializa uma nova instância da classe QueueClient.
QueueClient(String, String, QueueClientOptions)	Inicializa uma nova instância da classe QueueClient.
QueueClient(Uri, AzureSasCredential, QueueClientOptions)	Inicializa uma nova instância da classe QueueClient.
QueueClient(Uri, QueueClientOptions)	Inicializa uma nova instância da classe QueueClient.
QueueClient(Uri, StorageSharedKeyCredential, QueueClientOptions)	Inicializa uma nova instância da classe QueueClient.
QueueClient(Uri, TokenCredential, QueueClientOptions)	Inicializa uma nova instância da classe QueueClient.

Propriedades

AccountName	Obtém o nome da conta de armazenamento correspondente ao cliente de fila.
CanGenerateSasUri	Determina se o cliente é capaz de gerar uma SAS. Se o cliente for autenticado com um StorageSharedKeyCredential.
MaxPeekableMessages	QueueMaxMessagesPeek indica o número máximo de mensagens que você pode recuperar com cada chamada para Espiar.
MessageMaxBytes	Obtém o número máximo de bytes permitidos para o texto UTF-8 de uma mensagem.
MessagesUri	Obtém o ponto de extremidade de URI usado pelas mensagens do objeto.
Name	Obtém o nome da fila.
Uri	Obtém o ponto de extremidade Uri usado pelo objeto .

Métodos

ClearMessages(CancellationToken)	Exclui todas as mensagens de uma fila. Para obter mais informações, consulte Limpar Mensagens.
ClearMessagesAsync(CancellationToken)	Exclui todas as mensagens de uma fila. Para obter mais informações, consulte Limpar Mensagens.
Create(IDictionary<String,String>, CancellationToken)	Cria uma fila. Para obter mais informações, consulte Criar Fila.
CreateAsync(IDictionary<String,String>, CancellationToken)	Cria uma fila. Para obter mais informações, consulte Criar Fila.
CreateIfNotExists(IDictionary<String,String>, CancellationToken)	A CreateIfNotExists(IDictionary<String,String>, CancellationToken) operação cria uma nova fila na conta especificada. Se a fila já existir, ela não será alterada. Para obter mais informações, consulte Criar Fila.
CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken)	A CreateIfNotExistsAsync(IDictionary<String,String>, CancellationToken) operação cria uma nova fila na conta especificada. Se a fila já existir, ela não será alterada. Para obter mais informações, consulte Criar Fila.
Delete(CancellationToken)	Exclui uma fila. Para obter mais informações, consulte Excluir Fila.
DeleteAsync(CancellationToken)	Exclui uma fila. Para obter mais informações, consulte Excluir Fila.
DeleteIfExists(CancellationToken)	A DeleteIfExists(CancellationToken) operação excluirá a fila especificada se ela existir. Para obter mais informações, consulte Excluir Fila.
DeleteIfExistsAsync(CancellationToken)	A DeleteIfExistsAsync(CancellationToken) operação excluirá a fila especificada se ela existir. Para obter mais informações, consulte Excluir Fila.
DeleteMessage(String, String, CancellationToken)	Remove permanentemente a mensagem especificada de sua fila. Para obter mais informações, consulte Excluir Mensagem.
DeleteMessageAsync(String, String, CancellationToken)	Remove permanentemente a mensagem especificada de sua fila. Para obter mais informações, consulte Excluir Mensagem.
Exists(CancellationToken)	A Exists(CancellationToken) operação pode ser chamada em um QueueClient para ver se a fila associada existe na conta de armazenamento no serviço de armazenamento.
ExistsAsync(CancellationToken)	A ExistsAsync(CancellationToken) operação pode ser chamada em um QueueClient para ver se a fila associada existe na conta de armazenamento no serviço de armazenamento.
GenerateSasUri(QueueSasBuilder)	O GenerateSasUri(QueueSasBuilder) retorna um Uri que gera um Uri SAS do Serviço de Fila com base nas propriedades do cliente e no construtor passados. Para obter mais informações, consulte Construindo uma SAS de serviço
GenerateSasUri(QueueSasPermissions, DateTimeOffset)	O GenerateSasUri(QueueSasPermissions, DateTimeOffset) retorna um Uri que gera um URI de SAS (Assinatura de Acesso Compartilhado) do Serviço de Fila com base nas propriedades e parâmetros do cliente passados. Para obter mais informações, consulte Construindo uma SAS de serviço.
GetAccessPolicy(CancellationToken)	Retorna detalhes sobre as políticas de acesso armazenadas especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. Para obter mais informações, consulte Obter ACL de Fila.
GetAccessPolicyAsync(CancellationToken)	Retorna detalhes sobre as políticas de acesso armazenadas especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. Para obter mais informações, consulte Obter ACL de Fila.
GetParentQueueServiceClientCore()	Crie um novo QueueServiceClient que aponte para esse QueueClientserviço de fila. O novo QueueServiceClient usa o mesmo pipeline de política de solicitação que o QueueClient.
GetProperties(CancellationToken)	Recupera propriedades da fila e metadados e propriedades definidos pelo usuário na fila especificada. Os metadados são associados à fila como pares de nome-valor. Para obter mais informações, consulte Obter metadados de fila.
GetPropertiesAsync(CancellationToken)	Recupera propriedades da fila e metadados e propriedades definidos pelo usuário na fila especificada. Os metadados são associados à fila como pares de nome-valor. Para obter mais informações, consulte Obter metadados de fila.
OnMessageDecodingFailedAsync(QueueMessage, PeekedMessage, Boolean, CancellationToken)	MessageDecodingFailed Gera o evento .
PeekMessage(CancellationToken)	Recupera uma mensagem da frente da fila, mas não altera a visibilidade da mensagem. Para obter mais informações, consulte Espiar Mensagens.
PeekMessageAsync(CancellationToken)	Recupera uma mensagem da frente da fila, mas não altera a visibilidade da mensagem. Para obter mais informações, consulte Espiar Mensagens.
PeekMessages(Nullable<Int32>, CancellationToken)	Recupera uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem. Para obter mais informações, consulte Espiar Mensagens.
PeekMessagesAsync(Nullable<Int32>, CancellationToken)	Recupera uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem. Para obter mais informações, consulte Espiar Mensagens.
ReceiveMessage(Nullable<TimeSpan>, CancellationToken)	Recebe uma mensagem da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Recupera uma mensagem da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessages()	Recebe uma ou mais mensagens da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessages(CancellationToken)	Recebe uma ou mais mensagens da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessages(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Recebe uma ou mais mensagens da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessagesAsync()	Recupera uma ou mais mensagens da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessagesAsync(CancellationToken)	Recupera uma ou mais mensagens da frente da fila. Para obter mais informações, consulte Obter mensagens.
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Recupera uma ou mais mensagens da frente da fila. Para obter mais informações, consulte Obter mensagens.
SendMessage(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adiciona uma nova mensagem à parte de trás de uma fila. O tempo limite de visibilidade especifica por quanto tempo a mensagem deve ficar invisível para as operações Dequeue e Peek. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessage(String)	Adiciona uma nova mensagem à parte de trás de uma fila. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessage(String, CancellationToken)	Adiciona uma nova mensagem à parte de trás de uma fila. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessage(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adiciona uma nova mensagem à parte de trás de uma fila. O tempo limite de visibilidade especifica por quanto tempo a mensagem deve ficar invisível para as operações Dequeue e Peek. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessageAsync(BinaryData, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adiciona uma nova mensagem à parte de trás de uma fila. O tempo limite de visibilidade especifica por quanto tempo a mensagem deve ficar invisível para as operações Dequeue e Peek. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessageAsync(String)	Adiciona uma nova mensagem à parte de trás de uma fila. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessageAsync(String, CancellationToken)	Adiciona uma nova mensagem à parte de trás de uma fila. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SendMessageAsync(String, Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken)	Adiciona uma nova mensagem à parte de trás de uma fila. O tempo limite de visibilidade especifica por quanto tempo a mensagem deve ficar invisível para as operações Dequeue e Peek. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Colocar Mensagem.
SetAccessPolicy(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync define políticas de acesso armazenadas para a fila que pode ser usada com Assinaturas de Acesso Compartilhado. Para obter mais informações, consulte Definir ACL de Fila.
SetAccessPolicyAsync(IEnumerable<QueueSignedIdentifier>, CancellationToken)	SetAccessPolicyAsync define políticas de acesso armazenadas para a fila que pode ser usada com Assinaturas de Acesso Compartilhado. Para obter mais informações, consulte Definir ACL de Fila.
SetMetadata(IDictionary<String,String>, CancellationToken)	Define metadados definidos pelo usuário na fila especificada. Os metadados são associados à fila como pares de nome-valor. Para obter mais informações, consulte Definir metadados de fila.
SetMetadataAsync(IDictionary<String,String>, CancellationToken)	Define metadados definidos pelo usuário na fila especificada. Os metadados são associados à fila como pares de nome-valor. Para obter mais informações, consulte Definir metadados de fila.
UpdateMessage(String, String, BinaryData, TimeSpan, CancellationToken)	Altera o tempo limite e o conteúdo de visibilidade de uma mensagem. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Atualizar Mensagem.
UpdateMessage(String, String, String, TimeSpan, CancellationToken)	Altera o tempo limite e o conteúdo de visibilidade de uma mensagem. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Atualizar Mensagem.
UpdateMessageAsync(String, String, BinaryData, TimeSpan, CancellationToken)	Altera o tempo limite e o conteúdo de visibilidade de uma mensagem. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Atualizar Mensagem.
UpdateMessageAsync(String, String, String, TimeSpan, CancellationToken)	Altera o tempo limite e o conteúdo de visibilidade de uma mensagem. Uma mensagem deve estar em um formato que pode ser incluído em uma solicitação XML com codificação UTF-8. Caso contrário MessageEncoding , a opção pode ser definida como Base64 para lidar com mensagens não compatíveis. A mensagem codificada pode ter até 64 KiB de tamanho para as versões 2011-08-18 e mais recentes ou 8 KiB de tamanho para versões anteriores. Para obter mais informações, consulte Atualizar Mensagem.
WithClientSideEncryptionOptionsCore(ClientSideEncryptionOptions)	Cria uma nova instância da QueueClient classe , mantendo todos os mesmos internos, mas especificando o novo ClientSideEncryptionOptions.

Métodos de Extensão

GetParentQueueServiceClient(QueueClient)	Crie um novo QueueServiceClient que aponte para esse QueueClientserviço de fila. O novo QueueServiceClient usa o mesmo pipeline de política de solicitação que o QueueClient.
WithClientSideEncryptionOptions(QueueClient, ClientSideEncryptionOptions)	Cria uma nova instância da QueueClient classe , mantendo todos os mesmos internos, mas especificando o novo ClientSideEncryptionOptions.