@azure/ms-rest-js package

الفصول

ApiKeyCredentials	المصادقة على خدمة باستخدام مفتاح API.
AzureIdentityCredentialAdapter	توفر هذه الفئة ملحقا بسيطا لاستخدامه <xref:TokenCredential> من @azure/identity المكتبة لاستخدامه مع Azure SDKs القديمة التي تقبل مجموعة بيانات اعتماد ServiceClientCredentials للمصادقة.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	المصادقة على خدمة باستخدام مفتاح API.
HttpHeaders	مجموعة من أزواج مفتاح/قيمة عنوان HTTP.
RequestPolicyOptions	الخصائص الاختيارية التي يمكن استخدامها عند إنشاء RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials	كائن بيانات اعتماد يستخدم سلسلة رمز مميز ونظام تأليف للمصادقة.
TopicCredentials	المصادقة على خدمة باستخدام مفتاح API.
URLBuilder	فئة تتعامل مع إنشاء عناوين URL وتعديلها وتحليلها.
URLQuery	فئة تتعامل مع جزء الاستعلام من URLBuilder.
WebResource	إنشاء كائن WebResource جديد. توفر هذه الفئة تجريدا عبر استدعاء REST من خلال كونها مكتبة / تنفيذ غير محددة والتفاف الخصائص الضرورية لبدء طلب.

الواجهات

AbortSignalLike	يسمح باجهاض الطلب عند إطلاق حدث "إحباط". متوافق مع AbortSignal المضمنة في المستعرض وملفات تعريف شائعة.
AgentSettings	وكلاء HTTP وHTTPS (Node.js فقط)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes	أنواع المحتوى التي ستشير إلى أنه يجب إلغاء تسلسل استجابة العملية بطريقة معينة.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient	واجهة يمكنها إرسال HttpRequests وتلقي HttpResponses الموعودة.
HttpHeader	رأس فردي ضمن مجموعة HttpHeaders.
HttpHeadersLike	مجموعة من أزواج مفتاح/قيمة عنوان HTTP.
HttpOperationResponse	كائن برنامج التضمين لطلب http والاستجابة. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية parsedBody عند تلقي نص الاستجابة في JSON أو XML.
HttpPipelineLogger	مسجل يمكن إضافته إلى HttpPipeline. وهذا يمكن كل RequestPolicy من تسجيل الرسائل التي يمكن استخدامها لأغراض تصحيح الأخطاء.
HttpResponse	الخصائص على استجابة HTTP التي ستكون موجودة دائما.
MapperConstraints
OperationArguments	مجموعة من الخصائص التي تنطبق على استدعاء واحد لعملية.
OperationParameter	واجهة شائعة تقوم جميع معلمات العملية بتوسيعها.
OperationQueryParameter	معلمة لعملية ستتم إضافتها كمعلمة استعلام إلى طلب HTTP الخاص بالعملية.
OperationResponse	OperationResponse الذي يمكن إرجاعه من طلب عملية لرمز حالة واحد.
OperationSpec	مواصفات تحدد عملية.
OperationURLParameter	معلمة لعملية سيتم استبدالها في عنوان URL لطلب العملية.
ParameterValue	قيمة المعلمة المتوفرة لمعلمات المسار أو الاستعلام في RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings	إعدادات وكيل HTTP (Node.js فقط)
RedirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
RequestOptionsBase	يصف البنية الأساسية لكائن الخيارات التي سيتم استخدامها في كل عملية.
RequestPolicy
RequestPolicyOptionsLike	الخصائص الاختيارية التي يمكن استخدامها عند إنشاء RequestPolicy.
RequestPrepareOptions
RestResponse	الاستجابة المسطحة لاستدعاء REST. يحتوي على HttpOperationResponse الأساسي بالإضافة إلى الخصائص المدمجة ل parsedBody وparsedHeaders وما إلى ذلك.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions	الخيارات التي سيتم توفيرها أثناء إنشاء العميل.
SimpleMapperType
TokenResponse	يتم تعريف TokenResponse في @azure/ms-rest-nodeauth ويتم نسخه هنا لعدم إضافة تبعية غير ضرورية.
UrlParameterValue
WebResourceLike	تجريد عبر استدعاء REST.

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

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders	مجموعة HttpHeaders ممثلة كعنصر JSON بسيط.
RequestPolicyFactory	إنشاء RequestPolicy جديد لكل طلب يستخدم nextPolicy المتوفرة.
TelemetryInfo
TransferProgressEvent	تم تشغيله استجابة لتقدم التحميل أو التنزيل.

