@azure/storage-common package

Classes

AnonymousCredential

AnonymousCredential fournit un membre credentialPolicyCreator utilisé pour créer des objets AnonymousCredentialPolicy. AnonymousCredentialPolicy est utilisé avec des requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).
AnonymousCredentialPolicy

AnonymousCredentialPolicy est utilisé avec des requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).
BaseRequestPolicy

Classe de base à partir de laquelle toutes les stratégies de requête dérivent.
BufferScheduler

Cette classe accepte un Node.js flux lisible comme entrée et continue à lire les données du flux dans la structure de mémoire tampon interne jusqu’à ce qu’elle atteigne maxBuffers. Chaque mémoire tampon disponible tente de déclencher le gestionnaire sortant.

La structure de mémoire tampon interne inclut un tableau de mémoires tampons entrantes et un tableau de mémoires tampons sortantes. Le tableau de mémoires tampons entrantes inclut les mémoires tampons « vides » peuvent être remplies de nouvelles données entrantes. Le tableau sortant inclut les mémoires tampons remplies à gérer par le gestionnaire sortant. Chaque taille de mémoire tampon ci-dessus est définie par bufferSize de paramètres.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS inférieur ou égal à maxBuffers

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

  1. Le flux d’entrée highWaterMark est préférable à définir une même valeur avec le paramètre bufferSize, ce qui évite les opérations Buffer.concat().
  2. concurrency doit définir une valeur inférieure à maxBuffers, ce qui est utile pour réduire la possibilité qu’un gestionnaire sortant attende les données de flux. dans ce cas, les gestionnaires sortants sont bloqués. La file d’attente sortante ne doit pas être vide.
Credential

Les informations d’identification sont une classe abstraite pour la signature des requêtes HTTP stockage Azure. Cette classe hébergera une fabrique CredentialPolicyCreator qui génère CredentialPolicy.
CredentialPolicy

Stratégie d’informations d’identification utilisée pour signer des requêtes HTTP(S) avant l’envoi. Il s’agit d’une classe abstraite.
Readable
StorageBrowserPolicy

StorageBrowserPolicy gère les différences entre Node.js et le runtime du navigateur, notamment :

  1. Les navigateurs mettant en cache les requêtes GET/HEAD en ajoutant des en-têtes conditionnels tels que « IF_MODIFIED_SINCE ». StorageBrowserPolicy est une stratégie utilisée pour ajouter une requête d’horodatage à l’URL de requête GET/HEAD, ce qui évite le cache du navigateur.

  2. Supprimer l’en-tête de cookie pour la sécurité

  3. Supprimer l’en-tête de longueur du contenu pour éviter l’avertissement des navigateurs

En Node.js, cette police est un no-op de passage.
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory est une classe de fabrique qui permet de générer des objets StorageBrowserPolicy.
StorageCRC64Calculator

Classe utilisée pour calculer la somme de contrôle CRC64
StorageRetryPolicy

Stratégie de nouvelle tentative avec nouvelle tentative exponentielle et nouvelle tentative linéaire implémentée.
StorageRetryPolicyFactory

StorageRetryPolicyFactory est une classe de fabrique qui permet de générer des objets StorageRetryPolicy.
StorageSharedKeyCredential

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

StorageSharedKeyCredential pour l’autorisation de clé de compte du service Stockage Azure.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy est une stratégie utilisée pour signer une requête HTTP avec une clé partagée.
UserDelegationKeyCredential

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

UserDelegationKeyCredential est uniquement utilisé pour la génération de SAS de délégation utilisateur.

Voir https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

Interfaces

NodeJSReadableStream

Un Node.js flux lisible qui a également une destroy méthode.
StorageRetryOptions

Interface des options de nouvelle tentative d’objet blob de stockage.
StorageSharedKeyCredentialPolicyOptions

Options utilisées pour configurer StorageSharedKeyCredentialPolicy.
StructuredMessageDecodingStreamOptions

Options utilisées lors de la création de StructuredMessageDecodingStream
StructuredMessageEncodingStreamOptions

