@azure/storage-queue package

Classes

AccountSASPermissions	DISPONÍVEL APENAS 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 é particular e essa classe garante a correção.
AccountSASResourceTypes	DISPONÍVEL APENAS 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 é particular e essa classe garante a correção.
AccountSASServices	DISPONÍVEL APENAS 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 é 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 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	A credencial é 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 EM NODE.JS RUNTIME. 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 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 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. Uma vez gerado, ele pode ser codificado em um toString() e acrescentado diretamente a uma URL (embora seja necessário ter cuidado aqui no caso de haver 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: 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. Remover cabeçalho de cookie para segurança Remover o cabeçalho de comprimento do 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 EM NODE.JS RUNTIME. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy é uma política usada para assinar uma solicitação HTTP com uma chave compartilhada.

Interfaces

AccessPolicy	Uma política de acesso
AccountSASSignatureValues	DISPONÍVEL APENAS 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 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 os quais são necessários
CommonOptions	Uma interface para opções comuns a cada operação remota.
CorsRule	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 Colocar Mensagem em uma Fila
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 Filas de Lista 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 do 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 operação clearMessages
QueueCreateHeaders	Define cabeçalhos para Queue_create operação.
QueueCreateIfNotExistsResponse	Contém dados de resposta para a operação de 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 a operação deleteIfExists.
QueueDeleteMessageOptions	Opções para configurar a operação deleteMessage
QueueDeleteOptions	Opções para configurar excluir operação
QueueExistsOptions	Há opções para configurar existe operação
QueueGenerateSasUrlOptions	Opções para configurar a operação de generateSasUrl.
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 de peekMessages
QueueReceiveMessageOptions	Opções para configurar operação de receiveMessages
QueueSASSignatureValues	DISPONÍVEL APENAS EM NODE.JS RUNTIME. QueueSASSignatureValues é usado para ajudar a gerar tokens SAS do serviço Fila para filas.
QueueSendMessageOptions	Opções para configurar operação de sendMessage
QueueServiceProperties	Propriedades do Serviço de Armazenamento.
QueueServiceStatistics	Estatísticas do 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 de 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 digitado.
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 operação de generateAccountSasUrl.
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 de getStatistics
ServiceListQueuesOptions	Opções para configurar operação de 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 de 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 clara.
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 da 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 de getAccessPolicy.
QueueGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
QueuePeekMessagesResponse	Contém os dados de resposta da operação de peekMessages.
QueueReceiveMessageResponse	Contém os dados de resposta da operação receiveMessages.
QueueSendMessageResponse	Contém os dados de resposta da 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. Veja: 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 as audiências de nuvem conhecidas para Armazenamento.
StorageRetryPolicyType	Tipos retryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DISPONÍVEL APENAS EM NODE.JS RUNTIME. Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	DISPONÍVEL APENAS EM NODE.JS RUNTIME. Cria uma instância de SASQueryParameters. Aceita apenas 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 expiraOn são necessárias. Você deve atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar 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 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 EM NODE.JS RUNTIME.

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

Consulte 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 EM NODE.JS RUNTIME.

Cria uma instância de SASQueryParameters.

Aceita apenas 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 expiraOn são necessárias. Você deve atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar 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 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 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 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

Opcional. Opções.

Retornos

Pipeline

Um novo objeto Pipeline.