@azure/ms-rest-js package

  • Başvuru

Sınıflar

ApiKeyCredentials

API anahtarı kullanarak bir hizmette kimlik doğrulaması yapar.
AzureIdentityCredentialAdapter

Bu sınıf, kimlik doğrulaması için ServiceClientCredentials kimlik bilgileri ailesini kabul eden eski Azure SDK'larıyla kullanmak üzere kitaplıktan @azure/identity kullanılacak <xref:TokenCredential> basit bir uzantı sağlar.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

API anahtarı kullanarak bir hizmette kimlik doğrulaması yapar.
HttpHeaders

HTTP üst bilgi anahtarı/değer çiftleri koleksiyonu.
RequestPolicyOptions

RequestPolicy oluştururken kullanılabilecek isteğe bağlı özellikler.
RestError
Serializer
ServiceClient
TokenCredentials

Kimlik doğrulaması için belirteç dizesi ve yazma düzeni kullanan bir kimlik bilgileri nesnesi.
TopicCredentials

API anahtarı kullanarak bir hizmette kimlik doğrulaması yapar.
URLBuilder

URL'leri oluşturma, değiştirme ve ayrıştırma işlemlerini işleyen bir sınıf.
URLQuery

URLBuilder'ın sorgu bölümünü işleyen bir sınıf.
WebResource

Yeni bir WebResource nesnesi oluşturur.

Bu sınıf, kitaplık / uygulamadan bağımsız olarak ve bir istek başlatmak için gerekli özellikleri sarmalayarak REST çağrısı üzerinde bir soyutlama sağlar.

Arabirimler

AbortSignalLike

"Abort" olayı tetiklendikten sonra isteğin durdurulmasına izin verir. Tarayıcının yerleşik AbortSignal ve yaygın polyfills ile uyumludur.
AgentSettings

