@azure/storage-queue package

Classes

AccountSASPermissions

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:AccountSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.

AccountSASResourceTypes

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os recursos acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse tipo de recurso. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de recursos em um objeto <xref:AccountSASSignatureValues>. É possível construir a cadeia de caracteres de recursos sem essa classe, mas a ordem dos recursos é particular e essa classe garante a correção.

AccountSASServices

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os serviços acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse serviço. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de serviços em um objeto <xref:AccountSASSignatureValues>. É possível construir a cadeia de caracteres de serviços sem essa classe, mas a ordem dos serviços é particular e essa classe garante a correção.

AnonymousCredential

AnonymousCredential fornece um membro <xref:CredentialPolicyCreator> usado para criar <xref:AnonymousCredentialPolicy> objetos. <xref:AnonymousCredentialPolicy> é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).

AnonymousCredentialPolicy

AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).

Credential

Credential é uma classe abstrata para assinatura de solicitações HTTP do Armazenamento do Azure. Essa classe hospedará uma fábrica credentialPolicyCreator que gera CredentialPolicy.

CredentialPolicy

Política de credenciais usada para assinar solicitações HTTP(S) antes do envio. Esta é uma classe abstrata.

Pipeline

Uma classe Pipeline que contém políticas de solicitação HTTP. Você pode criar um Pipeline padrão chamando newPipeline(). Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline. Consulte newPipeline() e as políticas fornecidas como referência antes de implementar seu Pipeline personalizado.

QueueClient

Um QueueClient representa uma URL para as mensagens de uma Fila de Armazenamento do Azure, permitindo que você manipule suas mensagens.

QueueSASPermissions

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS para uma fila. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:QueueSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.

QueueServiceClient

Um QueueServiceClient representa uma URL para o serviço de Fila de Armazenamento do Azure permitindo que você manipule filas.

SASQueryParameters

Representa os componentes que compõem os parâmetros de consulta de um SAS de Armazenamento do Azure. Este tipo não é construído diretamente pelo usuário; é gerado apenas pelos tipos <xref:AccountSASSignatureValues> e <xref:QueueSASSignatureValues>. Uma vez gerado, ele pode ser codificado em um <xref:String> e anexado a uma URL diretamente (embora seja necessário ter cuidado aqui caso existam parâmetros de consulta existentes, o que pode afetar os meios apropriados de anexar esses parâmetros de consulta). Observação : instâncias dessa classe são imutáveis.

StorageBrowserPolicy

StorageBrowserPolicy lidará com as diferenças entre Node.js e o tempo de execução do navegador, incluindo:

  1. Os navegadores armazenam em cache solicitações GET/HEAD adicionando cabeçalhos condicionais como 'IF_MODIFIED_SINCE'. StorageBrowserPolicy é uma política usada para adicionar uma consulta de carimbo de data/hora ao URL de solicitação GET/HEAD, evitando assim o cache do navegador.

  2. Remover cabeçalho de cookie para segurança

  3. Remova o cabeçalho de comprimento de conteúdo para evitar avisos de navegadores

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos <xref:StorageBrowserPolicy>.

StorageClient

Um StorageClient representa uma classe de cliente baseada para <xref:QueueServiceClient>, <xref:QueueClient> e etc.

StorageClientContext
StorageRetryPolicy

Política de repetição com repetição exponencial e repetição linear implementada.

StorageRetryPolicyFactory

StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos <xref:StorageRetryPolicy>.

StorageSharedKeyCredential

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy é uma política usada para assinar solicitações HTTP com uma chave compartilhada.

Interfaces

AccessPolicy

Uma política de acesso

AccountSASSignatureValues

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. AccountSASSignatureValues é usado para gerar uma Assinatura de Acesso Compartilhado (SAS) para uma conta de Armazenamento do Azure. Uma vez que todos os valores aqui são definidos adequadamente, chame generateSASQueryParameters() para obter uma representação do SAS que pode realmente ser aplicado a urls de fila. Nota: que tanto essa classe quanto <xref:SASQueryParameters> existem porque a primeira é mutável e uma representação lógica, enquanto a segunda é imutável e usada para gerar solicitações REST reais.

CommonOptions

Uma interface para opções comuns a todas as operações remotas.

CorsRule

O CORS é um recurso HTTP que permite que um aplicativo Web executado em um domínio acesse recursos em outro domínio. Os navegadores da Web implementam uma restrição de segurança conhecida como política de mesma origem que impede que uma página da Web chame APIs em um domínio diferente; O CORS fornece uma maneira segura de permitir que um domínio (o domínio de origem) chame APIs em outro domínio

