@azure/ms-rest-js package

Osztályok

ApiKeyCredentials	API-kulccsal hitelesít egy szolgáltatásban.
AzureIdentityCredentialAdapter	Ez az osztály egy egyszerű bővítményt biztosít, amellyel <xref:TokenCredential> kódtárból származó @azure/identity használhat olyan örökölt Azure SDK-khoz, amelyek elfogadják ServiceClientCredentials hitelesítő adatok családját a hitelesítéshez.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	API-kulccsal hitelesít egy szolgáltatásban.
HttpHeaders	HTTP-fejléckulcs/érték párok gyűjteménye.
RequestPolicyOptions	Nem kötelező tulajdonságok, amelyek a RequestPolicy létrehozásakor használhatók.
RestError
Serializer
ServiceClient
TokenCredentials	Hitelesítőadat-objektum, amely jogkivonat-sztringet és szerzői jogosultsági sémát használ a hitelesítéshez.
TopicCredentials	API-kulccsal hitelesít egy szolgáltatásban.
URLBuilder	Az URL-címek létrehozását, módosítását és elemzését kezelő osztály.
URLQuery	Egy URLBuilder lekérdezési részét kezelő osztály.
WebResource	Létrehoz egy új WebResource-objektumot. Ez az osztály absztrakciót biztosít egy REST-híváshoz, mivel kódtár/implementáció agnosztikus, és a kérés indításához szükséges tulajdonságokat burkolja.

Interfészek