HTTP ve HTTPS aracıları (yalnızca Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

bir işlem yanıtının belirli bir şekilde seri durumdan çıkarılması gerektiğini belirten içerik türleri.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

HttpRequests gönderebilen ve vaat edilen HttpResponses'i alabilen bir arabirim.
HttpHeader

HttpHeaders koleksiyonu içindeki tek bir üst bilgi.
HttpHeadersLike

HTTP üst bilgi anahtarı/değer çiftleri koleksiyonu.
HttpOperationResponse

Http isteği ve yanıtı için sarmalayıcı nesnesi. Seri durumdan çıkarılmış nesne, yanıt gövdesi JSON veya XML'de alındığında özelliğinde depolanır parsedBody .
HttpPipelineLogger

HttpPipeline'e eklenebilen bir Günlükçü. Bu, her RequestPolicy'nin hata ayıklama amacıyla kullanılabilecek iletileri günlüğe kaydetmesini sağlar.
HttpResponse

Her zaman mevcut olacak http yanıt özellikleri.
MapperConstraints
OperationArguments

Bir işlemin tek bir çağrısına uygulanan özellikler koleksiyonu.
OperationParameter

Tüm operation parametrelerinin genişleten ortak bir arabirim.
OperationQueryParameter

İşlemin HTTP isteğine sorgu parametresi olarak eklenecek bir işlem parametresi.
OperationResponse

Tek bir durum kodu için bir işlem isteğinden döndürülebilen operationResponse.
OperationSpec

bir işlemi tanımlayan belirtim.
OperationURLParameter

İşlemin istek URL'sinin yerine geçecek bir işlem parametresi.
ParameterValue

RequestPrepareOptions içinde yol veya sorgu parametreleri için sağlanan Parametre değeri
PolymorphicDiscriminator
ProxySettings

HTTP proxy ayarları (yalnızca Node.js)
RedirectOptions

Yeniden yönlendirme yanıtlarının nasıl işlenme seçenekleri.
RequestOptionsBase

Her işlemde kullanılacak options nesnesinin temel yapısını açıklar.
RequestPolicy
RequestPolicyOptionsLike

RequestPolicy oluştururken kullanılabilecek isteğe bağlı özellikler.
RequestPrepareOptions
RestResponse

REST çağrısına düzleştirilmiş yanıt. Temel alınan HttpOperationResponse'un yanı sıra parsedBody, parsedHeaders vb. özelliklerinin birleştirilmiş özelliklerini içerir.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

İstemci oluşturulurken sağlanacak seçenekler.
SimpleMapperType
TokenResponse

TokenResponse içinde @azure/ms-rest-nodeauth tanımlanır ve gereksiz bir bağımlılık eklememek için buraya kopyalanır.
UrlParameterValue
WebResourceLike

REST çağrısının soyutlaması.

Tür Diğer Adları

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

Basit bir JSON nesnesi olarak temsil edilen httpheaders koleksiyonu.
RequestPolicyFactory

Sağlanan nextPolicy'yi kullanan yeni bir RequestPolicy istek başına oluşturur.
TelemetryInfo
TransferProgressEvent

Karşıya yükleme veya indirme ilerlemesine yanıt olarak tetiklenir.

Numaralandırmalar

HttpPipelineLogLevel

HttpPipelineLogger ile kullanılabilecek farklı günlük düzeyleri.
QueryCollectionFormat

Sorgu parametresi değeri için bir değer dizisini birleştirmek için kullanılacak biçim.

İşlevler

agentPolicy(AgentSettings)
applyMixins(any, any[])

sourceCtors prototipi üzerindeki özellikleri targetCtor prototipine uygular
delay<T>(number, T)

t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.
deserializationPolicy(DeserializationContentTypes)

HTTP işlem hattından geçerken HTTP istek gövdelerini seri hale getiren yeni bir serileştirme RequestPolicyCreator oluşturun.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

Bir URI'yi kodlar.
executePromisesSequentially(any[], any)

Bir promise dizisini sıralı olarak yürütür. Bu yöntemin ilham kaynağı şu şekildedir: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Vaatler hakkında harika bir blog!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

Oluşturulan UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Verilen dizenin ISO 8601 biçiminde olup olmadığını gösterir.
isValidUuid(string)

Verilen uuid değerini dize olarak doğrular
logPolicy(any)
promiseToCallback(Promise<any>)

Promise'i geri çağırmaya dönüştürür.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Promise'i bir hizmet geri çağırmasına dönüştürür.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Yetkilendirme üst bilgisini içermeyen Http İsteğinin kaldırılmış bir sürümünü döndürür.
stripResponse(HttpOperationResponse)

Http Yanıtı'nın yalnızca gövde, üst bilgiler ve durumu içeren kaldırılmış bir sürümünü döndürür.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

İşlev Ayrıntıları

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parametreler

agentSettings
AgentSettings

Döndürülenler

RequestPolicyFactory

applyMixins(any, any[])

sourceCtors prototipi üzerindeki özellikleri targetCtor prototipine uygular

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

Parametreler

targetCtor

any

Özelliklerin uygulanması gereken hedef nesne.

sourceCtors

any[]

Özelliklerin alınması gereken kaynak nesne dizisi.

delay<T>(number, T)

t milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.

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

Parametreler

t

number

Geciktirilecek milisaniye sayısı.

value

T

T milisaniyelik zaman aşımından sonra çözümlenecek değer.

Döndürülenler

Promise<T>

Çözülen söz

deserializationPolicy(DeserializationContentTypes)

HTTP işlem hattından geçerken HTTP istek gövdelerini seri hale getiren yeni bir serileştirme RequestPolicyCreator oluşturun.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parametreler

deserializationContentTypes
DeserializationContentTypes

Döndürülenler

RequestPolicyFactory

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

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

Parametreler

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Döndürülenler

Promise<HttpOperationResponse>

encodeUri(string)

Bir URI'yi kodlar.

function encodeUri(uri: string): string

Parametreler

uri

string

Kodlanacak URI.

Döndürülenler

string

Kodlanmış URI.

executePromisesSequentially(any[], any)

Bir promise dizisini sıralı olarak yürütür. Bu yöntemin ilham kaynağı şu şekildedir: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Vaatler hakkında harika bir blog!

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

Parametreler

promiseFactories

any[]

Promise fabrikaları dizisi (Promise döndüren bir işlev)

kickstart

any

Promise zincirini başlatmada kullanılan ilk promise'e giriş. Sağlanmazsa, söz zinciri tanımsız olarak başlar.

Döndürülenler

Promise<any>

Çözümlenen veya reddedilen sözler zinciri

exponentialRetryPolicy(number, number, number, number) 

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

Parametreler

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Döndürülenler

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parametreler

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Döndürülenler

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parametreler

requestIdHeaderName

string

Döndürülenler

RequestPolicyFactory

generateUuid()

Oluşturulan UUID

function generateUuid(): string

Döndürülenler

string

RFC4122 v4 UUID.

getDefaultProxySettings(string) 

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

Parametreler

proxyUrl

string

Döndürülenler

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Döndürülenler

string

isDuration(string)

Verilen dizenin ISO 8601 biçiminde olup olmadığını gösterir.

function isDuration(value: string): boolean

Parametreler

value

string

ISO 8601 süre biçimi için doğrulanacak değer.

Döndürülenler

boolean

true geçerliyse, false aksi takdirde.

isValidUuid(string)

Verilen uuid değerini dize olarak doğrular

function isValidUuid(uuid: string): boolean

Parametreler

uuid

string

Doğrulanması gereken bir dize olarak uuid

Döndürülenler

boolean

uuid geçerliyse True; false olarak ayarlayın.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parametreler

logger

any

Döndürülenler

RequestPolicyFactory

promiseToCallback(Promise<any>)

Uyarı

Bu API artık kullanım dışıdır.

generated code should instead depend on responseToBody

Promise'i geri çağırmaya dönüştürür.

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

Parametreler

promise

Promise<any>

Geri çağırmaya dönüştürülecek Promise

Döndürülenler

Function

Geri çağırmayı alan bir işlev (cb: İşlev): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Promise'i bir hizmet geri çağırmasına dönüştürür.

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

Parametreler

promise

Promise<HttpOperationResponse>

Hizmet geri çağırmasına dönüştürülecek HttpOperationResponse Taahhüdü

Döndürülenler

Function

Hizmet geri çağırmasını alan bir işlev (cb: ServiceCallback): void

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parametreler

proxySettings
ProxySettings

Döndürülenler

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parametreler

maximumRetries

number

Döndürülenler

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parametreler

toSerialize

any

Döndürülenler

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parametreler

authenticationProvider
ServiceClientCredentials

Döndürülenler

RequestPolicyFactory

stripRequest(WebResourceLike)

Yetkilendirme üst bilgisini içermeyen Http İsteğinin kaldırılmış bir sürümünü döndürür.

function stripRequest(request: WebResourceLike): WebResourceLike

Parametreler

request
WebResourceLike

Http İsteği nesnesi

Döndürülenler

WebResourceLike

Http İsteğinin kaldırılmış sürümü.

stripResponse(HttpOperationResponse)

Http Yanıtı'nın yalnızca gövde, üst bilgiler ve durumu içeren kaldırılmış bir sürümünü döndürür.

function stripResponse(response: HttpOperationResponse): any

Parametreler

response
HttpOperationResponse

Http Yanıtı

Döndürülenler

any

Http Yanıtı'nın kaldırılmış sürümü.

systemErrorRetryPolicy(number, number, number, number) 

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

Parametreler

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Döndürülenler

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parametreler

maxRetries

number

Döndürülenler

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parametreler

userAgentData
TelemetryInfo

Döndürülenler

RequestPolicyFactory