Options utilisées lors de la création de StructuredMessageEncodingStream
UserDelegationKey

Une clé de délégation utilisateur.

Alias de type

CredentialPolicyCreator

Fonction de fabrique qui crée une stratégie d’identification qui utilise la stratégie suivante fournie.
OutgoingHandler

OutgoingHandler est une fonction asynchrone déclenchée par BufferScheduler.

Énumérations

StorageRetryPolicyType

RetryPolicy.

Functions

NewRetryPolicyFactory(StorageRetryOptions)

Méthode de fabrique utilisée pour générer une fabrique RetryPolicy.
allocBuffer(number)

Alloue un nouveau tampon à remplissage zéro de la taille donnée.
bufferFromArrayBuffer(ArrayBuffer, number, number)

Crée un tampon à partir d’un ArrayBuffer, avec un décalage et une longueur optionnels.
createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Crée un Blob à partir des données données. Utilise une référence indirecte au constructeur pour contourner les définitions restrictives de type Blob de React Native (qui n’acceptent que la chaîne | Blob, pas ArrayBuffer).
getBufferLength(Buffer)

Retourne la longueur d’octet d’un tampon.
getCachedDefaultHttpClient()
isBuffer(unknown)

Vérifie si une valeur est un Node.js Buffer.
storageBrowserPolicy()

storageBrowserPolicy est une politique utilisée pour empêcher les navigateurs de mettre en cache les requêtes et pour supprimer les cookies et les en-têtes de contenu explicites.

En Node.js, cette police est un no-op de passage.
storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy pour définir correctement l’en-tête Content-Length avec la longueur du corps de la demande.
storageRedirectRangeHeaderPolicy()

StorageRedirectRangeHeaderPolicy
storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy
storageRetryPolicy(StorageRetryOptions)

Stratégie de nouvelle tentative avec nouvelle tentative exponentielle et nouvelle tentative linéaire implémentée.
storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy gère les demandes de signature à l’aide de clés de compte de stockage.
structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Décoder le corps structuré pour la validation de contenu CRC64 en téléchargement en stockage.
structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Décoder le corps structuré pour la validation de contenu CRC64 en téléchargement en stockage.
structuredMessageEncoding(RequestBodyType, number)

Coder un corps structuré pour la validation de contenu CRC64 en téléchargement en stockage.

Variables

StorageResponseFormat

Spécifie le format que le service doit utiliser pour retourner les résultats de la liste.
storageBrowserPolicyName

L’identifiant programmatique de la StorageBrowserPolicy.
storageCorrectContentLengthPolicyName

L’identifiant programmatique de la PolicyStorageCorrectContentLengthPolicy.
storageRedirectRangeHeaderPolicyName

Redirige l’en-tête « range » vers « x-ms-range » pour les requêtes stockage Azure, car ce dernier est préféré.
storageRequestFailureDetailsParserPolicyName

L’identifiant programmatique de la PolicyStorageRequestFailureDetailsParserPolicy.
storageRetryPolicyName

Nom de la Politique storageRetryPolicy
storageSharedKeyCredentialPolicyName

L’identifiant programmatique de la PolicyStorageSharedKeyCredentialPolicy.

Informations relatives à la fonction

NewRetryPolicyFactory(StorageRetryOptions)

Méthode de fabrique utilisée pour générer une fabrique RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Paramètres

retryOptions
StorageRetryOptions

Retours

RequestPolicyFactory

allocBuffer(number)

Alloue un nouveau tampon à remplissage zéro de la taille donnée.

function allocBuffer(size: number): NodeBuffer

Paramètres

size

number

Retours

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Crée un tampon à partir d’un ArrayBuffer, avec un décalage et une longueur optionnels.

function bufferFromArrayBuffer(ab: ArrayBuffer, byteOffset?: number, length?: number): NodeBuffer

Paramètres

ab

ArrayBuffer

byteOffset

number

length

number

