@azure/storage-queue package

Classi

AccountSASPermissions

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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. Dopo aver impostato tutti i valori, questa operazione deve essere serializzata con toString e impostata come campo autorizzazioni in un oggetto AccountSASSignatureValues . È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è specifico e questa classe garantisce la correttezza.

AccountSASResourceTypes

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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 concederà l'accesso a tale tipo di risorsa. Dopo aver impostato tutti i valori, questa operazione deve essere serializzata con toString e impostata come campo risorse in un oggetto AccountSASSignatureValues . È possibile costruire la stringa di risorse senza questa classe, ma l'ordine delle risorse è specifico e questa classe garantisce la correttezza.

AccountSASServices

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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 concederà l'accesso a tale servizio. Dopo aver impostato tutti i valori, questa operazione deve essere serializzata con toString e impostata come campo dei servizi in un oggetto AccountSASSignatureValues . È possibile costruire la stringa dei servizi senza questa classe, ma l'ordine dei servizi è specifico e questa classe garantisce la correttezza.

AnonymousCredential

AnonymousCredential fornisce un membro credentialPolicyCreator usato per creare oggetti AnonymousCredentialPolicy. AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggeno le risorse pubbliche o per l'uso con firme di accesso condiviso (SAS).

AnonymousCredentialPolicy

AnonymousCredentialPolicy viene usato con richieste HTTP(S) che leggeno le risorse pubbliche o per l'uso con firme di accesso condiviso (SAS).

BaseRequestPolicy

Classe di base da cui derivano tutti i criteri di richiesta.

Credential

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

CredentialPolicy

Criteri delle credenziali usati per firmare le richieste HTTP(S) prima dell'invio. Questa è una classe abstract.

Pipeline

Classe Pipeline contenente i criteri di richiesta HTTP. È possibile creare una pipeline predefinita chiamando newPipeline. In alternativa, è possibile creare una pipeline con i propri criteri dal costruttore di Pipeline.

Fare riferimento ai criteri newPipeline e forniti prima di implementare la pipeline personalizzata.

QueueClient

QueueClient rappresenta un URL per i messaggi della coda di archiviazione di Azure che consentono di modificare i messaggi.

QueueSASPermissions

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Si tratta di una classe helper per costruire una stringa che rappresenta le autorizzazioni concesse da un 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, questa operazione deve essere serializzata con toString e impostata come campo autorizzazioni in un oggetto QueueSASSignatureValues . È possibile costruire la stringa di autorizzazioni senza questa classe, ma l'ordine delle autorizzazioni è specifico e questa classe garantisce la correttezza.

QueueServiceClient

QueueServiceClient rappresenta un URL per il servizio Coda di archiviazione di Azure che consente di modificare le code.

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

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 AccountSASSignatureValues e QueueSASSignatureValues . Dopo aver generato, può essere codificato in un URL e accodato direttamente a un toString() URL (anche se è consigliabile prendere attenzione in questo caso, in caso di parametri di query esistenti, che potrebbero influire sui mezzi appropriati di accodamento di questi parametri di query).

NOTA: le istanze di questa classe non sono modificabili.

StorageBrowserPolicy

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

  1. I browser memorizzano nella cache le richieste GET/HEAD aggiungendo intestazioni condizionali, ad esempio 'IF_MODIFIED_SINCE'. StorageBrowserPolicy è un criterio usato per aggiungere una query timestamp all'URL della richiesta GET/HEAD, quindi evitare la cache del browser.

  2. Rimuovere l'intestazione del cookie per la sicurezza

  3. Rimuovere l'intestazione della lunghezza del contenuto per evitare l'avviso dei browser

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory è una classe factory che consente di generare oggetti StorageBrowserPolicy.

StorageRetryPolicy

Criteri di ripetizione dei tentativi con tentativi esponenziali e tentativi lineari implementati.

StorageRetryPolicyFactory

StorageRetryPolicyFactory è una classe factory che consente di generare oggetti StorageRetryPolicy .

StorageSharedKeyCredential

DISPONIBILE SOLO IN RUNTIME NODE.JS.

StorageSharedKeyCredential per l'autorizzazione della chiave dell'account del servizio archiviazione di Azure.

StorageSharedKeyCredentialPolicy

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

Interfacce

AccessPolicy

Criteri di accesso

AccountSASSignatureValues

DISPONIBILE SOLO IN RUNTIME NODE.JS.

AccountSASSignatureValues viene usato per generare una firma di accesso condiviso per un account di archiviazione di Azure. Dopo aver impostato in modo appropriato tutti i valori, chiamare generateSASQueryParameters() per ottenere una rappresentazione della firma di accesso condiviso che può effettivamente essere applicata agli URL della coda. Si noti che sia questa classe che SASQueryParameters esistono perché la precedente è modificabile e una rappresentazione logica mentre quest'ultima è immutabile e usata per generare richieste REST effettive.