AbortSignalLike	Lehetővé teszi a kérés megszakítását az "abort" esemény aktiválásakor. Kompatibilis a böngésző beépített AbortSignal és a gyakori polifillek.
AgentSettings	HTTP- és HTTPS-ügynökök (csakNode.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes	Azok a tartalomtípusok, amelyek azt jelzik, hogy a műveleti válaszokat bizonyos módon deszerializálni kell.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient	Egy felület, amely httpRequests-t küldhet, és fogadhatja az ígért HttpResponses-t.
HttpHeader	Egyéni fejléc egy HttpHeaders-gyűjteményben.
HttpHeadersLike	HTTP-fejléckulcs/érték párok gyűjteménye.
HttpOperationResponse	Burkolóobjektum http-kéréshez és válaszhoz. A deszerializált objektum a parsedBody tulajdonságban lesz tárolva, amikor a válasz törzse JSON-ban vagy XML-ben érkezik.
HttpPipelineLogger	HttpPipeline-hoz hozzáadható naplózó. Ez lehetővé teszi, hogy minden RequestPolicy naplózza azokat az üzeneteket, amelyek hibakeresési célokra használhatók.
HttpResponse	A HTTP-válasz tulajdonságai, amelyek mindig jelen lesznek.
MapperConstraints
OperationArguments	Olyan tulajdonságok gyűjteménye, amelyek egy művelet egyetlen meghívására vonatkoznak.
OperationParameter	Egy közös felület, amelyet az összes műveleti paraméter kiterjeszt.
OperationQueryParameter	Egy művelet paramétere, amely lekérdezési paraméterként lesz hozzáadva a művelet HTTP-kéréséhez.
OperationResponse	OperationResponse, amely egyetlen állapotkód műveleti kéréséből adható vissza.
OperationSpec	Egy műveletet meghatározó specifikáció.
OperationURLParameter	Egy művelet paramétere, amely a művelet kérési URL-címére lesz helyettesítve.
ParameterValue	A RequestPrepareOptions elérési út- vagy lekérdezésparamétereihez megadott paraméterérték
PolymorphicDiscriminator
ProxySettings	HTTP-proxybeállítások (csakNode.js)
RedirectOptions	Az átirányítási válaszok kezelésének beállításai.
RequestOptionsBase	Az összes műveletben használt beállításobjektum alapstruktúráját ismerteti.
RequestPolicy
RequestPolicyOptionsLike	Nem kötelező tulajdonságok, amelyek a RequestPolicy létrehozásakor használhatók.
RequestPrepareOptions
RestResponse	A REST-hívásra adott összesimított válasz. Tartalmazza a mögöttes HttpOperationResponse-t, valamint a parsedBody, a parsedHeaders stb. egyesített tulajdonságait.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions	Az ügyfél létrehozásakor meg kell adni a beállításokat.
SimpleMapperType
TokenResponse	A TokenResponse @azure/ms-rest-nodeauth van definiálva, és ide másolódik, hogy ne adjon hozzá szükségtelen függőséget.
UrlParameterValue
WebResourceLike	REST-hívás absztrakciója.

Típusaliasok

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders	Egyszerű JSON-objektumként ábrázolt HttpHeaders-gyűjtemény.
RequestPolicyFactory	Létrehoz egy kérésenként egy új RequestPolicy-t, amely a megadott nextPolicy-t használja.
TelemetryInfo
TransferProgressEvent	A feltöltési vagy letöltési folyamatra válaszul aktiválódott.

Enumerációk

HttpPipelineLogLevel	A HttpPipelineLoggerrel használható naplók különböző szintjei.
QueryCollectionFormat	Az a formátum, amely egy értéktömb összeillesztéséhez használható egy lekérdezési paraméter értékéhez.

Függvények

agentPolicy(AgentSettings)
applyMixins(any, any[])	A sourceCtors prototípus tulajdonságainak alkalmazása a targetCtor prototípusára
delay<T>(number, T)	A setTimeout burkolója, amely ezredmásodperc után felold egy ígéretet.
deserializationPolicy(DeserializationContentTypes)	Hozzon létre egy új szerializációs RequestPolicyCreatort, amely szerializálja a HTTP-kérelemtörzseket, miközben áthaladnak a HTTP-folyamaton.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)	Kódol egy URI-t.
executePromisesSequentially(any[], any)	Az ígéretek tömbjének egymást követő végrehajtása. Ihletet erre a módszerre van itt: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Fantasztikus blog az ígéretekről!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()	Generált UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)	Azt jelzi, hogy a megadott sztring ISO 8601 formátumban van-e.
isValidUuid(string)	A megadott uuid sztringként való érvényesítése
logPolicy(any)
promiseToCallback(Promise<any>)	Az ígéreteket visszahívássá alakítja.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Az ígéreteket szolgáltatásvisszahívássá alakítja.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)	A Http-kérelem olyan lecsupaszított verzióját adja vissza, amely nem tartalmazza az Engedélyezési fejlécet.
stripResponse(HttpOperationResponse)	A Http-válasz egy lecsupaszított verzióját adja vissza, amely csak törzset, fejléceket és állapotot tartalmaz.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Függvény adatai

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Paraméterek

agentSettings

AgentSettings

Válaszok

RequestPolicyFactory

applyMixins(any, any[])

A sourceCtors prototípus tulajdonságainak alkalmazása a targetCtor prototípusára

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

Paraméterek

targetCtor

any

Az a célobjektum, amelyre a tulajdonságokat alkalmazni kell.

sourceCtors

any[]

Forrásobjektumok tömbje, amelyekből a tulajdonságokat meg kell adni.

delay<T>(number, T)

A setTimeout burkolója, amely ezredmásodperc után felold egy ígéretet.

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

Paraméterek

t

number

A késleltetni kívánt ezredmásodpercek száma.

value

T

Ezredmásodperc időtúllépés után feloldandó érték.

Válaszok

Promise<T>

Megoldott ígéret

deserializationPolicy(DeserializationContentTypes)

Hozzon létre egy új szerializációs RequestPolicyCreatort, amely szerializálja a HTTP-kérelemtörzseket, miközben áthaladnak a HTTP-folyamaton.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Paraméterek

deserializationContentTypes

DeserializationContentTypes

Válaszok

RequestPolicyFactory

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

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

Paraméterek

jsonContentTypes

string[]

xmlContentTypes

string[]

response

HttpOperationResponse

Válaszok

Promise<HttpOperationResponse>

encodeUri(string)

Kódol egy URI-t.

function encodeUri(uri: string): string

