@azure/storage-queue package
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. |
HttpHeaders |
Uma coleção de pares chave/valor de cabeçalho HTTP. |
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 SOMENTE 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 é específica e essa classe garante a exatidão. |
QueueServiceClient |
Um QueueServiceClient representa uma URL para o serviço fila de armazenamento do Azure, permitindo que você manipule filas. |
RequestPolicyOptions |
Propriedades opcionais que podem ser usadas ao criar uma RequestPolicy. |
RestError |
Um erro resultante de uma solicitação HTTP para um ponto de extremidade de serviço. |
SASQueryParameters |
Representa os componentes que compõem os parâmetros de consulta de uma SAS do 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 a uma URL diretamente (embora seja necessário ter cuidado 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:
|
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 implementadas. |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy . |
StorageSharedKeyCredential |
DISPONÍVEL SOMENTE 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. |
WebResource |
Cria um novo objeto WebResource. Essa classe fornece uma abstração em uma chamada REST sendo independente de biblioteca/implementação e encapsulando as propriedades necessárias para iniciar uma solicitação. |
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 |
HttpOperationResponse |
Objeto wrapper para solicitação e resposta http. O objeto desserializado é armazenado na |
IHttpClient |
Uma interface que pode enviar HttpRequests e receber HttpResponses prometidos. |
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 mensagens Pré-visualizar em uma fila |
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 SOMENTE 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 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 |
RequestPolicy |
A estrutura subjacente de uma política de solicitação. |
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 usa a nextPolicy fornecida. |
GeoReplicationStatusType |
Define valores para GeoReplicationStatusType. |
HttpRequestBody |
Possíveis tipos de corpo de solicitação HTTP |
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 para a 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 matriz ao Confira: QueueReceiveMessageResponse |
RequestPolicyFactory |
Cria uma nova RequestPolicy por solicitação que usa 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 gerada. |
StorageQueueAudience |
Define as audiências de nuvem conhecidas para Armazenamento. |
StorageRetryPolicyType |
Tipos retryPolicy. |
Funções
deserialization |
Crie uma nova serialização RequestPolicyCreator que serializará corpos de solicitação HTTP conforme eles passarem pelo pipeline HTTP. |
generate |
DISPONÍVEL SOMENTE 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. 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 identificador. AVISO: quando o identificador não é fornecido, permissões e expiraOn são necessárias. Você DEVE atribuir o valor ao identificador ou expirarEm permissões de & manualmente se você iniciar com esse construtor. |
get |
|
new |
Cria um novo objeto Pipeline com a Credencial fornecida. |
Detalhes da função
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
Crie uma nova serialização RequestPolicyCreator que serializará corpos de solicitação HTTP conforme eles passarem pelo pipeline HTTP.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
Parâmetros
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
Retornos
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL SOMENTE 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.
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
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.
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 identificador.
AVISO: quando o identificador não é fornecido, permissões e expiraOn são necessárias. 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
getQueueServiceAccountAudience(string)
function getQueueServiceAccountAudience(storageAccountName: string): string
Parâmetros
- storageAccountName
-
string
Retornos
string
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
Opções.
Retornos
Um novo objeto Pipeline.