DequeuedMessageItem

O objeto retornado na matriz QueueMessageList ao chamar Get Messages on a Queue.

EnqueuedMessage

O objeto retornado na matriz QueueMessageList ao chamar Put Message on a Queue

GeoReplication

Geo-Replication informações para o Serviço de Armazenamento Secundário

ListQueuesSegmentResponse

O objeto retornado ao chamar Listar Filas em um Serviço de Fila.

Logging

Configurações de Log do Azure Analytics.

MessageIdDeleteHeaders

Define cabeçalhos para MessageId_delete operação.

MessageIdUpdateHeaders

Define cabeçalhos para MessageId_update operação.

MessagesClearHeaders

Define cabeçalhos para Messages_clear operação.

MessagesDequeueHeaders

Define cabeçalhos para Messages_dequeue operação.

MessagesDequeueOptionalParams

Parâmetros opcionais.

MessagesEnqueueHeaders

Define cabeçalhos para Messages_enqueue operação.

MessagesEnqueueOptionalParams

Parâmetros opcionais.

MessagesPeekHeaders

Define cabeçalhos para Messages_peek operação.

MessagesPeekOptionalParams

Parâmetros opcionais.

Metadata

Uma coleção de pares de cadeia de caracteres chave-valor.

Metrics

Uma interface que representa Métricas.

PeekedMessageItem

O objeto retornado na matriz QueueMessageList ao chamar Peek Messages em uma fila

PipelineOptions

Interface de opção para o construtor Pipeline.

QueueClearMessagesOptions

Opções para configurar <xref:QueueClient.clearMessages> operação

QueueCreateHeaders

Define cabeçalhos para Queue_create operação.

QueueCreateIfNotExistsResponse

Contém dados de resposta para a operação <xref:QueueClient.createIfNotExists>.

QueueCreateOptions

Opções para configurar <xref:QueueClient.create> operação

QueueDeleteHeaders

Define cabeçalhos para Queue_delete operação.

QueueDeleteIfExistsResponse

Contém dados de resposta para a operação <xref:QueueClient.deleteIfExists>.

QueueDeleteMessageOptions

Opções para configurar a operação <xref:QueueClient.deleteMessage>

QueueDeleteOptions

Opções para configurar <xref:QueueClient.delete> operação

QueueExistsOptions

Opções para configurar <xref:QueueClient.exists> operação

QueueGenerateSasUrlOptions

Opções para configurar <xref:QueueClient.generateSasUrl> operação.

QueueGetAccessPolicyHeaders

Define cabeçalhos para Queue_getAccessPolicy operação.

QueueGetAccessPolicyOptions

Opções para configurar <xref:QueueClient.getAccessPolicy> operação

QueueGetPropertiesHeaders

Define cabeçalhos para Queue_getProperties operação.

QueueGetPropertiesOptions

Opções para configurar <xref:QueueClient.getProperties> operação

QueueItem

Uma fila de armazenamento do Azure.

QueuePeekMessagesOptions

Opções para configurar <xref:QueueClient.peekMessages> operação

QueueReceiveMessageOptions

Opções para configurar <xref:QueueClient.receiveMessages> operação

QueueSASSignatureValues

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. QueueSASSignatureValues é usado para ajudar a gerar tokens SAS de serviço de fila para filas.

QueueSendMessageOptions

Opções para configurar <xref:QueueClient.sendMessage> operação

QueueServiceProperties

Propriedades do serviço de armazenamento.

QueueServiceStatistics

Estatísticas para o serviço de armazenamento.

QueueSetAccessPolicyHeaders

Define cabeçalhos para Queue_setAccessPolicy operação.

QueueSetAccessPolicyOptions

Opções para configurar <xref:QueueClient.setAccessPolicy> operação

QueueSetMetadataHeaders

Define cabeçalhos para Queue_setMetadata operação.

QueueSetMetadataOptions

Opções para configurar <xref:QueueClient.setMetadata> operação

QueueUpdateMessageOptions

Opções para configurar <xref:QueueClient.updateMessage> operação

RetentionPolicy

A política de retenção

SasIPRange

Intervalo de IP permitido para uma SAS.

ServiceGenerateAccountSasUrlOptions

Opções para configurar <xref:QueueServiceClient.generateAccountSasUrl> operação.