Per altre informazioni concettuali sulla firma di accesso condiviso, vedere https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas per le descrizioni dei parametri, inclusi quelli necessari

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 origine stessa che impedisce 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 in una coda

GeoReplication

Geo-Replication informazioni per il servizio di archiviazione secondario

HttpHeaders

Raccolta di coppie chiave/valore dell'intestazione HTTP.

HttpOperationResponse

Risposta Http compatibile con core-v1(core-http).

HttpResponse

Rappresentazione di una risposta HTTP che include un riferimento alla richiesta che l'ha generata.

IHttpClient

Interfaccia compatibile per i criteri di richiesta core-http

ListQueuesSegmentResponse

L'oggetto restituito quando si chiamaNo code elenco in un servizio code.

Logging

Impostazioni di registrazione di Analisi di Azure.

MessageIdDeleteHeaders

Definisce le intestazioni per l'operazione di MessageId_delete.

MessageIdUpdateHeaders

Definisce le intestazioni per l'operazione di MessageId_update.

MessagesClearHeaders

Definisce le intestazioni per l'operazione di Messages_clear.

MessagesDequeueHeaders

Definisce le intestazioni per l'operazione di Messages_dequeue.

MessagesDequeueOptionalParams

Parametri facoltativi.

MessagesEnqueueHeaders

Definisce le intestazioni per l'operazione di Messages_enqueue.

MessagesEnqueueOptionalParams

Parametri facoltativi.

MessagesPeekHeaders

Definisce le intestazioni per l'operazione di Messages_peek.

MessagesPeekOptionalParams

Parametri facoltativi.

Metadata

Raccolta di coppie di stringhe chiave-valore.

Metrics

Interfaccia che rappresenta metriche.

PeekedMessageItem

Oggetto restituito nella matrice QueueMessageList quando si chiamaNo Messaggi peek in una coda

PipelineLike

Interfaccia per la classe Pipeline contenente i criteri di richiesta HTTP. È possibile creare una pipeline predefinita chiamando newPipeline. In alternativa, è possibile creare una pipeline con i propri criteri dal costruttore di Pipeline.

Fare riferimento ai criteri newPipeline e forniti prima di implementare la pipeline personalizzata.

PipelineOptions

Interfaccia di opzione per il costruttore pipeline.

QueueClearMessagesOptions

Opzioni per configurare l'operazione clearMessages

QueueCreateHeaders

Definisce le intestazioni per l'operazione di Queue_create.

QueueCreateIfNotExistsResponse

Contiene i dati di risposta per l'operazione createIfNotExists .

QueueCreateOptions

Opzioni per configurare l'operazione di creazione

QueueDeleteHeaders

Definisce le intestazioni per l'operazione di Queue_delete.

QueueDeleteIfExistsResponse

Contiene i dati di risposta per l'operazione deleteIfExists .

QueueDeleteMessageOptions

Opzioni per configurare l'operazione deleteMessage

QueueDeleteOptions

Opzioni per configurare l'operazione di eliminazione

QueueExistsOptions

Opzioni per configurare esiste un'operazione

QueueGenerateSasUrlOptions

Opzioni per configurare l'operazione generateSasUrl .

QueueGetAccessPolicyHeaders

Definisce le intestazioni per l'operazione di Queue_getAccessPolicy.

QueueGetAccessPolicyOptions

Opzioni per configurare l'operazione getAccessPolicy

QueueGetPropertiesHeaders

Definisce le intestazioni per l'operazione di Queue_getProperties.

QueueGetPropertiesOptions

Opzioni per configurare l'operazione getProperties

QueueItem

Coda di archiviazione di Azure.

QueuePeekMessagesOptions

Opzioni per configurare l'operazione peekMessages

QueueReceiveMessageOptions

Opzioni per configurare l'operazione receiveMessages

QueueSASSignatureValues

DISPONIBILE SOLO IN RUNTIME NODE.JS.

QueueSASSignatureValues viene usato per generare token sas del servizio code per le code.

QueueSendMessageOptions

Opzioni per configurare l'operazione 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 setAccessPolicy

QueueSetMetadataHeaders

Definisce le intestazioni per l'operazione di Queue_setMetadata.

QueueSetMetadataOptions

Opzioni per configurare l'operazione setMetadata

QueueUpdateMessageOptions

Opzioni per configurare l'operazione updateMessage

RequestPolicyFactory

Interfaccia per la compatibilità con RequestPolicyFactory di core-http

RequestPolicyOptions

Interfaccia per la compatibilità con RequestPolicy

ResponseLike

Oggetto con una semplice proprietà _response.

ResponseWithBody

Oggetto con una proprietà _response con corpo e intestazioni già analizzate in tipi noti.

ResponseWithHeaders

Oggetto con una proprietà _response con intestazioni già analizzate in un oggetto tipizzato.

RetentionPolicy

criteri di conservazione

SasIPRange

Intervallo IP consentito per una firma di accesso condiviso.

ServiceClientOptions

Subset di @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

Opzioni per configurare l'operazione generateAccountSasUrl .

