Condividi tramite

@azure/storage-queue package

Classi

AccountSASPermissions

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Una volta impostati tutti i valori, questo valore deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto <xref:AccountSASSignatureValues>. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.
AccountSASResourceTypes

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta le risorse accessibili da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni consentirà l'accesso a tale tipo di risorsa. Dopo aver impostato tutti i valori, deve essere serializzato con toString e impostato come campo delle risorse in un oggetto <xref:AccountSASSignatureValues>. È possibile costruire la stringa di risorse senza questa classe, ma l'ordine delle risorse è particolare e questa classe garantisce la correttezza.
AccountSASServices

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta i servizi accessibili da un AccountSAS. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni consentirà l'accesso a tale servizio. Una volta impostati tutti i valori, deve essere serializzato con toString e impostato come campo dei servizi in un oggetto <xref:AccountSASSignatureValues>. È possibile costruire la stringa dei servizi senza questa classe, ma l'ordine dei servizi è particolare e questa classe garantisce la correttezza.
AnonymousCredential

AnonymousCredential fornisce un membro <xref:CredentialPolicyCreator> utilizzato per creare oggetti <xref:AnonymousCredentialPolicy>. <xref:AnonymousCredentialPolicy> viene usato con richieste HTTP(S) che leggono risorse pubbliche o per l'uso con firme di accesso condiviso.
AnonymousCredentialPolicy

AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggono risorse pubbliche o da usare con firme di accesso condiviso.
Credential

Credential è una classe astratta per la firma delle richieste HTTP di Archiviazione di Azure. Questa classe ospiterà una factory credentialPolicyCreator che genera CredentialPolicy.
CredentialPolicy

Criteri di credenziali usati per firmare le richieste HTTP(S) prima dell'invio. Si tratta di una classe astratta.
Pipeline

Classe Pipeline contenente i criteri di richiesta HTTP. È possibile creare una pipeline predefinita chiamando newPipeline(). In alternativa, è possibile creare una pipeline con criteri personalizzati dal costruttore di Pipeline. Fare riferimento a newPipeline() e ai criteri forniti come riferimento prima di implementare la pipeline personalizzata.
QueueClient

QueueClient rappresenta un URL per i messaggi di una coda di archiviazione di Azure che consente di modificare i messaggi.
QueueSASPermissions

DISPONIBILE SOLO IN NODE.JS RUNTIME. Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un Oggetto ServiceSAS a una coda. L'impostazione di un valore su true indica che qualsiasi firma di accesso condiviso che usa queste autorizzazioni concederà le autorizzazioni per tale operazione. Dopo aver impostato tutti i valori, deve essere serializzato con toString e impostato come campo delle autorizzazioni in un oggetto <xref:QueueSASSignatureValues>. È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è particolare e questa classe garantisce la correttezza.
QueueServiceClient

QueueServiceClient rappresenta un URL del servizio di accodamento di Archiviazione di Azure che consente di modificare le code.
SASQueryParameters

Rappresenta i componenti che costituiscono i parametri di query della firma di accesso condiviso di Archiviazione di Azure. Questo tipo non viene costruito direttamente dall'utente; viene generato solo dai tipi <xref:AccountSASSignatureValues> e <xref:QueueSASSignatureValues>. Una volta generato, può essere codificato in un <xref:String> e accodato direttamente a un URL( anche se è necessario prestare attenzione nel caso in cui siano presenti parametri di query esistenti, che potrebbero influire sui mezzi appropriati per accodare questi parametri di query). NOTA: le istanze di questa classe non sono modificabili.
StorageBrowserPolicy

StorageBrowserPolicy gestirà le differenze tra Node.js e il runtime del browser, tra cui:

  1. I browser memorizzano nella cache le richieste GET/HEAD aggiungendo intestazioni condizionali come "IF_MODIFIED_SINCE". StorageBrowserPolicy è un criterio usato per aggiungere una query timestamp all'URL della richiesta GET/HEAD, evitando così la cache del browser.

  2. Rimuovere l'intestazione del cookie per la sicurezza

  3. Rimuovere l'intestazione content-length per evitare gli avvisi dei browser
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory è una classe factory che consente di generare oggetti <xref:StorageBrowserPolicy>.
StorageClient

