@azure/storage-common package

Klassen

AnonymousCredential

AnonymousCredential stellt ein credentialPolicyCreator-Mitglied bereit, das zum Erstellen von AnonymousCredentialPolicy-Objekten verwendet wird. AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen oder für die Verwendung mit Shared Access Signatures (SAS) verwenden.

AnonymousCredentialPolicy

AnonymousCredentialPolicy wird mit HTTP(S)-Anforderungen verwendet, die öffentliche Ressourcen lesen oder für die Verwendung mit Shared Access Signatures (SAS) verwenden.

BaseRequestPolicy

Die Basisklasse, von der alle Anforderungsrichtlinien abgeleitet werden.

BufferScheduler

Diese Klasse akzeptiert einen Node.js lesbaren Datenstrom als Eingabe und liest Daten aus dem Datenstrom in der internen Pufferstruktur, bis sie maxBuffers erreicht. Jeder verfügbare Puffer versucht, ausgehenden Handler auszulösen.

Die interne Pufferstruktur enthält ein eingehendes Pufferarray und ein ausgehendes Pufferarray. Das Array des eingehenden Puffers enthält die "leeren" Puffer, die mit neuen eingehenden Daten gefüllt werden können. Das ausgehende Array enthält die gefüllten Puffer, die von outgoingHandler behandelt werden sollen. Jede oben genannte Puffergröße wird durch ParameterpufferSize definiert.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS kleiner oder gleich maxBuffers

TIPPS ZUR LEISTUNGSVERBESSERUNG:

  1. Für den Eingabestream highWaterMark ist es besser, den gleichen Wert mit dem bufferSize-Parameter festzulegen, wodurch Buffer.concat()-Operationen vermieden werden.
  2. concurrency sollte einen kleineren Wert als maxBuffers festlegen, was hilfreich ist, um die Wahrscheinlichkeit zu verringern, dass ein ausgehender Handler auf die Streamdaten wartet. in diesem Fall werden ausgehende Handler blockiert. Die ausgehende Warteschlange sollte nicht leer sein.
Credential

Anmeldeinformationen sind eine abstrakte Klasse für die Signierung von Azure Storage-HTTP-Anforderungen. Diese Klasse hostt eine credentialPolicyCreator-Factory, die CredentialPolicy generiert.

CredentialPolicy

Anmeldeinformationsrichtlinie zum Signieren von HTTP(S)-Anforderungen vor dem Senden. Dies ist eine abstrakte Klasse.

Readable
StorageBrowserPolicy

StorageBrowserPolicy behandelt Unterschiede zwischen Node.js und Browserlaufzeit, einschließlich:

  1. Browser speichern GET/HEAD-Anforderungen zwischen, indem Sie bedingte Header wie "IF_MODIFIED_SINCE" hinzufügen. StorageBrowserPolicy ist eine Richtlinie, die verwendet wird, um eine Zeitstempelabfrage zur GET/HEAD-Anforderungs-URL hinzuzufügen, wodurch der Browsercache vermieden wird.

  2. Entfernen des Cookieheaders zur Sicherheit

  3. Entfernen des Headers mit Inhaltslänge, um Browserwarnungen zu vermeiden

In Node.jsist diese Police ein no-op Pass-through.

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory ist eine Factoryklasse, die das Generieren von StorageBrowserPolicy-Objekten unterstützt.

StorageCRC64Calculator

Klasse, die zur Berechnung der CRC64-Prüfsumme verwendet wird

StorageRetryPolicy

Wiederholungsrichtlinie mit exponentieller Wiederholung und linearer Wiederholung implementiert.

StorageRetryPolicyFactory

StorageRetryPolicyFactory ist eine Factoryklasse, die StorageRetryPolicy--Objekte generiert.

StorageSharedKeyCredential

NUR IN NODE.JS RUNTIME VERFÜGBAR.

StorageSharedKeyCredential für die Kontoschlüsselautorisierung des Azure Storage-Diensts.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy ist eine Richtlinie, die zum Signieren einer HTTP-Anforderung mit einem freigegebenen Schlüssel verwendet wird.

UserDelegationKeyCredential

NUR IN NODE.JS RUNTIME VERFÜGBAR.

UserDelegationKeyCredential wird nur zur Erstellung von Benutzerdelegierungs-SAS verwendet.

Siehe https://dotnet.territoriali.olinfo.it/rest/api/storageservices/create-user-delegation-sas

Schnittstellen

NodeJSReadableStream

Ein Node.js lesbarer Datenstrom, der auch über eine destroy Methode verfügt.

StorageRetryOptions

Speicher-BLOB-Wiederholungsoptionenschnittstelle.

StorageSharedKeyCredentialPolicyOptions

Optionen zum Konfigurieren von StorageSharedKeyCredentialPolicy.

StructuredMessageDecodingStreamOptions

Optionen beim Erstellen von StructuredMessageDecodingStream

StructuredMessageEncodingStreamOptions

Optionen beim Erstellen von StructuredMessageEncodingStream

UserDelegationKey

Ein Benutzerdelegierungsschlüssel.

Typaliase

CredentialPolicyCreator

Eine Factoryfunktion, die eine neue CredentialPolicy erstellt, die die bereitgestellte nextPolicy verwendet.

OutgoingHandler

OutgoingHandler ist eine asynchrone Funktion, die von BufferScheduler ausgelöst wird.

Enumerationen

StorageRetryPolicyType

RetryPolicy-Typen.

Functions

NewRetryPolicyFactory(StorageRetryOptions)

Eine Factorymethode, die zum Generieren einer RetryPolicy-Factory verwendet wird.