Paraméterek

uri

string

A kódolandó URI.

Válaszok

string

A kódolt URI.

executePromisesSequentially(any[], any)

Az ígéretek tömbjének egymást követő végrehajtása. Ihletet erre a módszerre van itt: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Fantasztikus blog az ígéretekről!

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

Paraméterek

promiseFactories

any[]

Ígéretgyárak tömbje (Az ígéretet visszaadó függvény)

kickstart

any

Az ígéretlánc elindításához használt első ígéret bemenete. Ha nincs megadva, akkor az ígéretlánc meghatározatlannal kezdődik.

Válaszok

Promise<any>

Feloldott vagy elutasított ígéretek lánca

exponentialRetryPolicy(number, number, number, number)

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

Paraméterek

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Válaszok

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

Paraméterek

_response

HttpOperationResponse

responseSpec

undefined | OperationResponse

Válaszok

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Paraméterek

requestIdHeaderName

string

Válaszok

RequestPolicyFactory

generateUuid()

Generált UUID

function generateUuid(): string

Válaszok

string

RFC4122 v4 UUID azonosítót.

getDefaultProxySettings(string)

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

Paraméterek

proxyUrl

string

Válaszok

ProxySettings | undefined

getDefaultUserAgentValue()

function getDefaultUserAgentValue(): string

Válaszok

string

isDuration(string)

Azt jelzi, hogy a megadott sztring ISO 8601 formátumban van-e.

function isDuration(value: string): boolean

Paraméterek

value

string

Az ISO 8601 időtartamformátumban érvényesítendő érték.

Válaszok

boolean

true, ha érvényes, false ellenkező esetben.

isValidUuid(string)

A megadott uuid sztringként való érvényesítése

function isValidUuid(uuid: string): boolean

Paraméterek

uuid

string

Az uuid sztringként, amelyet ellenőrizni kell

Válaszok

boolean

Igaz, ha az uuid érvényes; máskülönben hamis.

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

Paraméterek

logger

any

Válaszok

RequestPolicyFactory

promiseToCallback(Promise<any>)

Figyelmeztetés

Ez az API már elavult.

generated code should instead depend on responseToBody

Az ígéreteket visszahívássá alakítja.

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

Paraméterek

promise

Promise<any>

A visszahívássá konvertálandó ígéret

Válaszok

Function

A visszahívást (cb: függvényt) használó függvény: void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Az ígéreteket szolgáltatásvisszahívássá alakítja.

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

Paraméterek

promise

Promise<HttpOperationResponse>

A HttpOperationResponse szolgáltatásvisszahívássá alakításának ígérete

Válaszok

Function

A szolgáltatás visszahívását fogadó függvény (cb: ServiceCallback<T>): void

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Paraméterek

proxySettings

ProxySettings

Válaszok

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Paraméterek

maximumRetries

number

Válaszok

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

Paraméterek

toSerialize

any

Válaszok

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Paraméterek

authenticationProvider

ServiceClientCredentials

Válaszok

RequestPolicyFactory

stripRequest(WebResourceLike)

A Http-kérelem olyan lecsupaszított verzióját adja vissza, amely nem tartalmazza az Engedélyezési fejlécet.

function stripRequest(request: WebResourceLike): WebResourceLike

Paraméterek

request

WebResourceLike

A Http-kérelem objektum

Válaszok

WebResourceLike

A Http-kérelem lecsupaszított verziója.

stripResponse(HttpOperationResponse)

A Http-válasz egy lecsupaszított verzióját adja vissza, amely csak törzset, fejléceket és állapotot tartalmaz.

function stripResponse(response: HttpOperationResponse): any

Paraméterek

response

HttpOperationResponse

A HTTP-válasz

Válaszok

any

A Http Response lecsupaszított verziója.

systemErrorRetryPolicy(number, number, number, number)

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

Paraméterek

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Válaszok

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Paraméterek

maxRetries

number

Válaszok

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Paraméterek

userAgentData

TelemetryInfo

Válaszok

RequestPolicyFactory