Compartilhar via

@azure/storage-queue package

  • Referência

Classes

AccountSASPermissions

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto AccountSASSignatureValues . É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é específica e essa classe garante a exatidão.
AccountSASResourceTypes

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

Essa é 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 forem definidos, isso deverá 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 é específica e essa classe garante a exatidão.
AccountSASServices

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

Essa é 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 forem definidos, isso deverá 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 é específica e essa classe garante a exatidã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 SAS (Assinaturas de Acesso Compartilhado).
AnonymousCredentialPolicy

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

A classe base da qual todas as políticas de solicitação derivam.
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 credencial usada para assinar solicitações HTTP(S) antes de enviar. 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 do 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 NO RUNTIME NODE.JS.

Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a uma Fila. Definir um valor como true significa que qualquer SAS que usa essas permissões concederá permissões para essa operação. Depois que todos os valores forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto QueueSASSignatureValues . É possível construir a cadeia de caracteres 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 fila de armazenamento do Azure, permitindo que você manipule filas.
RestError

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

Representa os componentes que compõem os parâmetros de consulta de uma SAS de Armazenamento do Azure. Esse tipo não é construído diretamente pelo usuário; ele só é gerado pelos tipos AccountSASSignatureValues e QueueSASSignatureValues . Depois de gerado, ele pode ser codificado em um toString() e acrescentado a uma URL diretamente (embora tenha cuidado para ser tomado aqui caso haja parâmetros de consulta existentes, o que pode afetar os meios apropriados de acrescentar esses parâmetros de consulta).

OBSERVAÇÃO: as instâncias dessa classe são imutáveis.
StorageBrowserPolicy

StorageBrowserPolicy lidará com diferenças entre Node.js e o runtime 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 à URL de solicitação GET/HEAD, evitando assim o cache do navegador.

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

  3. Remover cabeçalho de comprimento de conteúdo para evitar o aviso de navegadores
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 objetos StorageRetryPolicy .
StorageSharedKeyCredential

DISPONÍVEL APENAS NO RUNTIME 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 a solicitação HTTP com uma chave compartilhada.

Interfaces

AccessPolicy

Uma política de acesso
AccountSASSignatureValues

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

AccountSASSignatureValues é usado para gerar uma SAS (Assinatura de Acesso Compartilhado) para uma conta de Armazenamento do Azure. Depois que todos os valores aqui forem definidos adequadamente, chame generateSASQueryParameters() para obter uma representação da SAS que pode realmente ser aplicada às URLs da fila. Observação: essa classe e SASQueryParameters existem porque a primeira é mutável e uma representação lógica, enquanto a última é imutável e usada para gerar solicitações REST reais.

Consulte https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceituais sobre SAS Consulte https://docs.microsoft.com/en-us/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 cada operação remota.
CorsRule

O CORS é um recurso HTTP que permite que um aplicativo web em execução 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 uma página da Web de chamar 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 Obter Mensagens em uma Fila.
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.
IHttpClient

Uma interface compatível para políticas de solicitação core-http
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 Espiar Mensagens em uma Fila
PipelineLike

Uma interface para a 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 do 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 a operação clearMessages
QueueCreateHeaders

Define cabeçalhos para Queue_create operação.
QueueCreateIfNotExistsResponse

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

Opções para configurar a operação de criação
QueueDeleteHeaders

Define cabeçalhos para Queue_delete operação.
QueueDeleteIfExistsResponse

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

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

Opções para configurar a operação de exclusão
QueueExistsOptions

Opções para configurar a operação existe
QueueGenerateSasUrlOptions

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

Define cabeçalhos para Queue_getAccessPolicy operação.
QueueGetAccessPolicyOptions

Opções para configurar a operação getAccessPolicy
QueueGetPropertiesHeaders

Define cabeçalhos para Queue_getProperties operação.
QueueGetPropertiesOptions

Opções para configurar a operação getProperties
QueueItem

Uma Fila de Armazenamento do Azure.
QueuePeekMessagesOptions

Opções para configurar a operação peekMessages
QueueReceiveMessageOptions

Opções para configurar a operação receiveMessages
QueueSASSignatureValues

DISPONÍVEL APENAS NO RUNTIME NODE.JS.

QueueSASSignatureValues é usado para ajudar a gerar tokens SAS do serviço fila para filas.
QueueSendMessageOptions

Opções para configurar a operação 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 a operação setAccessPolicy
QueueSetMetadataHeaders

Define cabeçalhos para Queue_setMetadata operação.
QueueSetMetadataOptions

Opções para configurar a operação setMetadata
QueueUpdateMessageOptions

Opções para configurar a operação updateMessage
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.
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 a operação generateAccountSasUrl .
ServiceGetPropertiesHeaders

Define cabeçalhos para Service_getProperties operação.
ServiceGetPropertiesOptions

Opções para configurar a operação getProperties
ServiceGetStatisticsHeaders

Define cabeçalhos para Service_getStatistics operação.
ServiceGetStatisticsOptions

Opções para configurar a operação getStatistics
ServiceListQueuesOptions

Opções para configurar a 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 a 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 do Blob de Armazenamento.
WebResource

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

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.
HttpRequestBody

Tipos de corpos com suporte na solicitação. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream e () => ReadableStream são somente navegador.
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 de limpeza.
QueueClearMessagesResponse

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

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

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

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

Contém dados de resposta para a 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 da operação receiveMessages .
QueueSendMessageResponse

Contém os dados de resposta para a operação 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 receivedMessageItems matriz ao chamar receiveMessages.

Confira: 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 gerada.
StorageQueueAudience

Define os públicos de nuvem conhecidos para Armazenamento.
StorageRetryPolicyType

Tipos retryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME 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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME NODE.JS.

Cria uma instância de SASQueryParameters.

Aceita apenas as configurações necessárias necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identifier.

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraOn. Você DEVE atribuir o valor ao identificador ou expirarEm permissões de & manualmente se você iniciar com esse construtor.
getQueueServiceAccountAudience(string)

Para obter o público-alvo do OAuth para uma conta de armazenamento para o 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 a Credencial fornecida.

Detalhes da função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME 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.

Veja https://docs.microsoft.com/en-us/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.

Retornos

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONÍVEL APENAS NO RUNTIME NODE.JS.

Cria uma instância de SASQueryParameters.

Aceita apenas as configurações necessárias necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identifier.

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraOn. Você DEVE atribuir o valor ao identificador ou expirarEm permissões de & manualmente se você iniciar com esse construtor.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parâmetros

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Retornos

SASQueryParameters

getQueueServiceAccountAudience(string)

Para obter o público-alvo do OAuth para uma conta de armazenamento para o serviço de fila.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parâmetros

storageAccountName

string

Retornos

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

Retornos

pipeline

true quando o argumento satisfaz o contrato de pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto Pipeline com a Credencial fornecida.

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

Parâmetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote 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

Opcional. Opções.

Retornos

Pipeline

Um novo objeto Pipeline.