@azure/storage-queue package

Classes

AccountSASPermissions	DISPONÍVEL APENAS NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este deve ser serializado com toString e definido como o campo de permissões num objeto AccountSASSignatureValues . É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.
AccountSASResourceTypes	DISPONÍVEL APENAS NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa os recursos acessíveis por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá acesso a esse tipo de recurso. Assim que todos os valores estiverem definidos, este deve ser serializado com toString e definido como o campo de recursos num objeto AccountSASSignatureValues . É possível construir a cadeia de recursos sem esta classe, mas a ordem dos recursos é particular e esta classe garante a correção.
AccountSASServices	DISPONÍVEL APENAS NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa os serviços acessíveis por uma ContaSAS. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá acesso a esse serviço. Assim que todos os valores estiverem definidos, este deve ser serializado com toString e definido como o campo de serviços num objeto AccountSASSignatureValues . É possível construir a cadeia de serviços sem esta classe, mas a ordem dos serviços é particular e esta classe garante a correção.
AnonymousCredential	AnonymousCredential fornece um membro CredentialPolicyCreator utilizado para criar objetos AnonymousCredentialPolicy . AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy é utilizado com pedidos HTTP(S) que leem recursos públicos ou para utilização com Assinaturas de Acesso Partilhado (SAS).
BaseRequestPolicy	A classe base a partir da qual todas as políticas de pedido derivam.
Credential	A credencial é uma classe abstrata para a assinatura de pedidos HTTP do Armazenamento do Microsoft Azure. Esta classe irá alojar uma fábrica credentialPolicyCreator que gera CredentialPolicy.
CredentialPolicy	Política de credenciais utilizada para assinar pedidos HTTP(S) antes de enviar. Esta é uma classe abstrata.
HttpHeaders	Uma coleção de pares chave/valor de cabeçalho HTTP.
Pipeline	Uma classe pipeline que contém políticas de pedido HTTP. Pode criar um Pipeline predefinido ao chamar newPipeline(). Em alternativa, pode criar um Pipeline com as suas próprias políticas pelo construtor do Pipeline. Veja newPipeline() e as políticas fornecidas como referência antes de implementar o Pipeline personalizado.
QueueClient	Um QueueClient representa um URL para as mensagens de uma Fila de Armazenamento do Azure que lhe permite manipular as respetivas mensagens.
QueueSASPermissions	APENAS DISPONÍVEL NO NODE.JS RUNTIME. Esta é uma classe auxiliar para construir uma cadeia que representa as permissões concedidas por um ServiceSAS a uma Fila. Definir um valor como verdadeiro significa que qualquer SAS que utilize estas permissões concederá permissões para essa operação. Assim que todos os valores estiverem definidos, este valor deve ser serializado com toString e definido como o campo de permissões num objeto QueueSASSignatureValues . É possível construir a cadeia de permissões sem esta classe, mas a ordem das permissões é particular e esta classe garante a correção.
QueueServiceClient	Um QueueServiceClient representa um URL para o serviço Fila de Armazenamento do Azure que lhe permite manipular filas.
RequestPolicyOptions	Propriedades opcionais que podem ser utilizadas ao criar um RequestPolicy.
RestError	Um erro resultante de um pedido HTTP para um ponto final de serviço.
SASQueryParameters	Representa os componentes que constituem os parâmetros de consulta da SAS do Armazenamento do Azure. Este tipo não é construído diretamente pelo utilizador; só é gerado pelos tipos AccountSASSignatureValues e QueueSASSignatureValues . Uma vez gerado, pode ser codificado num toString() URL e anexado diretamente a um URL (embora deva ter cuidado aqui no caso de existirem parâmetros de consulta, o que pode afetar os meios adequados de anexar estes parâmetros de consulta). NOTA: as instâncias desta classe são imutáveis.
StorageBrowserPolicy	StorageBrowserPolicy processará as diferenças entre Node.js e o runtime do browser, incluindo: Os browsers colocam em cache pedidos GET/HEAD ao adicionar cabeçalhos condicionais, como "IF_MODIFIED_SINCE". StorageBrowserPolicy é uma política utilizada para adicionar uma consulta de carimbo de data/hora ao URL do pedido GET/HEAD, evitando assim a cache do browser. Remover cabeçalho de cookie para segurança Remover cabeçalho de comprimento do conteúdo para evitar avisos de browsers
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy .
StorageRetryPolicy	Repita a política com repetição exponencial e repetição linear implementada.
StorageRetryPolicyFactory	StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy .
StorageSharedKeyCredential	APENAS DISPONÍVEL NO NODE.JS RUNTIME. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy é uma política utilizada para assinar o pedido HTTP com uma chave partilhada.
WebResource	Cria um novo objeto WebResource. Esta classe fornece uma abstração através de uma chamada REST por ser agnóstica de biblioteca/implementação e encapsular as propriedades necessárias para iniciar um pedido.

Interfaces