Un oggetto StorageClient rappresenta una classe client basata per <xref:QueueServiceClient>, <xref:QueueClient> e così via.
StorageClientContext
StorageRetryPolicy

Criteri di ripetizione dei tentativi con ripetizione esponenziale e ripetizione lineare implementati.
StorageRetryPolicyFactory

StorageRetryPolicyFactory è una classe factory che consente di generare oggetti <xref:StorageRetryPolicy>.
StorageSharedKeyCredential

DISPONIBILE SOLO IN NODE.JS RUNTIME. StorageSharedKeyCredential per l'autorizzazione della chiave dell'account del servizio archiviazione di Azure.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy è un criterio usato per firmare una richiesta HTTP con una chiave condivisa.

Interfacce

AccessPolicy

Criteri di accesso
AccountSASSignatureValues

DISPONIBILE SOLO IN NODE.JS RUNTIME. AccountSASSignatureValues viene usato per generare una firma di accesso condiviso per un account di archiviazione di Azure. Dopo aver impostato tutti i valori qui in modo appropriato, chiamare generateSASQueryParameters() per ottenere una rappresentazione della firma di accesso condiviso che può essere effettivamente applicata agli URL della coda. Si noti che sia questa classe che <xref:SASQueryParameters> esistono perché la prima è modificabile e una rappresentazione logica mentre quest'ultima non è modificabile e usata per generare richieste REST effettive.
CommonOptions

Interfaccia per le opzioni comuni a ogni operazione remota.
CorsRule

CORS è una funzionalità HTTP che consente a un'applicazione Web in esecuzione in un dominio di accedere alle risorse in un altro dominio. I Web browser implementano una restrizione di sicurezza nota come criteri di stessa origine che impediscono a una pagina Web di chiamare le API in un dominio diverso; CORS offre un modo sicuro per consentire a un dominio (dominio di origine) di chiamare le API in un altro dominio
DequeuedMessageItem

Oggetto restituito nella matrice QueueMessageList quando si chiama Recupera messaggi in una coda.
EnqueuedMessage

Oggetto restituito nella matrice QueueMessageList quando si chiama Put Message on a Queue
GeoReplication

Geo-Replication informazioni per il servizio di archiviazione secondario
ListQueuesSegmentResponse

Oggetto restituito quando si chiama List Queues in un servizio di accodamento.
Logging

Impostazioni di registrazione di Analisi di Azure.
MessageIdDeleteHeaders

Definisce le intestazioni per MessageId_delete'operazione.
MessageIdUpdateHeaders

Definisce le intestazioni per MessageId_update'operazione.
MessagesClearHeaders

Definisce le intestazioni per Messages_clear operazione.
MessagesDequeueHeaders

Definisce le intestazioni per Messages_dequeue'operazione.
MessagesDequeueOptionalParams

Parametri facoltativi.
MessagesEnqueueHeaders

Definisce le intestazioni per Messages_enqueue'operazione.
MessagesEnqueueOptionalParams

Parametri facoltativi.
MessagesPeekHeaders

Definisce le intestazioni per Messages_peek'operazione.
MessagesPeekOptionalParams

Parametri facoltativi.
Metadata

Raccolta di coppie di stringhe chiave-valore.
Metrics

Interfaccia che rappresenta le metriche.
PeekedMessageItem

Oggetto restituito nella matrice QueueMessageList quando si chiama Visualizza messaggi in una coda
PipelineOptions

Interfaccia di opzione per il costruttore Pipeline.
QueueClearMessagesOptions

Opzioni per configurare l'operazione di <xref:QueueClient.clearMessages>
QueueCreateHeaders

Definisce le intestazioni per Queue_create'operazione.
QueueCreateIfNotExistsResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.createIfNotExists>.
QueueCreateOptions