التعدادات

HttpPipelineLogLevel	المستويات المختلفة للسجلات التي يمكن استخدامها مع HttpPipelineLogger.
QueryCollectionFormat	التنسيق الذي سيتم استخدامه لضم صفيف من القيم معا لقيمة معلمة استعلام.

الوظائف

agentPolicy(AgentSettings)
applyMixins(any, any[])	تطبيق الخصائص على النموذج الأولي ل sourceCtors على النموذج الأولي ل targetCtor
delay<T>(number, T)	برنامج تضمين ل setTimeout يحل الوعد بعد مللي ثانية.
deserializationPolicy(DeserializationContentTypes)	إنشاء تسلسل جديد RequestPolicyCreator الذي سيقوم بتسلسل هيئات طلب HTTP أثناء مرورها عبر البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)	ترميز URI.
executePromisesSequentially(any[], any)	تنفيذ صفيف من الوعود بالتتابع. الإلهام من هذا الأسلوب هنا: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. مدونة رهيبة على الوعود!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()	UUID الذي تم إنشاؤه
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)	يشير إلى ما إذا كانت السلسلة المحددة بتنسيق ISO 8601.
isValidUuid(string)	التحقق من صحة uuid المحدد كسلسلة
logPolicy(any)
promiseToCallback(Promise<any>)	تحويل وعد إلى رد اتصال.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	تحويل وعد إلى رد اتصال خدمة.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)	إرجاع إصدار تم تجريده من طلب Http لا يحتوي على عنوان التخويل.
stripResponse(HttpOperationResponse)	إرجاع إصدار تم تجريده من استجابة Http الذي يحتوي فقط على النص الأساسي والرؤوس والحالة.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

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

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

المعلمات

agentSettings

AgentSettings

المرتجعات

RequestPolicyFactory

applyMixins(any, any[])

تطبيق الخصائص على النموذج الأولي ل sourceCtors على النموذج الأولي ل targetCtor

function applyMixins(targetCtor: any, sourceCtors: any[])

المعلمات

targetCtor

any

الكائن الهدف الذي يجب تطبيق الخصائص عليه.

sourceCtors

any[]

صفيف من الكائنات المصدر التي يجب أخذ الخصائص منها.

delay<T>(number, T)

برنامج تضمين ل setTimeout يحل الوعد بعد مللي ثانية.

function delay<T>(t: number, value?: T): Promise<T>

المعلمات

t

number

عدد المللي ثانية التي سيتم تأخيرها.

value

T

القيمة التي سيتم حلها بعد انتهاء مهلة مللي ثانية.

المرتجعات

Promise<T>

الوعد الذي تم حله

deserializationPolicy(DeserializationContentTypes)

إنشاء تسلسل جديد RequestPolicyCreator الذي سيقوم بتسلسل هيئات طلب HTTP أثناء مرورها عبر البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

المعلمات

deserializationContentTypes

DeserializationContentTypes

المرتجعات

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse)

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse): Promise<HttpOperationResponse>

المعلمات

jsonContentTypes

string[]

xmlContentTypes

string[]

response

HttpOperationResponse

المرتجعات

Promise<HttpOperationResponse>

encodeUri(string)

ترميز URI.

function encodeUri(uri: string): string

المعلمات

uri

string

URI المراد ترميزه.

المرتجعات