ServiceGetPropertiesHeaders

Define cabeçalhos para Service_getProperties operação.

ServiceGetPropertiesOptions

Opções para configurar <xref:QueueServiceClient.getProperties> operação

ServiceGetStatisticsHeaders

Define cabeçalhos para Service_getStatistics operação.

ServiceGetStatisticsOptions

Opções para configurar <xref:QueueServiceClient.getStatistics> operação

ServiceListQueuesOptions

Opções para configurar <xref:QueueServiceClient.listQueues> operação

ServiceListQueuesSegmentHeaders

Define cabeçalhos para Service_listQueuesSegment operação.

ServiceSetPropertiesHeaders

Define cabeçalhos para Service_setProperties operação.

ServiceSetPropertiesOptions

Opções para configurar <xref:QueueServiceClient.setProperties> operação

SignedIdentifier

Identificador assinado.

SignedIdentifierModel

identificador assinado

StorageClientOptionalParams

Parâmetros opcionais.

StoragePipelineOptions

Interface de opção para o método newPipeline().

StorageRetryOptions

Interface de opções de repetição da fila de armazenamento.

Aliases de Tipo

CredentialPolicyCreator

Uma função de fábrica que cria uma nova CredentialPolicy que usa a nextPolicy fornecida.

GeoReplicationStatusType

Define valores para GeoReplicationStatusType.

ListQueuesIncludeType

Define valores para ListQueuesIncludeType. Os valores possíveis incluem: 'metadados'

MessageIdDeleteResponse

Contém dados de resposta para a operação de exclusão.

MessageIdUpdateResponse

Contém dados de resposta para a operação de atualização.

MessagesClearResponse

Contém dados de resposta para a operação limpa.

QueueClearMessagesResponse

Contém dados de resposta para a operação <xref:QueueClient.clearMessages>.

QueueCreateResponse

Contém dados de resposta para a operação create.

QueueDeleteMessageResponse

Contém dados de resposta para a operação <xref:QueueClient.deleteMessage>.

QueueDeleteResponse

Contém dados de resposta para a operação de exclusão.

QueueGetAccessPolicyResponse

Contém dados de resposta para a operação <xref:QueueClient.getAccessPolicy>.

QueueGetPropertiesResponse

Contém dados de resposta para a operação getProperties.

QueuePeekMessagesResponse

Contém os dados de resposta para a operação <xref:QueueClient.peekMessages>.

QueueReceiveMessageResponse

Contém os dados de resposta para a operação <xref:QueueClient.receiveMessages>.

QueueSendMessageResponse

Contém os dados de resposta para a operação <xref:QueueClient.sendMessage>.

QueueSetAccessPolicyResponse

Contém dados de resposta para a operação setAccessPolicy.

QueueSetMetadataResponse

Contém dados de resposta para a operação setMetadata.

QueueUpdateMessageResponse

Contém dados de resposta para a operação <xref:QueueClient.updateMessage>.

ReceivedMessageItem

O objeto retornado na matriz receivedMessageItems ao chamar <xref:QueueClient.receiveMessages>. Veja: <xref:QueueReceiveMessageResponse>

ServiceGetPropertiesResponse

Contém dados de resposta para a operação getProperties.

ServiceGetStatisticsResponse

Contém dados de resposta para a operação getStatistics.

ServiceListQueuesSegmentResponse

Contém dados de resposta para a operação listQueuesSegment.

ServiceSetPropertiesResponse

Contém dados de resposta para a operação setProperties.

Enumerações

SASProtocol

Protocolos para SAS gerado.

StorageRetryPolicyType

Tipos RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters.

Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

AVISO: Quando o identificador não é fornecido, as permissões e expirações são necessárias. Você DEVE atribuir valor ao identificador ou expira & permissões manualmente se você inicializar com este construtor.

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com Credential fornecido.

Detalhes de Função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parâmetros

accountSASSignatureValues
AccountSASSignatureValues

Valores de assinatura SAS da conta

sharedKeyCredential
StorageSharedKeyCredential

Credencial de chave compartilhada.

Devoluções

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters.

Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

AVISO: Quando o identificador não é fornecido, as permissões e expirações são necessárias. Você DEVE atribuir valor ao identificador ou expira & permissões manualmente se você inicializar com este construtor.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parâmetros

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluções

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com Credential fornecido.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)

Parâmetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

pipelineOptions
StoragePipelineOptions

Opções.

Devoluções

Um novo objeto Pipeline.