allocBuffer(number)

Weist einen neuen, nullgefüllten Puffer der gegebenen Größe zu.

bufferFromArrayBuffer(ArrayBuffer, number, number)

Erstellt einen Buffer aus einem ArrayBuffer mit optionalem Offset und Länge.

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Erstellt einen Blob aus den gegebenen Daten. Verwendet eine indirekte Konstruktorreferenz, um die restriktive Blob-Typdefinitionen von React Native zu umgehen (die nur Strings | akzeptieren) Blob, nicht ArrayBuffer).

getBufferLength(Buffer)

Gibt die Bytelänge eines Puffers zurück.

getCachedDefaultHttpClient()
isBuffer(unknown)

Prüft, ob ein Wert ein Node.js Buffer ist.

storageBrowserPolicy()

storageBrowserPolicy ist eine Richtlinie, die verwendet wird, um zu verhindern, dass Browser Anforderungen zwischenspeichern, und um Cookies und explizite Header mit Inhaltslänge zu entfernen.

In Node.jsist diese Police ein no-op Pass-through.

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy, um den Content-Length-Header korrekt mit der Länge des Anforderungstexts festzulegen.

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

storageRetryPolicy(StorageRetryOptions)

Wiederholungsrichtlinie mit exponentieller Wiederholung und linearer Wiederholung implementiert.

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy verarbeitet Signaturanforderungen mithilfe von Speicherkontoschlüsseln.

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Zur Entschlüsselung eines strukturierten Körpers für die CRC64-Inhaltsvalidierung beim Herunterladen von Speicher.

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Zur Entschlüsselung eines strukturierten Körpers für die CRC64-Inhaltsvalidierung beim Herunterladen von Speicher.

structuredMessageEncoding(RequestBodyType, number)

Zur Kodierung eines strukturierten Körpers für die CRC64-Inhaltsvalidierung im Speicherupload.

Variablen

storageBrowserPolicyName

Die programmatische Kennung der StorageBrowserPolicy.

storageCorrectContentLengthPolicyName

Die programmatische Kennung der storageCorrectContentLengthPolicy.

storageRequestFailureDetailsParserPolicyName

Die programmatische Kennung der StorageRequestFailureDetailsParserPolicy.

storageRetryPolicyName

Name des storageRetryPolicy

storageSharedKeyCredentialPolicyName

Die programmatische Identifikatorin der storageSharedKeyCredentialPolicy.

Details zur Funktion

NewRetryPolicyFactory(StorageRetryOptions)

Eine Factorymethode, die zum Generieren einer RetryPolicy-Factory verwendet wird.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Parameter

retryOptions
StorageRetryOptions

Gibt zurück

allocBuffer(number)

Weist einen neuen, nullgefüllten Puffer der gegebenen Größe zu.

function allocBuffer(size: number): NodeBuffer

Parameter

size

number

Gibt zurück

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Erstellt einen Buffer aus einem ArrayBuffer mit optionalem Offset und Länge.

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

Parameter

ab

ArrayBuffer

byteOffset

number

length

number

Gibt zurück

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Erstellt einen Blob aus den gegebenen Daten. Verwendet eine indirekte Konstruktorreferenz, um die restriktive Blob-Typdefinitionen von React Native zu umgehen (die nur Strings | akzeptieren) Blob, nicht ArrayBuffer).

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

Parameter

data

Blob | ArrayBuffer | ArrayBufferView

Gibt zurück

Blob

getBufferLength(Buffer)

Gibt die Bytelänge eines Puffers zurück.

function getBufferLength(buffer: Buffer): number

Parameter

buffer

Buffer

Gibt zurück

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

Gibt zurück

isBuffer(unknown)

Prüft, ob ein Wert ein Node.js Buffer ist.

function isBuffer(value: unknown): value

Parameter

value

unknown

Gibt zurück

value

storageBrowserPolicy()

storageBrowserPolicy ist eine Richtlinie, die verwendet wird, um zu verhindern, dass Browser Anforderungen zwischenspeichern, und um Cookies und explizite Header mit Inhaltslänge zu entfernen.

In Node.jsist diese Police ein no-op Pass-through.

function storageBrowserPolicy(): PipelinePolicy

Gibt zurück

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy, um den Content-Length-Header korrekt mit der Länge des Anforderungstexts festzulegen.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Gibt zurück

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Gibt zurück

storageRetryPolicy(StorageRetryOptions)

Wiederholungsrichtlinie mit exponentieller Wiederholung und linearer Wiederholung implementiert.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Parameter

Gibt zurück

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy verarbeitet Signaturanforderungen mithilfe von Speicherkontoschlüsseln.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Parameter

Gibt zurück

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Zur Entschlüsselung eines strukturierten Körpers für die CRC64-Inhaltsvalidierung beim Herunterladen von Speicher.

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

Parameter

source

Blob | ReadableStream<Uint8Array>

Gibt zurück

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Zur Entschlüsselung eines strukturierten Körpers für die CRC64-Inhaltsvalidierung beim Herunterladen von Speicher.

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

Parameter

source

ReadableStream

Gibt zurück

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Zur Kodierung eines strukturierten Körpers für die CRC64-Inhaltsvalidierung im Speicherupload.

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

Parameter

contentLength

number

Gibt zurück

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

Details zu Variablen

storageBrowserPolicyName

Die programmatische Kennung der StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Typ

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

Die programmatische Kennung der storageCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Typ

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

Die programmatische Kennung der StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Typ

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Name des storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Typ

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

Die programmatische Identifikatorin der storageSharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Typ

"storageSharedKeyCredentialPolicy"