Retours

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Crée un Blob à partir des données données. Utilise une référence indirecte au constructeur pour contourner les définitions restrictives de type Blob de React Native (qui n’acceptent que la chaîne | Blob, pas ArrayBuffer).

function createBlobFromData(data: Blob | ArrayBuffer | ArrayBufferView): Blob

Paramètres

data

Blob | ArrayBuffer | ArrayBufferView

Retours

Blob

getBufferLength(Buffer)

Retourne la longueur d’octet d’un tampon.

function getBufferLength(buffer: Buffer): number

Paramètres

buffer

Buffer

Retours

number

getCachedDefaultHttpClient() 

function getCachedDefaultHttpClient(): HttpClient

Retours

HttpClient

isBuffer(unknown)

Vérifie si une valeur est un Node.js Buffer.

function isBuffer(value: unknown): value

Paramètres

value

unknown

Retours

value

storageBrowserPolicy()

storageBrowserPolicy est une politique utilisée pour empêcher les navigateurs de mettre en cache les requêtes et pour supprimer les cookies et les en-têtes de contenu explicites.

En Node.js, cette police est un no-op de passage.

function storageBrowserPolicy(): PipelinePolicy

Retours

PipelinePolicy

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy pour définir correctement l’en-tête Content-Length avec la longueur du corps de la demande.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Retours

PipelinePolicy

storageRedirectRangeHeaderPolicy()

StorageRedirectRangeHeaderPolicy

function storageRedirectRangeHeaderPolicy(): PipelinePolicy

Retours

PipelinePolicy

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Retours

PipelinePolicy

storageRetryPolicy(StorageRetryOptions)

Stratégie de nouvelle tentative avec nouvelle tentative exponentielle et nouvelle tentative linéaire implémentée.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Paramètres

options
StorageRetryOptions

Retours

PipelinePolicy

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy gère les demandes de signature à l’aide de clés de compte de stockage.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Paramètres

options
StorageSharedKeyCredentialPolicyOptions

Retours

PipelinePolicy

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Décoder le corps structuré pour la validation de contenu CRC64 en téléchargement en stockage.

function structuredMessageDecodingBrowser(source: Blob | ReadableStream<Uint8Array>): Promise<Blob>

Paramètres

source

Blob | ReadableStream<Uint8Array>

Retours

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Décoder le corps structuré pour la validation de contenu CRC64 en téléchargement en stockage.

function structuredMessageDecodingStream(source: ReadableStream, options: StructuredMessageDecodingStreamOptions): NodeJS.ReadableStream

Paramètres

source

ReadableStream

options
StructuredMessageDecodingStreamOptions

Retours

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Coder un corps structuré pour la validation de contenu CRC64 en téléchargement en stockage.

function structuredMessageEncoding(source: RequestBodyType, contentLength: number): Promise<{ body: HttpRequestBody, encodedContentLength: number }>

Paramètres

source
RequestBodyType
contentLength

number

Retours

Promise<{ body: HttpRequestBody, encodedContentLength: number }>

Détails de variable

StorageResponseFormat

Spécifie le format que le service doit utiliser pour retourner les résultats de la liste.

StorageResponseFormat: { Arrow: "Arrow", Auto: "Auto", Xml: "Xml" }

Type

{ Arrow: "Arrow", Auto: "Auto", Xml: "Xml" }

storageBrowserPolicyName

L’identifiant programmatique de la StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Type

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

L’identifiant programmatique de la PolicyStorageCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Type

"StorageCorrectContentLengthPolicy"

storageRedirectRangeHeaderPolicyName

Redirige l’en-tête « range » vers « x-ms-range » pour les requêtes stockage Azure, car ce dernier est préféré.

storageRedirectRangeHeaderPolicyName: "storageRedirectRangeHeaderPolicy"

Type

"storageRedirectRangeHeaderPolicy"

storageRequestFailureDetailsParserPolicyName

L’identifiant programmatique de la PolicyStorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Type

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Nom de la Politique storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Type

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

L’identifiant programmatique de la PolicyStorageSharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Type

"storageSharedKeyCredentialPolicy"