Opzioni per configurare l'operazione di <xref:QueueClient.create>
QueueDeleteHeaders

Definisce le intestazioni per Queue_delete'operazione.
QueueDeleteIfExistsResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.deleteIfExists>.
QueueDeleteMessageOptions

Opzioni per configurare l'operazione di <xref:QueueClient.deleteMessage>
QueueDeleteOptions

Opzioni per configurare l'operazione di <xref:QueueClient.delete>
QueueExistsOptions

Opzioni per configurare l'operazione di <xref:QueueClient.exists>
QueueGenerateSasUrlOptions

Opzioni per configurare l'operazione di <xref:QueueClient.generateSasUrl>.
QueueGetAccessPolicyHeaders

Definisce le intestazioni per l'operazione di Queue_getAccessPolicy.
QueueGetAccessPolicyOptions

Opzioni per configurare l'operazione di <xref:QueueClient.getAccessPolicy>
QueueGetPropertiesHeaders

Definisce le intestazioni per Queue_getProperties'operazione.
QueueGetPropertiesOptions

Opzioni per configurare l'operazione di <xref:QueueClient.getProperties>
QueueItem

Coda di Archiviazione di Azure.
QueuePeekMessagesOptions

Opzioni per configurare l'operazione di <xref:QueueClient.peekMessages>
QueueReceiveMessageOptions

Opzioni per configurare l'operazione di <xref:QueueClient.receiveMessages>
QueueSASSignatureValues

DISPONIBILE SOLO IN NODE.JS RUNTIME. QueueSASSignatureValues viene usato per generare token di firma di accesso condiviso del servizio di accodamento per le code.
QueueSendMessageOptions

Opzioni per configurare l'operazione di <xref:QueueClient.sendMessage>
QueueServiceProperties

Proprietà del servizio di archiviazione.
QueueServiceStatistics

Statistiche per il servizio di archiviazione.
QueueSetAccessPolicyHeaders

Definisce le intestazioni per l'operazione di Queue_setAccessPolicy.
QueueSetAccessPolicyOptions

Opzioni per configurare l'operazione di <xref:QueueClient.setAccessPolicy>
QueueSetMetadataHeaders

Definisce le intestazioni per l'operazione di Queue_setMetadata.
QueueSetMetadataOptions

Opzioni per configurare l'operazione di <xref:QueueClient.setMetadata>
QueueUpdateMessageOptions

Opzioni per configurare l'operazione di <xref:QueueClient.updateMessage>
RetentionPolicy

i criteri di conservazione
SasIPRange

Intervallo IP consentito per una firma di accesso condiviso.
ServiceGenerateAccountSasUrlOptions

Opzioni per configurare l'operazione di <xref:QueueServiceClient.generateAccountSasUrl>.
ServiceGetPropertiesHeaders

Definisce le intestazioni per l'operazione di Service_getProperties.
ServiceGetPropertiesOptions

Opzioni per configurare l'operazione di <xref:QueueServiceClient.getProperties>
ServiceGetStatisticsHeaders

Definisce le intestazioni per Service_getStatistics'operazione.
ServiceGetStatisticsOptions

Opzioni per configurare l'operazione di <xref:QueueServiceClient.getStatistics>
ServiceListQueuesOptions

Opzioni per configurare l'operazione di <xref:QueueServiceClient.listQueues>
ServiceListQueuesSegmentHeaders

Definisce le intestazioni per Service_listQueuesSegment'operazione.
ServiceSetPropertiesHeaders

Definisce le intestazioni per l'operazione di Service_setProperties.
ServiceSetPropertiesOptions

Opzioni per configurare l'operazione di <xref:QueueServiceClient.setProperties>
SignedIdentifier

Identificatore firmato.
SignedIdentifierModel

identificatore firmato
StorageClientOptionalParams

Parametri facoltativi.
StoragePipelineOptions

Interfaccia di opzione per il metodo newPipeline().
StorageRetryOptions

Interfaccia delle opzioni di ripetizione dei tentativi della coda di archiviazione.

