@azure/storage-common package

Klasy

AnonymousCredential	Funkcja AnonymousCredential udostępnia element członkowski credentialPolicyCreator używany do tworzenia obiektów AnonymousCredentialPolicy. Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
AnonymousCredentialPolicy	Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
BaseRequestPolicy	Klasa bazowa, z której pochodzą wszystkie zasady żądań.
BufferScheduler	Ta klasa akceptuje strumień z możliwością odczytu Node.js jako dane wejściowe i odczytuje dane ze strumienia do wewnętrznej struktury buforu, dopóki nie osiągnie wartości maxBuffers. Każdy dostępny bufor spróbuje wyzwolić wychodzącą procedurę obsługi. Wewnętrzna struktura buforu zawiera tablicę buforu przychodzącego i macierz buforu wychodzącego. Tablica przychodzących zawiera "puste" mogą być wypełnione nowymi danymi przychodzącymi. Tablica wychodząca zawiera wypełnione, które mają być obsługiwane przez program outgoingHandler. Każdy powyższy rozmiar buforu jest definiowany przez parametr bufferSize. NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING NUM_OF_ALL_BUFFERS mniejsza lub równa maxBuffers PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI: Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat(). współbieżność powinna ustawiać mniejszą wartość niż maxBuffers, co jest przydatne w celu zmniejszenia możliwości, gdy wychodząca procedura obsługi czeka na dane strumienia. w takiej sytuacji programy obsługi wychodzącej są blokowane. Kolejka wychodząca nie powinna być pusta.
Credential	Credential to abstrakcyjna klasa podpisywania żądań HTTP usługi Azure Storage. Ta klasa będzie hostować fabrykę credentialPolicyCreator, która generuje element CredentialPolicy.
CredentialPolicy	Zasady poświadczeń używane do podpisywania żądań HTTP(S) przed wysłaniem. Jest to abstrakcyjna klasa.
Readable
StorageBrowserPolicy	StorageBrowserPolicy będzie obsługiwać różnice między Node.js a środowiskiem uruchomieniowym przeglądarki, w tym: Przeglądarki buforuje żądania GET/HEAD, dodając nagłówki warunkowe, takie jak "IF_MODIFIED_SINCE". StorageBrowserPolicy to zasady służące do dodawania zapytania sygnatury czasowej do adresu URL żądania GET/HEAD, co pozwala uniknąć pamięci podręcznej przeglądarki. Usuń nagłówek pliku cookie na potrzeby zabezpieczeń Usuń nagłówek o długości zawartości, aby uniknąć ostrzeżenia przeglądarki W Node.jsta polityka jest no-op pass-through.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageBrowserPolicy.
StorageCRC64Calculator	Klasa używana do kalkulatora sumy kontrolnej CRC64
StorageRetryPolicy	Zasady ponawiania próby z implementacją ponawiania wykładniczego i ponawiania liniowego.
StorageRetryPolicyFactory	StorageRetryPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageRetryPolicy.
StorageSharedKeyCredential	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. StorageSharedKeyCredential na potrzeby autoryzacji klucza konta usługi Azure Storage.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy to zasady używane do podpisywania żądania HTTP przy użyciu klucza współużytkowanego.
UserDelegationKeyCredential	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. UserDelegationKeyCredential jest używany wyłącznie do generowania SAS delegacji użytkownika. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

Interfejsy

NodeJSReadableStream	Strumień z możliwością odczytu Node.js, który ma również metodę destroy .
StorageRetryOptions	Interfejs opcji ponawiania prób obiektu blob usługi Storage.
StorageSharedKeyCredentialPolicyOptions	Opcje używane do konfigurowania StorageSharedKeyCredentialPolicy.
StructuredMessageDecodingStreamOptions	Opcje używane przy tworzeniu StructuredMessageDecodingStream
StructuredMessageEncodingStreamOptions	Opcje używane przy tworzeniu StructuredMessageEncodingStream
UserDelegationKey	Klucz delegacji użytkownika.

Aliasy typu

CredentialPolicyCreator	Funkcja fabryki, która tworzy nową funkcję CredentialPolicy, która używa podanej metody NextPolicy.
OutgoingHandler	OutgoingHandler to funkcja asynchronizna wyzwalana przez bufferScheduler.

Wyliczenia

StorageRetryPolicyType

Ponów typy zasad.

Funkcje