AccessPolicy	Uma política de Acesso
AccountSASSignatureValues	DISPONÍVEL APENAS NO NODE.JS RUNTIME. AccountSASSignatureValues é utilizado para gerar uma Assinatura de Acesso Partilhado (SAS) para uma conta de Armazenamento do Azure. Assim que todos os valores aqui estiverem definidos adequadamente, chame generateSASQueryParameters() para obter uma representação da SAS que pode ser aplicada aos URLs de fila. Nota: esta classe e SASQueryParameters existem porque o primeiro é mutável e uma representação lógica enquanto este é imutável e utilizado para gerar pedidos REST reais. Veja https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceptuais sobre SAS. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas as descrições dos parâmetros, incluindo os necessários
CommonOptions	Uma interface para opções comuns a todas as operações remotas.
CorsRule	O CORS é uma funcionalidade HTTP que permite a execução de uma aplicação Web num domínio para aceder a recursos noutro domínio. Os browsers implementam uma restrição de segurança conhecida como política de origem idêntica que impede uma página Web de chamar APIs num domínio diferente; O CORS fornece uma forma segura de permitir que um domínio (o domínio de origem) chame APIs noutro domínio
DequeuedMessageItem	O objeto devolvido na matriz QueueMessageList ao chamar Obter Mensagens numa Fila.
EnqueuedMessage	O objeto devolvido na matriz QueueMessageList ao chamar Colocar Mensagem numa Fila
GeoReplication	Geo-Replication informações do Serviço de Armazenamento Secundário
HttpOperationResponse	Objeto wrapper para pedido http e resposta. O objeto serializado é armazenado na parsedBody propriedade quando o corpo da resposta é recebido em JSON ou XML.
IHttpClient	Uma interface que pode enviar HttpRequests e receber HttpResponses prometidos.
ListQueuesSegmentResponse	O objeto devolvido ao chamar Filas de Lista num Serviço de Fila.
Logging	Definições do Registo 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 cadeias chave-valor.
Metrics	Uma interface que representa as Métricas.
PeekedMessageItem	O objeto devolvido na matriz QueueMessageList ao chamar Pré-visualizar Mensagens numa Fila
PipelineOptions	Interface de opção para Construtor de pipelines.
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 eliminação
QueueExistsOptions	Existem opções para configurar a operação
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	APENAS DISPONÍVEL NO NODE.JS RUNTIME. QueueSASSignatureValues é utilizado 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 do 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
RequestPolicy	A estrutura subjacente de uma política de pedido.
RetentionPolicy	a política de retenção
SasIPRange	Intervalo de IP permitido para uma SAS.
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çã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 utiliza a nextPolicy fornecida.
GeoReplicationStatusType	Define valores para GeoReplicationStatusType.
HttpRequestBody	Possíveis tipos de corpo de pedido HTTP
ListQueuesIncludeType	Define valores para ListQueuesIncludeType. Os valores possíveis incluem: "metadados"
MessageIdDeleteResponse	Contém dados de resposta para a operação de eliminaçã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 limpar.
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 eliminaçã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 da operação peekMessages .
QueueReceiveMessageResponse	Contém os dados de resposta da operação receiveMessages .
QueueSendMessageResponse	Contém os dados de resposta da 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 devolvido na matriz ao receivedMessageItems chamar receiveMessages. Veja: QueueReceiveMessageResponse
RequestPolicyFactory	Cria um novo RequestPolicy por pedido que utiliza a nextPolicy fornecida.
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 gerados.
StorageQueueAudience	Define as audiências na cloud conhecidas para o Armazenamento.
StorageRetryPolicyType	Tipos de RetryPolicy.

Funções

deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Crie um novo RequestPolicyCreator de serialização que serializará os organismos de pedidos HTTP à medida que passam pelo pipeline HTTP.
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	APENAS DISPONÍVEL NO NODE.JS RUNTIME. Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer um pedido REST real. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	APENAS DISPONÍVEL NO NODE.JS RUNTIME. Cria uma instância de SASQueryParameters. Apenas aceita as definições necessárias para criar uma SAS. Para definições opcionais, defina as propriedades correspondentes diretamente, tais como permissões, startsOn e identificador. AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraÇões. Tem de atribuir valor ao identificador ou expirarOn & permissões manualmente se inicialmente com este construtor.
getQueueServiceAccountAudience(string)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Cria um novo objeto pipeline com credenciais fornecidas.

Detalhes de Função

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Crie um novo RequestPolicyCreator de serialização que serializará os organismos de pedidos HTTP à medida que passam pelo pipeline HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parâmetros

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

Devoluções

RequestPolicyFactory

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer um pedido 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 partilhada.

Devoluções

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Cria uma instância de SASQueryParameters.

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

AVISO: quando o identificador não é fornecido, são necessárias permissões e expiraÇões. Tem de atribuir valor ao identificador ou expirarOn & permissões manualmente se inicialmente com este construtor.

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

Parâmetros

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Devoluções

SASQueryParameters

getQueueServiceAccountAudience(string)

function getQueueServiceAccountAudience(storageAccountName: string): string

Parâmetros

storageAccountName

string

Devoluções

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria um novo objeto pipeline com credenciais fornecidas.

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

Parâmetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

pipelineOptions

StoragePipelineOptions

Opções.

Devoluções

Pipeline

Um novo objeto pipeline.