string

URI المشفرة.

executePromisesSequentially(any[], any)

تنفيذ صفيف من الوعود بالتتابع. الإلهام من هذا الأسلوب هنا: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. مدونة رهيبة على الوعود!

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

المعلمات

promiseFactories

any[]

صفيف من مصانع الوعد (دالة ترجع وعدا)

kickstart

any

إدخال إلى الوعد الأول الذي يستخدم لبدء سلسلة الوعود. إذا لم يتم توفيرها، تبدأ سلسلة الوعود ب غير محددة.

المرتجعات

Promise<any>

سلسلة من الوعود التي تم حلها أو رفضها

exponentialRetryPolicy(number, number, number, number)

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

المعلمات

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

المرتجعات

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

المعلمات

_response

HttpOperationResponse

responseSpec

undefined | OperationResponse

المرتجعات

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

المعلمات

requestIdHeaderName

string

المرتجعات

RequestPolicyFactory

generateUuid()

UUID الذي تم إنشاؤه

function generateUuid(): string

المرتجعات

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

المعلمات

proxyUrl

string

المرتجعات

ProxySettings | undefined

getDefaultUserAgentValue()

function getDefaultUserAgentValue(): string

المرتجعات

string

isDuration(string)

يشير إلى ما إذا كانت السلسلة المحددة بتنسيق ISO 8601.

function isDuration(value: string): boolean

المعلمات

value

string

القيمة التي سيتم التحقق من صحتها لتنسيق مدة ISO 8601.

المرتجعات

boolean

true إذا كان صالحا، false وإلا.

isValidUuid(string)

التحقق من صحة uuid المحدد كسلسلة

function isValidUuid(uuid: string): boolean

المعلمات

uuid

string

uuid كسلسلة تحتاج إلى التحقق من صحتها

المرتجعات

boolean

صحيح إذا كان uuid صالحا؛ خطأ خلاف ذلك.

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

المعلمات

logger

any

المرتجعات

RequestPolicyFactory

promiseToCallback(Promise<any>)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

generated code should instead depend on responseToBody

تحويل وعد إلى رد اتصال.

function promiseToCallback(promise: Promise<any>): Function

المعلمات

promise

Promise<any>

الوعد الذي سيتم تحويله إلى رد اتصال

المرتجعات

Function

دالة تأخذ رد الاتصال (cb: دالة): فارغة

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

تحويل وعد إلى رد اتصال خدمة.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function

المعلمات

promise

Promise<HttpOperationResponse>

وعد HttpOperationResponse لتحويله إلى رد اتصال خدمة

المرتجعات

Function

دالة تأخذ رد اتصال الخدمة (cb: ServiceCallback): فارغة

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

المعلمات

proxySettings

ProxySettings

المرتجعات

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

المعلمات

maximumRetries

number

المرتجعات

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

المعلمات

toSerialize

any

المرتجعات

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

المعلمات

authenticationProvider

ServiceClientCredentials

المرتجعات

RequestPolicyFactory

stripRequest(WebResourceLike)

إرجاع إصدار تم تجريده من طلب Http لا يحتوي على عنوان التخويل.

function stripRequest(request: WebResourceLike): WebResourceLike

المعلمات

request

WebResourceLike

كائن طلب Http

المرتجعات

WebResourceLike

الإصدار المجرد من طلب Http.

stripResponse(HttpOperationResponse)

إرجاع إصدار تم تجريده من استجابة Http الذي يحتوي فقط على النص الأساسي والرؤوس والحالة.

function stripResponse(response: HttpOperationResponse): any

المعلمات

response

HttpOperationResponse

استجابة Http

المرتجعات

any

الإصدار المجرد من استجابة Http.

systemErrorRetryPolicy(number, number, number, number)

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

المعلمات

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

المرتجعات

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

المعلمات

maxRetries

number

المرتجعات

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

المعلمات

userAgentData

TelemetryInfo

المرتجعات

RequestPolicyFactory