@azure/storage-common package

الفصول

AnonymousCredential

يوفر AnonymousCredential عضو credentialPolicyCreator المستخدم لإنشاء كائنات AnonymousCredentialPolicy. يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS).

AnonymousCredentialPolicy

يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS).

BaseRequestPolicy

الفئة الأساسية التي تستمد منها كافة نهج الطلب.

BufferScheduler

تقبل هذه الفئة دفق Node.js قابل للقراءة كإدخل، وتحتفظ بقراءة البيانات من الدفق إلى بنية المخزن المؤقت الداخلي، حتى تصل إلى maxBuffers. سيحاول كل مخزن مؤقت متوفر تشغيل outgoingHandler.

تتضمن بنية المخزن المؤقت الداخلي صفيف مخزن مؤقت وارد، وصفيف مخزن مؤقت صادر. يتضمن صفيف المخزن المؤقت الوارد المخازن المؤقتة "الفارغة" التي يمكن تعبئتها بالبيانات الواردة الجديدة. يتضمن الصفيف الصادر المخازن المؤقتة التي تمت تعبئتها ليتم معالجتها بواسطة outgoingHandler. يتم تعريف كل حجم مخزن مؤقت أعلاه بواسطة حجم المخزن المؤقت للمعلمة.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS أقل من أو يساوي maxBuffers

تلميحات تحسين الأداء:

  1. تدفق الإدخال highWaterMark من الأفضل تعيين نفس القيمة باستخدام معلمة bufferSize، والتي ستتجنب عمليات Buffer.concat().
  2. يجب أن تقوم concurrency بتعيين قيمة أصغر من maxBuffers، وهو أمر مفيد لتقليل الاحتمال عندما ينتظر معالج صادر بيانات الدفق. في هذه الحالة، يتم حظر المعالجات الصادرة. يجب ألا تكون قائمة الانتظار الصادرة فارغة.
Credential

بيانات الاعتماد هي فئة مجردة لتوقيع طلبات AZURE Storage HTTP. ستستضيف هذه الفئة مصنع credentialPolicyCreator الذي ينشئ CredentialPolicy.

CredentialPolicy

نهج بيانات الاعتماد المستخدم لتوقيع طلبات HTTP(S) قبل الإرسال. هذه فئة مجردة.

Readable
StorageBrowserPolicy

سيتعامل StorageBrowserPolicy مع الاختلافات بين Node.js ووقت تشغيل المستعرض، بما في ذلك:

  1. تقوم المستعرضات بتخزين طلبات GET/HEAD مؤقتا عن طريق إضافة عناوين شرطية مثل "IF_MODIFIED_SINCE". StorageBrowserPolicy هو نهج يستخدم لإضافة استعلام طابع زمني إلى عنوان URL لطلب GET/HEAD وبالتالي تجنب ذاكرة التخزين المؤقت للمستعرض.

  2. إزالة رأس ملف تعريف الارتباط للأمان

  3. إزالة رأس طول المحتوى لتجنب تحذير المستعرضات

في Node.js، هذه السياسة هي مرور no-op.

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory هي فئة مصنع تساعد في إنشاء كائنات StorageBrowserPolicy.

StorageCRC64Calculator

الفئة المستخدمة في الحاسبة لجمع التحقق CRC64

StorageRetryPolicy

نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية.

StorageRetryPolicyFactory

StorageRetryPolicyFactory هي فئة مصنع تساعد على إنشاء كائنات StorageRetryPolicy.

StorageSharedKeyCredential

متوفر فقط في وقت تشغيل NODE.JS.

StorageSharedKeyCredential لتخويل مفتاح الحساب لخدمة تخزين Azure.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy هو نهج يستخدم لتوقيع طلب HTTP باستخدام مفتاح مشترك.

UserDelegationKeyCredential

متوفر فقط في وقت تشغيل NODE.JS.

يستخدم UserDelegationKeyCredential فقط لتوليد SAS لتفويض المستخدم.

راجع https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

الواجهات

NodeJSReadableStream

دفق Node.js قابل للقراءة يحتوي أيضا على destroy أسلوب.

StorageRetryOptions

واجهة خيارات إعادة محاولة Storage Blob.

StorageSharedKeyCredentialPolicyOptions

الخيارات المستخدمة لتكوين StorageSharedKeyCredentialPolicy.

StructuredMessageDecodingStreamOptions

الخيارات المستخدمة عند إنشاء StructuredMessageDecodingStream

StructuredMessageEncodingStreamOptions

الخيارات المستخدمة عند إنشاء StructuredMessageEncodingStream

UserDelegationKey

مفتاح تفويض المستخدم.

النوع أسماء مستعارة

CredentialPolicyCreator

دالة مصنع تنشئ نهج بيانات اعتماد جديد يستخدم النهج التالي المتوفر.

OutgoingHandler

OutgoingHandler هي دالة غير متزامنة يتم تشغيلها بواسطة BufferScheduler.

التعدادات

StorageRetryPolicyType

أنواع RetryPolicy.

الوظائف

NewRetryPolicyFactory(StorageRetryOptions)

أسلوب المصنع المستخدم لإنشاء مصنع RetryPolicy.

allocBuffer(number)

يخصص مخزن مؤقت جديد مملوء بالصفر بالحجم المعطى.

bufferFromArrayBuffer(ArrayBuffer, number, number)

ينشئ مخزن مؤقت من مخزن مصفوفة (ArrayBuffer)، مع إزاحة وطول اختياريين.

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