Alias tipo

CredentialPolicyCreator

Funzione factory che crea un nuovo oggetto CredentialPolicy che usa nextPolicy fornito.
GeoReplicationStatusType

Definisce i valori per GeoReplicationStatusType.
ListQueuesIncludeType

Definisce i valori per ListQueuesIncludeType. I valori possibili includono: 'metadata'
MessageIdDeleteResponse

Contiene i dati di risposta per l'operazione di eliminazione.
MessageIdUpdateResponse

Contiene i dati di risposta per l'operazione di aggiornamento.
MessagesClearResponse

Contiene i dati di risposta per l'operazione di cancellazione.
QueueClearMessagesResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.clearMessages>.
QueueCreateResponse

Contiene i dati di risposta per l'operazione di creazione.
QueueDeleteMessageResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.deleteMessage>.
QueueDeleteResponse

Contiene i dati di risposta per l'operazione di eliminazione.
QueueGetAccessPolicyResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.getAccessPolicy>.
QueueGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.
QueuePeekMessagesResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.peekMessages>.
QueueReceiveMessageResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.receiveMessages>.
QueueSendMessageResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.sendMessage>.
QueueSetAccessPolicyResponse

Contiene i dati di risposta per l'operazione setAccessPolicy.
QueueSetMetadataResponse

Contiene i dati di risposta per l'operazione setMetadata.
QueueUpdateMessageResponse

Contiene i dati di risposta per l'operazione di <xref:QueueClient.updateMessage>.
ReceivedMessageItem

Oggetto restituito nella matrice di receivedMessageItems quando si chiama <xref:QueueClient.receiveMessages>. Vedere: <xref:QueueReceiveMessageResponse>
ServiceGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.
ServiceGetStatisticsResponse

Contiene i dati di risposta per l'operazione getStatistics.
ServiceListQueuesSegmentResponse

Contiene i dati di risposta per l'operazione listQueuesSegment.
ServiceSetPropertiesResponse

Contiene i dati di risposta per l'operazione setProperties.

Enumerazioni

SASProtocol

Protocolli per la firma di accesso condiviso generato.
StorageRetryPolicyType

Tipi RetryPolicy.

Funzioni

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Genera un oggetto <xref:SASQueryParameters> che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Crea un'istanza di SASQueryParameters.

Accetta solo le impostazioni necessarie per creare una firma di accesso condiviso. Per le impostazioni facoltative, impostare direttamente le proprietà corrispondenti, ad esempio autorizzazioni, startsOn e identificatore.

AVVISO: quando l'identificatore non viene fornito, sono necessarie le autorizzazioni e la scadenzaOn. È NECESSARIO assegnare un valore all'identificatore o alla scadenzaOn & autorizzazioni manualmente se si esegue l'inizializzazione con questo costruttore.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuovo oggetto Pipeline con credenziali fornite.

Dettagli funzione

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Genera un oggetto <xref:SASQueryParameters> che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametri

accountSASSignatureValues
AccountSASSignatureValues

Valori della firma di accesso condiviso dell'account

sharedKeyCredential
StorageSharedKeyCredential

Credenziali della chiave condivisa.

Restituisce

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN NODE.JS RUNTIME. Crea un'istanza di SASQueryParameters.

Accetta solo le impostazioni necessarie per creare una firma di accesso condiviso. Per le impostazioni facoltative, impostare direttamente le proprietà corrispondenti, ad esempio autorizzazioni, startsOn e identificatore.

AVVISO: quando l'identificatore non viene fornito, sono necessarie le autorizzazioni e la scadenzaOn. È NECESSARIO assegnare un valore all'identificatore o alla scadenzaOn & autorizzazioni manualmente se si esegue l'inizializzazione con questo costruttore.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parametri

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Restituisce

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuovo oggetto Pipeline con credenziali fornite.

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

Parametri

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

pipelineOptions
StoragePipelineOptions

Opzioni.

Restituisce

Pipeline

Nuovo oggetto Pipeline.