Delen via

@azure/ms-rest-js package

  • Referentie

Klassen

ApiKeyCredentials

Verifieert bij een service met behulp van een API-sleutel.
AzureIdentityCredentialAdapter

Deze klasse biedt een eenvoudige extensie die vanuit @azure/identity de bibliotheek kan worden gebruikt <xref:TokenCredential> voor gebruik met verouderde Azure SDK's die serviceClientCredentials-referenties voor verificatie accepteren.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

Verifieert bij een service met behulp van een API-sleutel.
HttpHeaders

Een verzameling http-headersleutel-waardeparen.
RequestPolicyOptions

Optionele eigenschappen die kunnen worden gebruikt bij het maken van een RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials

Een referentieobject dat een tokentekenreeks en een ontwerpschema gebruikt om te verifiëren.
TopicCredentials

Verifieert bij een service met behulp van een API-sleutel.
URLBuilder

Een klasse die het maken, wijzigen en parseren van URL's verwerkt.
URLQuery

Een klasse die het querygedeelte van een URLBuilder verwerkt.
WebResource

Hiermee maakt u een nieuw WebResource-object.

Deze klasse biedt een abstractie over een REST-aanroep door bibliotheek-/implementatieneutraal te zijn en de benodigde eigenschappen te verpakken om een aanvraag te starten.

Interfaces

AbortSignalLike

Hiermee staat u toe dat de aanvraag wordt afgebroken wanneer de gebeurtenis 'afbreken' wordt geactiveerd. Compatibel met de in de browser ingebouwde AbortSignal en algemene polyfills.
AgentSettings