ينشئ كتلة من البيانات المعطاة. يستخدم مرجعا غير مباشر للبناء لتجاوز تعريفات نوع الكتلة المقيدة في React Native (التي تقبل فقط النص | Blob، وليس ArrayBuffer).

getBufferLength(Buffer)

يعيد طول البايت للمخزن المؤقت.

getCachedDefaultHttpClient()
isBuffer(unknown)

يتحقق مما إذا كانت القيمة هي مخزن Node.js.

storageBrowserPolicy()

storageBrowserPolicy هي سياسة تستخدم لمنع المتصفحات من التخزين المؤقت للطلبات وإزالة ملفات تعريف الارتباط ورؤوس طول المحتوى الصريحة.

في Node.js، هذه السياسة هي مرور no-op.

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy لتعيين رأس Content-Length بشكل صحيح مع طول نص الطلب.

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

storageRetryPolicy(StorageRetryOptions)

نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية.

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

يعالج storageSharedKeyCredentialPolicy طلبات التوقيع باستخدام مفاتيح حساب التخزين.

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

لفك ترميز الجسم الهيكلي للتحقق من محتوى CRC64 أثناء تحميل التخزين.

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

لفك ترميز الجسم الهيكلي للتحقق من محتوى CRC64 أثناء تحميل التخزين.

structuredMessageEncoding(RequestBodyType, number)

لترميز الجسم الهيكلي للتحقق من محتوى CRC64 أثناء رفع التخزين.

المتغيرات

storageBrowserPolicyName

المعرف البرمجي لسياسة StorageBrowser.

storageCorrectContentLengthPolicyName

المعرف البرمجي لسياسة التخزينCorrectContentLengthPolicy.

storageRequestFailureDetailsParserPolicyName

المعرف البرمجي لسياسة StorageRequestFailureDetailsParserPolicy.

storageRetryPolicyName

اسم التخزينRetryPolicy

storageSharedKeyCredentialPolicyName

المعرف البرمجي لسياسة التخزين المشتركة في مفتاح الاعتبارات.

تفاصيل الوظيفة

NewRetryPolicyFactory(StorageRetryOptions)

أسلوب المصنع المستخدم لإنشاء مصنع RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

المعلمات

retryOptions
StorageRetryOptions

المرتجعات

allocBuffer(number)

يخصص مخزن مؤقت جديد مملوء بالصفر بالحجم المعطى.

function allocBuffer(size: number): NodeBuffer

المعلمات

size

number

المرتجعات

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

ينشئ مخزن مؤقت من مخزن مصفوفة (ArrayBuffer)، مع إزاحة وطول اختياريين.

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

المعلمات

ab

ArrayBuffer

byteOffset

number

length

number

المرتجعات

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

ينشئ كتلة من البيانات المعطاة. يستخدم مرجعا غير مباشر للبناء لتجاوز تعريفات نوع الكتلة المقيدة في React Native (التي تقبل فقط النص | Blob، وليس ArrayBuffer).

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

المعلمات

data

Blob | ArrayBuffer | ArrayBufferView

المرتجعات

Blob

getBufferLength(Buffer)

يعيد طول البايت للمخزن المؤقت.

function getBufferLength(buffer: Buffer): number

المعلمات

buffer

Buffer

المرتجعات

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

المرتجعات

isBuffer(unknown)

يتحقق مما إذا كانت القيمة هي مخزن Node.js.

function isBuffer(value: unknown): value

المعلمات

value

unknown

المرتجعات

value

storageBrowserPolicy()

storageBrowserPolicy هي سياسة تستخدم لمنع المتصفحات من التخزين المؤقت للطلبات وإزالة ملفات تعريف الارتباط ورؤوس طول المحتوى الصريحة.

في Node.js، هذه السياسة هي مرور no-op.

function storageBrowserPolicy(): PipelinePolicy

المرتجعات

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy لتعيين رأس Content-Length بشكل صحيح مع طول نص الطلب.

function storageCorrectContentLengthPolicy(): PipelinePolicy

المرتجعات

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

المرتجعات

storageRetryPolicy(StorageRetryOptions)

نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

المعلمات

المرتجعات

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

يعالج storageSharedKeyCredentialPolicy طلبات التوقيع باستخدام مفاتيح حساب التخزين.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

المعلمات

المرتجعات

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

لفك ترميز الجسم الهيكلي للتحقق من محتوى CRC64 أثناء تحميل التخزين.

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

المعلمات

source

Blob | ReadableStream<Uint8Array>

المرتجعات

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

لفك ترميز الجسم الهيكلي للتحقق من محتوى CRC64 أثناء تحميل التخزين.

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

المعلمات

source

ReadableStream

المرتجعات

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

لترميز الجسم الهيكلي للتحقق من محتوى CRC64 أثناء رفع التخزين.

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

المعلمات

contentLength

number

المرتجعات

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

تفاصيل المُتغيّر

storageBrowserPolicyName

المعرف البرمجي لسياسة StorageBrowser.

storageBrowserPolicyName: "storageBrowserPolicy"

النوع

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

المعرف البرمجي لسياسة التخزينCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

النوع

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

المعرف البرمجي لسياسة StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

النوع

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

اسم التخزينRetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

النوع

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

المعرف البرمجي لسياسة التخزين المشتركة في مفتاح الاعتبارات.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

النوع

"storageSharedKeyCredentialPolicy"