@azure/ms-rest-js package
الفصول
| ApiKeyCredentials |
المصادقة على خدمة باستخدام مفتاح API. |
| AzureIdentityCredentialAdapter |
توفر هذه الفئة ملحقا بسيطا لاستخدام <xref:TokenCredential> من مكتبة |
| BaseRequestPolicy | |
| BasicAuthenticationCredentials | |
| DefaultHttpClient | |
| DomainCredentials |
المصادقة على خدمة باستخدام مفتاح API. |
| HttpHeaders |
مجموعة من أزواج مفتاح/قيمة عنوان HTTP. |
| RequestPolicyOptions |
الخصائص الاختيارية التي يمكن استخدامها عند إنشاء RequestPolicy. |
| RestError | |
| Serializer | |
| ServiceClient | |
| TokenCredentials |
كائن بيانات اعتماد يستخدم سلسلة رمز مميز ونظام تأليف للمصادقة. |
| TopicCredentials |
المصادقة على خدمة باستخدام مفتاح API. |
| URLBuilder |
فئة تتعامل مع إنشاء عناوين URL وتعديلها وتحليلها. |
| URLQuery |
فئة تعالج جزء الاستعلام من URLBuilder. |
| WebResource |
إنشاء كائن WebResource جديد. توفر هذه الفئة تجريدا عبر استدعاء REST من خلال كونها مكتبة / تنفيذ غير محدد والتفاف الخصائص الضرورية لبدء طلب. |
الواجهات
| AbortSignalLike |
يسمح باجهاض الطلب عند إطلاق حدث "إحباط". متوافق مع المتصفح المضمن AbortSignal و polyfills الشائعة. |
| AgentSettings |
عوامل HTTP وHTTPS (Node.js فقط) |
| ApiKeyCredentialOptions | |
| BaseMapper | |
| CompositeMapper | |
| CompositeMapperType | |
| DeserializationContentTypes |
أنواع المحتوى التي تشير إلى أنه يجب إلغاء تسلسل استجابة العملية بطريقة معينة. |
| DictionaryMapper | |
| DictionaryMapperType | |
| EnumMapper | |
| EnumMapperType | |
| HttpClient |
واجهة يمكنها إرسال طلبات Http وتلقي HttpResponses الموعودة. |
| HttpHeader |
رأس فردي ضمن مجموعة HttpHeaders. |
| HttpHeadersLike |
مجموعة من أزواج مفتاح/قيمة عنوان HTTP. |
| HttpOperationResponse |
كائن برنامج التضمين لطلب واستجابة http. يتم تخزين الكائن الذي تم إلغاء تسلسله في الخاصية |
| 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 في |
| UrlParameterValue | |
| WebResourceLike |
تجريد عبر استدعاء REST. |
النوع أسماء مستعارة
| Authenticator | |
| CommonRequestInfo | |
| CommonRequestInit | |
| CommonResponse | |
| HttpMethods | |
| HttpRequestBody | |
| Mapper | |
| ParameterPath | |
| RawHttpHeaders |
يتم تمثيل مجموعة HttpHeaders ككائن JSON بسيط. |
| RequestPolicyFactory |
إنشاء RequestPolicy لكل طلب جديد يستخدم nextPolicy المتوفرة. |
| TelemetryInfo | |
| TransferProgressEvent |
تم إطلاقه استجابة للتقدم في التحميل أو التنزيل. |
التعدادات
| HttpPipelineLogLevel |
المستويات المختلفة للسجلات التي يمكن استخدامها مع HttpPipelineLogger. |
| QueryCollectionFormat |
التنسيق الذي سيتم استخدامه لضم صفيف من القيم معا لقيمة معلمة استعلام. |
الوظائف
المتغيرات
| Mapper |
|
| Constants | |
| is |
ثابت يشير إلى ما إذا كانت البيئة node.js أو تعتمد على المتصفح. |
تفاصيل الوظيفة
agentPolicy(AgentSettings)
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactoryالمعلمات
- agentSettings
- AgentSettings
المرتجعات
applyMixins(any, any[])
تطبيق الخصائص على النموذج الأولي ل sourceCtors على النموذج الأولي ل targetCtor
function applyMixins(targetCtor: any, sourceCtors: any[])المعلمات
- targetCtor
-
any
الكائن الهدف الذي يجب تطبيق الخصائص عليه.
- sourceCtors
-
any[]
صفيف من الكائنات المصدر التي يجب أخذ الخصائص منها.
delay<T>(number, T)
برنامج تضمين ل setTimeout الذي يحل الوعد بعد t مللي ثانية.
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
المرتجعات
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
المرتجعات
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponseالمعلمات
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
المرتجعات
generateClientRequestIdPolicy(string)
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactoryالمعلمات
- requestIdHeaderName
-
string
المرتجعات
generateUuid()
UUID الذي تم إنشاؤه
function generateUuid(): stringالمرتجعات
string
RFC4122 uuid v4.
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
المرتجعات
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<T>): باطلة
proxyPolicy(ProxySettings)
function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactoryالمعلمات
- proxySettings
- ProxySettings
المرتجعات
redirectPolicy(number)
function redirectPolicy(maximumRetries?: number): RequestPolicyFactoryالمعلمات
- maximumRetries
-
number
المرتجعات
serializeObject(any)
function serializeObject(toSerialize: any): anyالمعلمات
- toSerialize
-
any
المرتجعات
any
signingPolicy(ServiceClientCredentials)
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactoryالمعلمات
- authenticationProvider
- ServiceClientCredentials
المرتجعات
stripRequest(WebResourceLike)
إرجاع إصدار تم تجريده من طلب Http لا يحتوي على عنوان التخويل.
function stripRequest(request: WebResourceLike): WebResourceLikeالمعلمات
- request
- WebResourceLike
كائن طلب Http
المرتجعات
الإصدار المجرد من طلب 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
المرتجعات
throttlingRetryPolicy(number)
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactoryالمعلمات
- maxRetries
-
number
المرتجعات
userAgentPolicy(TelemetryInfo)
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactoryالمعلمات
- userAgentData
- TelemetryInfo
المرتجعات
Variable Details
MapperType
MapperType: { Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }النوع
{ Base64Url: "Base64Url", Boolean: "Boolean", ByteArray: "ByteArray", Composite: "Composite", Date: "Date", DateTime: "DateTime", DateTimeRfc1123: "DateTimeRfc1123", Dictionary: "Dictionary", Enum: "Enum", Number: "Number", Object: "Object", Sequence: "Sequence", Stream: "Stream", String: "String", TimeSpan: "TimeSpan", UnixTime: "UnixTime" }
Constants
Constants: { ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { TooManyRequests: number } }, NO_PROXY: string, msRestVersion: string }النوع
{ ALL_PROXY: string, HTTP: string, HTTPS: string, HTTPS_PROXY: string, HTTP_PROXY: string, HeaderConstants: { AUTHORIZATION: string, AUTHORIZATION_SCHEME: string, RETRY_AFTER: string, USER_AGENT: string }, HttpConstants: { HttpVerbs: { DELETE: string, GET: string, HEAD: string, MERGE: string, PATCH: string, POST: string, PUT: string }, StatusCodes: { TooManyRequests: number } }, NO_PROXY: string, msRestVersion: string }
isNode
ثابت يشير إلى ما إذا كانت البيئة node.js أو تعتمد على المتصفح.
isNode: booleanالنوع
boolean