HTTP- en HTTPS-agents (alleen Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

De inhoudstypen die aangeven dat een bewerkingsreactie op een bepaalde manier moet worden gedeserialiseerd.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

Een interface die HttpRequests kan verzenden en beloofde HttpResponses kan ontvangen.
HttpHeader

Een afzonderlijke header binnen een HttpHeaders-verzameling.
HttpHeadersLike

Een verzameling http-headersleutel-waardeparen.
HttpOperationResponse

Wrapper-object voor http-aanvraag en -antwoord. Het gedeserialiseerde object wordt opgeslagen in de parsedBody eigenschap wanneer de hoofdtekst van het antwoord wordt ontvangen in JSON of XML.
HttpPipelineLogger

Een logger die kan worden toegevoegd aan een HttpPipeline. Hierdoor kan elke RequestPolicy berichten registreren die kunnen worden gebruikt voor foutopsporing.
HttpResponse

De eigenschappen van een HTTP-antwoord die altijd aanwezig zijn.
MapperConstraints
OperationArguments

Een verzameling eigenschappen die van toepassing zijn op één aanroep van een bewerking.
OperationParameter

Een algemene interface die alle bewerkingsparameter's uitbreiden.
OperationQueryParameter

Een parameter voor een bewerking die als queryparameter wordt toegevoegd aan de HTTP-aanvraag van de bewerking.
OperationResponse

Een OperationResponse die kan worden geretourneerd vanuit een bewerkingsaanvraag voor één statuscode.
OperationSpec

Een specificatie die een bewerking definieert.
OperationURLParameter

Een parameter voor een bewerking die wordt vervangen door de aanvraag-URL van de bewerking.
ParameterValue

De parameterwaarde die is opgegeven voor pad- of queryparameters in RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings

HTTP-proxyinstellingen (alleen Node.js)
RedirectOptions

Opties voor hoe omleidingsreacties worden verwerkt.
RequestOptionsBase

Beschrijft de basisstructuur van het optieobject dat in elke bewerking wordt gebruikt.
RequestPolicy
RequestPolicyOptionsLike

Optionele eigenschappen die kunnen worden gebruikt bij het maken van een RequestPolicy.
RequestPrepareOptions
RestResponse

Het afgevlakte antwoord op een REST-aanroep. Bevat de onderliggende HttpOperationResponse en de samengevoegde eigenschappen van de parsedBody, parsedHeaders, enzovoort.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Opties die moeten worden opgegeven tijdens het maken van de client.
SimpleMapperType
TokenResponse

TokenResponse is gedefinieerd in @azure/ms-rest-nodeauth en wordt hier gekopieerd om geen onnodige afhankelijkheid toe te voegen.
UrlParameterValue
WebResourceLike

Een abstractie van een REST-aanroep.

Type-aliassen

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

Een HttpHeaders-verzameling die wordt weergegeven als een eenvoudig JSON-object.
RequestPolicyFactory

Hiermee maakt u een nieuwe RequestPolicy per aanvraag die gebruikmaakt van de opgegeven nextPolicy.
TelemetryInfo
TransferProgressEvent

Geactiveerd als reactie op de voortgang van uploaden of downloaden.

Enums

HttpPipelineLogLevel

De verschillende niveaus van logboeken die kunnen worden gebruikt met de HttpPipelineLogger.
QueryCollectionFormat

De indeling die wordt gebruikt om een matrix met waarden samen te voegen voor een queryparameterwaarde.

Functies

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

De eigenschappen van het prototype van sourceCtors toepassen op het prototype van targetCtor
delay<T>(number, T)

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.
deserializationPolicy(DeserializationContentTypes)

Maak een nieuwe serialisatie RequestPolicyCreator waarmee HTTP-aanvraagbody's worden geserialiseerd wanneer ze de HTTP-pijplijn passeren.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

Codeert een URI.
executePromisesSequentially(any[], any)

Hiermee wordt een matrix met beloften opeenvolgend uitgevoerd. Inspiratie voor deze methode is hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Een geweldige blog over beloften!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

Gegenereerde UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

Geeft aan of de opgegeven tekenreeks de ISO 8601-indeling heeft.
isValidUuid(string)

Valideert de opgegeven uuid als een tekenreeks
logPolicy(any)
promiseToCallback(Promise<any>)

Converteert een Promise naar een callback.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converteert een Promise naar een service-callback.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

Retourneert een gestripte versie van de HTTP-aanvraag die geen autorisatieheader bevat.
stripResponse(HttpOperationResponse)

Retourneert een gestripte versie van het HTTP-antwoord die alleen de hoofdtekst, headers en de status bevat.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Functiedetails

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parameters

agentSettings
AgentSettings

Retouren

RequestPolicyFactory

applyMixins(any, any[])

De eigenschappen van het prototype van sourceCtors toepassen op het prototype van targetCtor

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

Parameters

targetCtor

any

Het doelobject waarop de eigenschappen moeten worden toegepast.

sourceCtors

any[]

Een matrix van bronobjecten waaruit de eigenschappen moeten worden overgenomen.

delay<T>(number, T)

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.

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

Parameters

t

number

Het aantal milliseconden dat moet worden vertraagd.

value

T

De waarde waarmee moet worden omgezet na een time-out van t milliseconden.

Retouren

Promise<T>

Opgeloste belofte

deserializationPolicy(DeserializationContentTypes)

Maak een nieuwe serialisatie RequestPolicyCreator waarmee HTTP-aanvraagbody's worden geserialiseerd wanneer ze de HTTP-pijplijn passeren.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parameters

deserializationContentTypes
DeserializationContentTypes

Retouren

RequestPolicyFactory

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

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

Parameters

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

Retouren

Promise<HttpOperationResponse>

encodeUri(string)

Codeert een URI.

function encodeUri(uri: string): string

Parameters

uri

string

De URI die moet worden gecodeerd.

Retouren

string

De gecodeerde URI.

executePromisesSequentially(any[], any)

Hiermee wordt een matrix met beloften opeenvolgend uitgevoerd. Inspiratie voor deze methode is hier: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Een geweldige blog over beloften!

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

Parameters

promiseFactories

any[]

Een matrix van promise factory's (een functie die een belofte retourneert)

kickstart

any

Invoer voor de eerste promise die wordt gebruikt om de promise-keten een kickstart te geven. Als deze niet wordt opgegeven, begint de promise-keten met undefined.

Retouren

Promise<any>

Een keten van opgeloste of afgewezen beloften

exponentialRetryPolicy(number, number, number, number) 

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

Parameters

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Retouren

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Parameters

_response
HttpOperationResponse
responseSpec

undefined | OperationResponse

Retouren

RestResponse

generateClientRequestIdPolicy(string) 

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parameters

requestIdHeaderName

string

Retouren

RequestPolicyFactory

generateUuid()

Gegenereerde UUID

function generateUuid(): string

Retouren

string

RFC4122 v4 UUID.

getDefaultProxySettings(string) 

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

Parameters

proxyUrl

string

Retouren

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

Retouren

string

isDuration(string)

Geeft aan of de opgegeven tekenreeks de ISO 8601-indeling heeft.

function isDuration(value: string): boolean

Parameters

value

string

De waarde die moet worden gevalideerd voor DE ISO 8601-duurnotatie.

Retouren

boolean

true indien geldig, false anders.

isValidUuid(string)

Valideert de opgegeven uuid als een tekenreeks

function isValidUuid(uuid: string): boolean

Parameters

uuid

string

De uuid als een tekenreeks die moet worden gevalideerd

Retouren

boolean

Waar als de uuid geldig is; anders onwaar.

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Parameters

logger

any

Retouren

RequestPolicyFactory

promiseToCallback(Promise<any>)

Waarschuwing

Deze API is nu afgeschaft.

generated code should instead depend on responseToBody

Converteert een Promise naar een callback.

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

Parameters

promise

Promise<any>

De belofte die moet worden geconverteerd naar een callback

Retouren

Function

Een functie die de callback (cb: functie): void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converteert een Promise naar een service-callback.

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

Parameters

promise

Promise<HttpOperationResponse>

De belofte van HttpOperationResponse die moet worden geconverteerd naar een service-callback

Retouren

Function

Een functie die de callback van de service (cb: ServiceCallback): void

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parameters

proxySettings
ProxySettings

Retouren

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameters

maximumRetries

number

Retouren

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Parameters

toSerialize

any

Retouren

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameters

authenticationProvider
ServiceClientCredentials

Retouren

RequestPolicyFactory

stripRequest(WebResourceLike)

Retourneert een gestripte versie van de HTTP-aanvraag die geen autorisatieheader bevat.

function stripRequest(request: WebResourceLike): WebResourceLike

Parameters

request
WebResourceLike

Het http-aanvraagobject

Retouren

WebResourceLike

De gestripte versie van HTTP-aanvraag.

stripResponse(HttpOperationResponse)

Retourneert een gestripte versie van het HTTP-antwoord die alleen de hoofdtekst, headers en de status bevat.

function stripResponse(response: HttpOperationResponse): any

Parameters

response
HttpOperationResponse

Het HTTP-antwoord

Retouren

any

De gestripte versie van HTTP-antwoord.

systemErrorRetryPolicy(number, number, number, number) 

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

Parameters

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

Retouren

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parameters

maxRetries

number

Retouren

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameters

userAgentData
TelemetryInfo

Retouren

RequestPolicyFactory