ServiceGetPropertiesHeaders

Definisce le intestazioni per l'operazione di Service_getProperties.

ServiceGetPropertiesOptions

Opzioni per configurare l'operazione getProperties

ServiceGetStatisticsHeaders

Definisce le intestazioni per l'operazione di Service_getStatistics.

ServiceGetStatisticsOptions

Opzioni per configurare l'operazione getStatistics

ServiceListQueuesOptions

Opzioni per configurare l'operazione listQueues

ServiceListQueuesSegmentHeaders

Definisce le intestazioni per l'operazione di Service_listQueuesSegment.

ServiceSetPropertiesHeaders

Definisce le intestazioni per l'operazione di Service_setProperties.

ServiceSetPropertiesOptions

Opzioni per configurare l'operazione setProperties

SignedIdentifier

Identificatore firmato.

SignedIdentifierModel

identificatore firmato

StoragePipelineOptions

Interfaccia opzioni per la funzione newPipeline .

StorageRetryOptions

Interfaccia delle opzioni di ripetizione dei tentativi BLOB di archiviazione.

WebResource

Descrizione di una richiesta HTTP da effettuare a un server remoto.

Alias tipo

CredentialPolicyCreator

Funzione factory che crea una nuova CredentialPolicy che usa l'oggetto nextPolicy specificato.

GeoReplicationStatusType

Definisce i valori per GeoReplicationStatusType.

HttpRequestBody

Tipi di corpi supportati nella richiesta. NodeJS.ReadableStream e () => NodeJS.ReadableStream è solo Node. BLOB, ReadableStream e () => ReadableStream sono solo browser.

ListQueuesIncludeType

Definisce i valori per ListQueuesIncludeType. I valori possibili includono: 'metadati'

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 cancellata.

QueueClearMessagesResponse

Contiene i dati di risposta per l'operazione clearMessages .

QueueCreateResponse

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

QueueDeleteMessageResponse

Contiene i dati di risposta per l'operazione deleteMessage .

QueueDeleteResponse

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

QueueGetAccessPolicyResponse

Contiene i dati di risposta per l'operazione getAccessPolicy .

QueueGetPropertiesResponse

Contiene i dati di risposta per l'operazione getProperties.

QueuePeekMessagesResponse

Contiene i dati di risposta per l'operazione peekMessages .

QueueReceiveMessageResponse

Contiene i dati di risposta per l'operazione receiveMessages .

QueueSendMessageResponse

Contiene i dati di risposta per l'operazione 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 updateMessage .

ReceivedMessageItem

Oggetto restituito nella matrice durante la receivedMessageItems chiamata aMessages.

Vedere: 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.

WithResponse

Tipo che rappresenta un risultato dell'operazione con una proprietà _response nota.

Enumerazioni

SASProtocol

Protocolli per la firma di accesso condiviso generato.

StorageQueueAudience

Definisce i destinatari cloud noti per l'archiviazione.

StorageRetryPolicyType

Tipi RetryPolicy.

Funzioni

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Genera un oggetto SASQueryParameters che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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, avvioOn e identificatore.

AVVISO: quando l'identificatore non è specificato, sono necessarie le autorizzazioni e la scadenzaOn. È NECESSARIO assegnare il valore all'identificatore o alla scadenzaOn & autorizzazioni manualmente se si inizializza con questo costruttore.

getQueueServiceAccountAudience(string)

Per ottenere un gruppo di destinatari OAuth per un account di archiviazione per il servizio code.

isPipelineLike(unknown)

Helper per decidere se un determinato argomento soddisfa il contratto pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuovo oggetto Pipeline con credenziali fornite.

Dettagli funzione

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Genera un oggetto SASQueryParameters che contiene tutti i parametri di query sas necessari per effettuare una richiesta REST effettiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parametri

accountSASSignatureValues
AccountSASSignatureValues

Valori di firma di firma di accesso condiviso dell'account

sharedKeyCredential
StorageSharedKeyCredential

Credenziali delle chiavi condivise.

Restituisce

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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, avvioOn e identificatore.

AVVISO: quando l'identificatore non è specificato, sono necessarie le autorizzazioni e la scadenzaOn. È NECESSARIO assegnare il valore all'identificatore o alla scadenzaOn & autorizzazioni manualmente se si inizializza con questo costruttore.

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

Parametri

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Restituisce

getQueueServiceAccountAudience(string)

Per ottenere un gruppo di destinatari OAuth per un account di archiviazione per il servizio code.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parametri

storageAccountName

string

Restituisce

string

isPipelineLike(unknown)

Helper per decidere se un determinato argomento soddisfa il contratto pipeline

function isPipelineLike(pipeline: unknown): pipeline

Parametri

pipeline

unknown

Argomento che può essere una pipeline

Restituisce

pipeline

true quando l'argomento soddisfa il contratto pipeline

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuovo oggetto Pipeline con credenziali fornite.

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

Parametri

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

facoltativo. Opzioni.

Restituisce

Nuovo oggetto Pipeline.