NewRetryPolicyFactory(StorageRetryOptions)	Metoda fabryki używana do generowania fabryki RetryPolicy.
allocBuffer(number)	Przydziela nowy bufor wypełniony zerem o danej wielkości.
bufferFromArrayBuffer(ArrayBuffer, number, number)	Tworzy Bufor z ArrayBuffer, z opcjonalnym przesunięciem i długością.
createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)	Tworzy Blob z danych danych. Wykorzystuje pośrednie odniesienie konstruktora, aby obejść restrykcyjne definicje typów Blob w React Native (które akceptują tylko ciąg | Blob, nie ArrayBuffer).
getBufferLength(Buffer)	Zwraca długość bajtu bufora.
getCachedDefaultHttpClient()
isBuffer(unknown)	Sprawdza, czy dana wartość jest buforem Node.js.
storageBrowserPolicy()	storageBrowserPolicy to zasada używana do zapobiegania buforowaniu żądań przez przeglądarki oraz do usuwania plików cookie i jawnych nagłówków o długości zawartości. W Node.jsta polityka jest no-op pass-through.
storageCorrectContentLengthPolicy()	storageCorrectContentLengthPolicy, aby poprawnie ustawić nagłówek Content-Length z długością treści żądania.
storageRequestFailureDetailsParserPolicy()	StorageRequestFailureDetailsParserPolicy
storageRetryPolicy(StorageRetryOptions)	Zasady ponawiania próby z implementacją ponawiania wykładniczego i ponawiania liniowego.
storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)	storageSharedKeyCredentialPolicy obsługuje żądania podpisywania przy użyciu kluczy konta magazynu.
structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)	Aby rozszyfrować strukturyzowany treść do walidacji treści CRC64 podczas pobierania pamięci.
structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)	Aby rozszyfrować strukturyzowany treść do walidacji treści CRC64 podczas pobierania pamięci.
structuredMessageEncoding(RequestBodyType, number)	Aby zakodować strukturyzowany korpus treści do walidacji treści CRC64 podczas przesyłania do pamięci masowej.

Zmienne

storageBrowserPolicyName	Programowy identyfikator StorageBrowserPolicy.
storageCorrectContentLengthPolicyName	Programowy identyfikator storageCorrectContentLengthPolicy.
storageRequestFailureDetailsParserPolicyName	Programowy identyfikator StorageRequestFailureDetailsParserPolicy.
storageRetryPolicyName	Nazwa storageRetryPolicy
storageSharedKeyCredentialPolicyName	Programowy identyfikator polityki storageSharedKeyCredentialPolicy.

Szczegóły funkcji

NewRetryPolicyFactory(StorageRetryOptions)

Metoda fabryki używana do generowania fabryki RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Parametry

retryOptions

StorageRetryOptions

Zwraca

RequestPolicyFactory

allocBuffer(number)

Przydziela nowy bufor wypełniony zerem o danej wielkości.

function allocBuffer(size: number): NodeBuffer

Parametry

size

number

Zwraca

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Tworzy Bufor z ArrayBuffer, z opcjonalnym przesunięciem i długością.

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

Parametry

ab

ArrayBuffer

byteOffset

number

length

number

Zwraca

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Tworzy Blob z danych danych. Wykorzystuje pośrednie odniesienie konstruktora, aby obejść restrykcyjne definicje typów Blob w React Native (które akceptują tylko ciąg | Blob, nie ArrayBuffer).

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

Parametry

data

Blob | ArrayBuffer | ArrayBufferView

Zwraca

Blob

getBufferLength(Buffer)

Zwraca długość bajtu bufora.

function getBufferLength(buffer: Buffer): number

Parametry

buffer

Buffer

Zwraca

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

Zwraca

HttpClient

isBuffer(unknown)

Sprawdza, czy dana wartość jest buforem Node.js.

function isBuffer(value: unknown): value

Parametry

value

unknown

Zwraca

value

storageBrowserPolicy()

storageBrowserPolicy to zasada używana do zapobiegania buforowaniu żądań przez przeglądarki oraz do usuwania plików cookie i jawnych nagłówków o długości zawartości.

W Node.jsta polityka jest no-op pass-through.

function storageBrowserPolicy(): PipelinePolicy

Zwraca

PipelinePolicy

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy, aby poprawnie ustawić nagłówek Content-Length z długością treści żądania.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Zwraca

PipelinePolicy

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Zwraca

PipelinePolicy

storageRetryPolicy(StorageRetryOptions)

Zasady ponawiania próby z implementacją ponawiania wykładniczego i ponawiania liniowego.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Parametry

options

StorageRetryOptions

Zwraca

PipelinePolicy

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy obsługuje żądania podpisywania przy użyciu kluczy konta magazynu.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Parametry

options

StorageSharedKeyCredentialPolicyOptions

Zwraca

PipelinePolicy

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Aby rozszyfrować strukturyzowany treść do walidacji treści CRC64 podczas pobierania pamięci.

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

Parametry

source

Blob | ReadableStream<Uint8Array>

Zwraca

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Aby rozszyfrować strukturyzowany treść do walidacji treści CRC64 podczas pobierania pamięci.

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

Parametry

source

ReadableStream

options

StructuredMessageDecodingStreamOptions

Zwraca

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Aby zakodować strukturyzowany korpus treści do walidacji treści CRC64 podczas przesyłania do pamięci masowej.

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

Parametry

source

RequestBodyType

contentLength

number

Zwraca

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

Szczegóły zmiennej

storageBrowserPolicyName

Programowy identyfikator StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Typ

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

Programowy identyfikator storageCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Typ

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

Programowy identyfikator StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Typ

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Nazwa storageRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Typ

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

Programowy identyfikator polityki storageSharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Typ

"storageSharedKeyCredentialPolicy"