Partilhar via


@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 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 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 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 credentialPolicyCreator usado para criar objetos AnonymousCredentialPolicy. 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).

BaseRequestPolicy

A classe base da qual derivam todas as políticas de solicitação.

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 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 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; ele só é gerado pelos AccountSASSignatureValues e tipos de QueueSASSignatureValues. Uma vez gerado, ele pode ser codificado em um toString() 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.

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy.

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 StorageRetryPolicy objetos.

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 esta classe como SASQueryParameters existir porque a primeira é mutável e uma representação lógica, enquanto a segunda é imutável e usada para gerar solicitações REST reais.

Consulte https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceituais sobre SAS Consulte https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas para obter descrições dos parâmetros, incluindo quais são necessários

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

HttpHeaders

Uma coleção de pares chave/valor de cabeçalho HTTP.

HttpOperationResponse

Resposta Http compatível com o core-v1(core-http).

HttpResponse

Uma representação de uma resposta HTTP que inclui uma referência à solicitação que a originou.

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

PipelineLike

Uma interface para a classe Pipeline que contém diretivas 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 antes de implementar seu Pipeline personalizado.

PipelineOptions

Interface de opção para o construtor Pipeline.

QueueClearMessagesOptions

Opções para configurar operação de clearMessages

QueueCreateHeaders

Define cabeçalhos para Queue_create operação.

QueueCreateIfNotExistsResponse

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

QueueCreateOptions

Opções para configurar criar operação

QueueDeleteHeaders

Define cabeçalhos para Queue_delete operação.

QueueDeleteIfExistsResponse

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

QueueDeleteMessageOptions

Opções para configurar o operação deleteMessage

QueueDeleteOptions

Opções para configurar excluir operação

QueueExistsOptions

Opções para configurar existe operação

QueueGenerateSasUrlOptions

Opções para configurar generateSasUrl operação.

QueueGetAccessPolicyHeaders

Define cabeçalhos para Queue_getAccessPolicy operação.

QueueGetAccessPolicyOptions

Opções para configurar operação de getAccessPolicy

QueueGetPropertiesHeaders

Define cabeçalhos para Queue_getProperties operação.

QueueGetPropertiesOptions

Opções para configurar operação getProperties

QueueItem

Uma fila de armazenamento do Azure.

QueuePeekMessagesOptions

Opções para configurar operação peekMessages

QueueReceiveMessageOptions

Opções para configurar operação de receiveMessages

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 operação de sendMessage

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 operação de setAccessPolicy

QueueSetMetadataHeaders

Define cabeçalhos para Queue_setMetadata operação.

QueueSetMetadataOptions

Opções para configurar operação de setMetadata

QueueUpdateMessageOptions

Opções para configurar operação updateMessage

RequestPolicy

Uma interface compatível para políticas de solicitação core-http

RequestPolicyFactory

Uma interface para compatibilidade com RequestPolicyFactory do core-http

RequestPolicyOptions

Uma interface para compatibilidade com RequestPolicy

ResponseLike

Um objeto com uma propriedade _response simples.

ResponseWithBody

Um objeto com uma propriedade _response que tem corpo e cabeçalhos já analisados em tipos conhecidos.

ResponseWithHeaders

Um objeto com uma propriedade _response que tem cabeçalhos já analisados em um objeto tipado.

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RetentionPolicy

A política de retenção

SasIPRange

Intervalo de IP permitido para uma SAS.

ServiceClientOptions

Um subconjunto de @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Opções para configurar generateAccountSasUrl operação.

ServiceGetPropertiesHeaders

Define cabeçalhos para Service_getProperties operação.

ServiceGetPropertiesOptions

Opções para configurar operação getProperties

ServiceGetStatisticsHeaders

Define cabeçalhos para Service_getStatistics operação.

ServiceGetStatisticsOptions

Opções para configurar operação do getStatistics

ServiceListQueuesOptions

Opções para configurar operação listQueues

ServiceListQueuesSegmentHeaders

Define cabeçalhos para Service_listQueuesSegment operação.

ServiceSetPropertiesHeaders

Define cabeçalhos para Service_setProperties operação.

ServiceSetPropertiesOptions

Opções para configurar operação setProperties

SignedIdentifier

Identificador assinado.

SignedIdentifierModel

identificador assinado

StoragePipelineOptions

Interface de opções para a função newPipeline.

StorageRetryOptions

Interface de opções de repetição de Blob de armazenamento.

WebResource

Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

Aliases de Tipo

GeoReplicationStatusType

Define valores para GeoReplicationStatusType.

HttpRequestBody

Tipos de organismos apoiados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream<Uint8Array> e () => ReadableStream<Uint8Array> são apenas navegadores.

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 o operação de clearMessages.

QueueCreateResponse

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

QueueDeleteMessageResponse

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

QueueDeleteResponse

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

QueueGetAccessPolicyResponse

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

QueueGetPropertiesResponse

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

QueuePeekMessagesResponse

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

QueueReceiveMessageResponse

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

QueueSendMessageResponse

Contém os dados de resposta para o operação de 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 updateMessage.

ReceivedMessageItem

O objeto retornado na matriz receivedMessageItems ao chamar receiveMessages.

Consulte: 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.

WithResponse

Um tipo que representa um resultado de operação com uma propriedade _response conhecida.

Enumerações

SASProtocol

Protocolos para SAS gerado.

StorageQueueAudience

Define os públicos de nuvem conhecidos para armazenamento.

StorageRetryPolicyType

Tipos RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

Visualizar https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

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.

getQueueServiceAccountAudience(string)

Para obter audiência OAuth para uma conta de armazenamento para serviço de fila.

isPipelineLike(unknown)

Um auxiliar para decidir se um determinado argumento satisfaz o contrato de Pipeline

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 SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

Visualizar https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

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): SASQueryParameters

Parâmetros

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluções

getQueueServiceAccountAudience(string)

Para obter audiência OAuth para uma conta de armazenamento para serviço de fila.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parâmetros

storageAccountName

string

Devoluções

string

isPipelineLike(unknown)

Um auxiliar para decidir se um determinado argumento satisfaz o contrato de Pipeline

function isPipelineLike(pipeline: unknown): pipeline

Parâmetros

pipeline

unknown

Um argumento que pode ser um Pipeline

Devoluções

pipeline

true quando o argumento satisfaz o contrato de pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com Credential fornecido.

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

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

Optional. Options.

Devoluções

Um novo objeto Pipeline.