@azure/ms-rest-js package
Osztályok
ApiKeyCredentials |
Api-kulccsal hitelesíti magát egy szolgáltatásban. |
AzureIdentityCredentialAdapter |
Ez az osztály egy egyszerű bővítményt biztosít, amelyet a kódtárból |
BaseRequestPolicy | |
BasicAuthenticationCredentials | |
DefaultHttpClient | |
DomainCredentials |
Api-kulccsal hitelesíti magát egy szolgáltatásban. |
HttpHeaders |
HTTP-fejléckulcs-/értékpárok gyűjteménye. |
RequestPolicyOptions |
Nem kötelező tulajdonságok, amelyek a RequestPolicy létrehozásakor használhatók. |
RestError | |
Serializer | |
ServiceClient | |
TokenCredentials |
Egy hitelesítőadat-objektum, amely jogkivonat-sztringet és szerzői sémát használ a hitelesítéshez. |
TopicCredentials |
Api-kulccsal hitelesíti magá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 |
Az 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 burkolja a kérés indításához szükséges tulajdonságokat. |
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 gyakori polyfills elemeivel. |
AgentSettings |
HTTP- és HTTPS-ügynökök (csak Node.js) |
ApiKeyCredentialOptions | |
BaseMapper | |
CompositeMapper | |
CompositeMapperType | |
DeserializationContentTypes |
Azok a tartalomtípusok, amelyek azt jelzik, hogy a műveleti választ egy adott módon kell deszerializálni. |
DictionaryMapper | |
DictionaryMapperType | |
EnumMapper | |
EnumMapperType | |
HttpClient |
Egy felület, amely httpRequests küldésére és ígéretes HttpResponses fogadására képes. |
HttpHeader |
Egyéni fejléc egy HttpHeaders-gyűjteményben. |
HttpHeadersLike |
HTTP-fejléckulcs-/értékpárok gyűjteménye. |
HttpOperationResponse |
Burkolóobjektum HTTP-kéréshez és -válaszhoz. A deszerializált objektum a tulajdonságban |
HttpPipelineLogger |
HttpPipeline-hoz hozzáadható naplózó. Ez lehetővé teszi, hogy minden RequestPolicy naplózza a hibakeresési célokra használható üzeneteket. |
HttpResponse |
A HTTP-válasz tulajdonságai, amelyek mindig jelen lesznek. |
MapperConstraints | |
OperationArguments |
Egy művelet egyetlen meghívására vonatkozó tulajdonságok gyűjteménye. |
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ével 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 (csak Node.js) |
RedirectOptions |
Az átirányítási válaszok kezelésének beállításai. |
RequestOptionsBase |
A beállításobjektum alapstruktúráját ismerteti, amelyet minden műveletben használni fog. |
RequestPolicy | |
RequestPolicyOptionsLike |
Nem kötelező tulajdonságok, amelyek a RequestPolicy létrehozásakor használhatók. |
RequestPrepareOptions | |
RestResponse |
A REST-hívásra adott egybesimí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 a-ben |
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 új RequestPolicy per-requestt, amely a megadott nextPolicy függvényt 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ésparaméter-értékhez. |
Függvények
Függvény adatai
agentPolicy(AgentSettings)
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory
Paraméterek
- agentSettings
- AgentSettings
Válaszok
applyMixins(any, any[])
A sourceCtors prototípusának tulajdonságainak alkalmazása a targetCtor prototípusára
function applyMixins(targetCtor: any, sourceCtors: any[])
Paraméterek
- targetCtor
-
any
A célobjektum, amelyre a tulajdonságokat alkalmazni kell.
- sourceCtors
-
any[]
Forrásobjektumok tömbje, amelyekből a tulajdonságokat el kell venni.
delay<T>(number, T)
A setTimeout burkolója, amely t 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
A feloldandó érték t ezredmásodperc időkorlát után.
Válaszok
Promise<T>
Megoldott ígéret
deserializationPolicy(DeserializationContentTypes)
Hozzon létre egy új szerializálást RequestPolicyCreator, amely szerializálja a HTTP-kéréstörzseket a HTTP-folyamaton áthaladva.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory
Paraméterek
- deserializationContentTypes
- DeserializationContentTypes
Válaszok
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)
Sorra hajtja végre az ígéretek tömböt. Ennek a módszernek az inspirációja a következő: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Egy fantasztikus blog ígéretek!
function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>
Paraméterek
- promiseFactories
-
any[]
Ígéretgyárak tömbje (Egy függvény, amely ígéretet ad vissza)
- 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>
Megoldott vagy elutasított ígéretek láncolata
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
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse
Paraméterek
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
Válaszok
generateClientRequestIdPolicy(string)
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory
Paraméterek
- requestIdHeaderName
-
string
Válaszok
generateUuid()
Generált UUID
function generateUuid(): string
Válaszok
string
RFC4122 v4 UUID.
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átumához érvényesítendő érték.
Válaszok
boolean
true
ha érvényes, false
egyéb 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; hamis egyéb esetben.
logPolicy(any)
function logPolicy(logger?: any): RequestPolicyFactory
Paraméterek
- logger
-
any
Válaszok
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á alakítandó í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éretet szolgáltatásvisszahívássá alakítja át.
function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function
Paraméterek
- promise
-
Promise<HttpOperationResponse>
A HttpOperationResponse ígérete szolgáltatásvisszahívássá alakítása
Válaszok
Function
A szolgáltatás visszahívását (cb: ServiceCallback) átvenni kívánt függvény: void
proxyPolicy(ProxySettings)
function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory
Paraméterek
- proxySettings
- ProxySettings
Válaszok
redirectPolicy(number)
function redirectPolicy(maximumRetries?: number): RequestPolicyFactory
Paraméterek
- maximumRetries
-
number
Válaszok
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
stripRequest(WebResourceLike)
A Http-kérelem egy olyan csíkozott 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
A Http-kérelem lecsupaszított verziója.
stripResponse(HttpOperationResponse)
A Http-válasz egy csíkozott 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-válasz 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
throttlingRetryPolicy(number)
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory
Paraméterek
- maxRetries
-
number
Válaszok
userAgentPolicy(TelemetryInfo)
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory
Paraméterek
- userAgentData
- TelemetryInfo