@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 <xref: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 <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 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 <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 objetos <xref:AnonymousCredentialPolicy>. <xref: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). |
| 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 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 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 <xref: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. |
| 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 <xref:AccountSASSignatureValues> e <xref:QueueSASSignatureValues>. Uma vez gerado, ele pode ser codificado em um <xref:String> 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:
|
| 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 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 <xref: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. |
| 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 |
| 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 |
| PipelineOptions |
Interface de opção para o construtor pipeline. |
| QueueClearMessagesOptions |
Opções para configurar a operação de <xref:QueueClient.clearMessages> |
| QueueCreateHeaders |
Define cabeçalhos para Queue_create operação. |
| QueueCreateIfNotExistsResponse |
Contém dados de resposta para a operação de <xref:QueueClient.createIfNotExists>. |
| QueueCreateOptions |
Opções para configurar a operação de <xref:QueueClient.create> |
| QueueDeleteHeaders |
Define cabeçalhos para Queue_delete operação. |
| QueueDeleteIfExistsResponse |
Contém dados de resposta para a operação de <xref:QueueClient.deleteIfExists>. |
| QueueDeleteMessageOptions |
Opções para configurar a operação de <xref:QueueClient.deleteMessage> |
| QueueDeleteOptions |
Opções para configurar a operação de <xref:QueueClient.delete> |
| QueueExistsOptions |
Opções para configurar a operação de <xref:QueueClient.exists> |
| QueueGenerateSasUrlOptions |
Opções para configurar <xref:QueueClient.generateSasUrl> operação. |
| QueueGetAccessPolicyHeaders |
Define cabeçalhos para Queue_getAccessPolicy operação. |
| QueueGetAccessPolicyOptions |
Opções para configurar a operação de <xref:QueueClient.getAccessPolicy> |
| QueueGetPropertiesHeaders |
Define cabeçalhos para Queue_getProperties operação. |
| QueueGetPropertiesOptions |
Opções para configurar a operação de <xref:QueueClient.getProperties> |
| QueueItem |
Uma Fila de Armazenamento do Azure. |
| QueuePeekMessagesOptions |
Opções para configurar a operação de <xref:QueueClient.peekMessages> |
| QueueReceiveMessageOptions |
Opções para configurar a operação de <xref:QueueClient.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 a operação de <xref:QueueClient.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 de <xref:QueueClient.setAccessPolicy> |
| QueueSetMetadataHeaders |
Define cabeçalhos para Queue_setMetadata operação. |
| QueueSetMetadataOptions |
Opções para configurar a operação de <xref:QueueClient.setMetadata> |
| QueueUpdateMessageOptions |
Opções para configurar a operação de <xref:QueueClient.updateMessage> |
| 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 a operação de <xref:QueueServiceClient.getProperties> |
| ServiceGetStatisticsHeaders |
Define cabeçalhos para Service_getStatistics operação. |
| ServiceGetStatisticsOptions |
Opções para configurar a operação de <xref:QueueServiceClient.getStatistics> |
| ServiceListQueuesOptions |
Opções para configurar a operação de <xref:QueueServiceClient.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 de <xref:QueueServiceClient.setProperties> |
| 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 clara. |
| QueueClearMessagesResponse |
Contém dados de resposta para a operação de <xref:QueueClient.clearMessages>. |
| QueueCreateResponse |
Contém dados de resposta para a operação de criação. |
| QueueDeleteMessageResponse |
Contém dados de resposta para a operação de <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 de <xref:QueueClient.getAccessPolicy>. |
| QueueGetPropertiesResponse |
Contém dados de resposta para a operação getProperties. |
| QueuePeekMessagesResponse |
Contém os dados de resposta da operação <xref:QueueClient.peekMessages>. |
| QueueReceiveMessageResponse |
Contém os dados de resposta da operação <xref:QueueClient.receiveMessages>. |
| QueueSendMessageResponse |
Contém os dados de resposta da 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 de <xref:QueueClient.updateMessage>. |
| ReceivedMessageItem |
O objeto retornado na matriz de |
| 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 gerada. |
| StorageRetryPolicyType |
Tipos retryPolicy. |
Funções
| generate |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Gera um objeto <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real. |
| generate |
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. |
| new |
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 <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.
Retornos
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)
Parâmetros
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Retornos
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria um novo objeto Pipeline com a Credencial fornecida.
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.
Retornos
Um novo objeto Pipeline.