@azure/core-http package

Klassen

AccessTokenRefresher	Helpt het verificatiebeleid voor core-http-token bij het aanvragen van een nieuw token als we momenteel niet op een nieuw token wachten.
ApiKeyCredentials	Verifieert bij een service met behulp van een API-sleutel.
BaseRequestPolicy	De basisklasse waaruit alle aanvraagbeleidsregels zijn afgeleid.
BasicAuthenticationCredentials	Een eenvoudige <xref:ServiceClientCredential> die wordt geverifieerd met een gebruikersnaam en een wachtwoord.
DefaultHttpClient	Een HTTP-client die gebruikmaakt van node-fetch.
ExpiringAccessTokenCache	Biedt een AccessTokenCache-implementatie die de in de cache opgeslagen AccessToken wist nadat de expiresOnTimestamp is doorgegeven.
HttpHeaders	Een verzameling http-headersleutel-waardeparen.
RequestPolicyOptions	Optionele eigenschappen die kunnen worden gebruikt bij het maken van een RequestPolicy.
RestError	Een fout die het gevolg is van een HTTP-aanvraag naar een service-eindpunt.
Serializer	Wordt gebruikt om onbewerkte antwoordobjecten toe te wijzen aan uiteindelijke shapes. Helpt bij het verpakken en uitpakken van datums en andere gecodeerde typen die niet inherent zijn aan JSON. U kunt ook waarden ophalen uit headers en standaardwaarden en constanten invoegen.
ServiceClient	ServiceClient verzendt serviceaanvragen en ontvangt antwoorden.
TopicCredentials	Een TopicCredentials-object dat wordt gebruikt voor Azure Event Grid.
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.
AccessToken	Vertegenwoordigt een toegangstoken met een verlooptijd.
AccessTokenCache	Biedt een cache voor een AccessToken dat is geretourneerd door een TokenCredential.
ApiKeyCredentialOptions	Beschrijft de opties die moeten worden opgegeven bij het maken van een exemplaar van ApiKeyCredentials
BaseMapper	De basisdefinitie van een mapper. Kan worden gebruikt voor XML- en Gewone JavaScript-objecten.
CompositeMapper	Een mapper bestaande uit andere mappers.
CompositeMapperType	Helpt bij het bouwen van een mapper die beschrijft hoe u een set eigenschappen van een object kunt toewijzen op basis van andere mappers. Er mag slechts een van de volgende eigenschappen aanwezig zijn: className, modelProperties en additionalProperties.
DeserializationContentTypes	De inhoudstypen die aangeven dat een bewerkingsreactie op een bepaalde manier moet worden gedeserialiseerd.
DeserializationOptions	Opties voor het configureren van API-antwoorddeserialisatie.
DictionaryMapper	Een mapper die gewone JavaScript-objecten beschrijft die worden gebruikt als sleutel-waardeparen.
DictionaryMapperType	Helpt bij het bouwen van een mapper die beschrijft hoe u een woordenlijst met toegewezen waarden kunt parseren.
EnumMapper	Een mapper die een opsommingswaarde beschrijft.
EnumMapperType	Helpt bij het bouwen van een mapper die beschrijft hoe u een enum-waarde kunt parseren.
GetTokenOptions	Definieert opties voor TokenCredential.getToken.
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.
InternalPipelineOptions	Definieert opties die worden gebruikt voor het configureren van interne opties van de HTTP-pijplijn voor een SDK-client.
KeepAliveOptions	Opties voor hoe HTTP-verbindingen moeten worden onderhouden voor toekomstige aanvragen.
LogPolicyOptions	Opties om door te geven aan de logPolicy. Standaard wordt alleen een ingestelde lijst met headers geregistreerd, hoewel dit wel kan worden geconfigureerd. Aanvraag- en antwoordteksten worden nooit geregistreerd.
MapperConstraints	Beschrijving van verschillende waardebeperkingen, zoals bereiken met gehele getallen en tekenreeks regex.
OperationArguments	Een verzameling eigenschappen die van toepassing zijn op één aanroep van een bewerking.
OperationOptions	Het type basisopties voor alle bewerkingen.
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.
OperationRequestOptions	Opties voor het configureren van de verwerking van HTTP-aanvragen die worden gemaakt door een SDK-bewerking.
OperationResponse	Een OperationResponse die kan worden geretourneerd vanuit een bewerkingsaanvraag voor één statuscode.
OperationSpec	Een specificatie die definieert hoe een bepaalde servicebewerking via HTTP moet worden uitgevoerd, waaronder het correct serialiseren van aanvraaggegevens in en het deserialiseren van antwoordgegevens in een objectpayload die kan worden geretourneerd door de ServiceClient.
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
PipelineOptions	Hiermee definieert u opties die worden gebruikt voor het configureren van de HTTP-pijplijn voor een SDK-client.
PolymorphicDiscriminator	Wordt gebruikt om onderscheid te maken tussen unions van het type. Als een antwoord bijvoorbeeld veel shapes kan hebben, maar ook een 'soort' veld (of iets dergelijks) bevat, kan dat veld worden gebruikt om te bepalen hoe het antwoord moet worden gedeserialiseerd naar het juiste type.
ProxySettings	Opties voor het configureren van een proxy voor uitgaande aanvragen (alleen Node.js).
RedirectOptions	Opties voor hoe omleidingsreacties worden verwerkt.
RequestOptionsBase	Beschrijft de basisstructuur van het optieobject dat in elke bewerking wordt gebruikt.
RequestPolicy	De onderliggende structuur van een aanvraagbeleid.
RequestPolicyOptionsLike	Optionele eigenschappen die kunnen worden gebruikt bij het maken van een RequestPolicy.
RequestPrepareOptions	Opties voor het voorbereiden van een uitgaande HTTP-aanvraag.
RestResponse	Het afgevlakte antwoord op een REST-aanroep. Bevat de onderliggende HttpOperationResponse en de samengevoegde eigenschappen van , parsedBodyparsedHeaders, enzovoort.
RetryOptions	Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.
SequenceMapper	Een mapper die matrices beschrijft.
SequenceMapperType	Helpt bij het bouwen van een mapper die beschrijft hoe u een reeks toegewezen waarden kunt parseren.
SerializerOptions	Opties voor het beheren van het gedrag van xml-parser en opbouwfunctie.
ServiceCallback
ServiceClientCredentials	Vertegenwoordigt een object of klasse met een signRequest methode waarmee uitgaande aanvragen worden ondertekend (bijvoorbeeld door de Authorization header in te stellen).
ServiceClientOptions	Opties die moeten worden opgegeven tijdens het maken van de client.
SimpleMapperType	Het type van een eenvoudige mapper.
TokenCredential	Vertegenwoordigt een referentie die een verificatietoken kan leveren.
TracingPolicyOptions	Opties voor het aanpassen van het traceringsbeleid.
UrlParameterValue	Een interface die een URL-parameterwaarde vertegenwoordigt.
UserAgentOptions	Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.
WebResourceLike	Een beschrijving van een HTTP-aanvraag die moet worden ingediend bij een externe server.

Type-aliassen

Authenticator	Een functie die een uitdaging ontvangt en een promise oplost met een tekenreekstoken.
CommonRequestInfo	Tekenreeks-URL's die worden gebruikt bij het aanroepen van fetch().
CommonRequestInit	Een object met informatie over de uitgaande HTTP-aanvraag.
CommonResponse	Een object met informatie over het binnenkomende HTTP-antwoord.
HttpMethods	Lijst met ondersteunde HTTP-methoden.
HttpRequestBody	Mogelijke typen HTTP-aanvraagbody
Mapper	Mappers zijn definities van de gegevensmodellen die in de bibliotheek worden gebruikt. Deze gegevensmodellen maken deel uit van de bewerkings- of clientdefinities in de antwoorden of parameters.
MapperType	Type van de mapper. Bevat bekende mappers.
ParameterPath	Een pad dat beschrijft hoe u toegang krijgt tot een bepaalde eigenschap in een bepaalde objectgegevensbron. Dit kan één eigenschapsnaam zijn, een matrix die geneste eigenschapsnamen aandukt of een set met meerdere benoemde eigenschappen met paden in het geval van complexe objectwaarden.
ProxyOptions	Een alias van ProxySettings voor toekomstig gebruik.
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	Telemetriegegevens. Sleutel-waardeparen die moeten worden opgenomen in de User-Agent tekenreeks.
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.
RetryMode	Beschrijft het type Modus voor opnieuw proberen. Momenteel wordt alleen Exponentieel ondersteund.

Functies

applyMixins(unknown, any[])	De eigenschappen van het prototype van sourceCtors toepassen op het prototype van targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	Hiermee maakt u een nieuwe factory voor een RequestPolicy die een bearer-token toepast op de headers van Authorization de aanvragen.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Hiermee maakt u een HTTP-pijplijn op basis van de opgegeven opties.
delay(number, DelayOptions)	Een wrapper voor setTimeout waarmee een promise na timeInMs milliseconden wordt omgezet.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Maak een nieuwe serialisatie RequestPolicyCreator waarmee HTTP-aanvraagbody's worden geserialiseerd wanneer ze de HTTP-pijplijn passeren.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Op basis van een bepaalde set inhoudstypen die moeten worden geparseerd als JSON of XML, wordt het HTTP-antwoord gebruikt om het resultaatobject te produceren dat is gedefinieerd door de OperationSpec van de aanvraag.
disableResponseDecompressionPolicy()	Retourneert een aanvraagbeleidsfactory die kan worden gebruikt om een exemplaar van <xref:DisableResponseDecompressionPolicy>te maken.
encodeUri(string)	Codeert een URI.
executePromisesSequentially(any[], unknown)	Hiermee wordt een matrix van beloftes 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 beloftes!
exponentialRetryPolicy(number, number, number)	Beleid waarmee de aanvraag zo vaak opnieuw wordt geprobeerd als is geconfigureerd, zolang het maximale interval voor opnieuw proberen is opgegeven. Elke nieuwe poging wacht langer om te beginnen dan de laatste keer.
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	Parseert een HttpOperationResponse in een genormaliseerd HTTP-antwoordobject (RestResponse).
generateClientRequestIdPolicy(string)	Hiermee maakt u een beleid waarmee een unieke aanvraag-id wordt toegewezen aan uitgaande aanvragen.
generateUuid()	Gegenereerde UUID
getDefaultProxySettings(string)	Converteert een opgegeven URL van een proxyserver naar ProxySettings of probeert op te halen ProxySettings uit de huidige omgeving als deze niet wordt doorgegeven.
getDefaultUserAgentValue()	De standaardbenadering voor het genereren van gebruikersagents. Maakt gebruik van statische informatie uit dit pakket, plus systeeminformatie die beschikbaar is via de runtime.
isDuration(string)	Geeft aan of de opgegeven tekenreeks de ISO 8601-indeling heeft.
isTokenCredential(unknown)	Test een object om te bepalen of TokenCredential wordt geïmplementeerd.
isValidUuid(string)	Valideert de opgegeven uuid als een tekenreeks
keepAlivePolicy(KeepAliveOptions)	Hiermee maakt u een beleid dat bepaalt of HTTP-verbindingen worden onderhouden voor toekomstige aanvragen.
logPolicy(LogPolicyOptions)	Hiermee maakt u een beleid dat informatie over de uitgaande aanvraag en de binnenkomende antwoorden registreert.
operationOptionsToRequestOptionsBase<T>(T)	Converteert een OperationOptions naar een RequestOptionsBase
parseXML(string, SerializerOptions)	Converteert de opgegeven XML-tekenreeks naar JSON
promiseToCallback(Promise<any>)	Converteert een Promise naar een callback.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Converteert een Promise naar een service-callback.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Een beleid waarmee proxy-instellingen kunnen worden toegepast op alle aanvragen. Als de statische instellingen niet worden doorgegeven, worden deze opgehaald uit de omgevingsvariabelen HTTPS_PROXY of HTTP_PROXY.
redirectPolicy(number)	Hiermee maakt u een omleidingsbeleid, dat een herhaalt de aanvraag naar een nieuwe bestemming verzendt als een antwoord binnenkomt met een 'locatie'-header en een statuscode tussen 300 en 307.
serializeObject(unknown)	Hulpprogrammafunctie waarmee een object dat binaire informatie kan bevatten, wordt geserialiseerd in een object, matrix of tekenreeks.
signingPolicy(ServiceClientCredentials)	Hiermee maakt u een beleid waarmee uitgaande aanvragen worden ondertekend door de opgegeven authenticationProvidersignRequest methode aan te roepen.
stringifyXML(unknown, SerializerOptions)	Converteert een bepaald JSON-object naar EEN XML-tekenreeks
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)	Een beleid dat opnieuw probeert wanneer er een systeemfout optreedt, geïdentificeerd door de codes 'ETIMEDOUT', 'ESOCKETTIMEDOUT', 'ECONNREFUSED', 'ECONNRESET' of 'ENOENT'.
throttlingRetryPolicy()	Hiermee maakt u een beleid waarmee de aanvraag opnieuw wordt verzonden als het antwoord aangeeft dat de aanvraag is mislukt vanwege beperkingsredenen. Als het antwoord bijvoorbeeld een Retry-After header bevat, wordt de aanvraag opnieuw verzonden op basis van de waarde van die header. Raadpleeg https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsvoor meer informatie , https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits en https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Hiermee maakt u een beleid waarmee uitgaande aanvragen worden verpakt met een traceringsbereik.
userAgentPolicy(TelemetryInfo)	Retourneert een beleid waarmee de header van de gebruikersagent wordt toegevoegd aan uitgaande aanvragen op basis van de opgegeven TelemetryInfo.

Functiedetails

applyMixins(unknown, any[])

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

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Parameters

targetCtorParam

unknown

sourceCtors

any[]

Een matrix van bronobjecten waaruit de eigenschappen moeten worden overgenomen.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Hiermee maakt u een nieuwe factory voor een RequestPolicy die een bearer-token toepast op de headers van Authorization de aanvragen.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Parameters

credential

TokenCredential

De TokenCredential-implementatie die het bearer-token kan leveren.

scopes

string | string[]

De bereiken waarvoor het bearer-token van toepassing is.

Retouren

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Hiermee maakt u een HTTP-pijplijn op basis van de opgegeven opties.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Parameters

pipelineOptions

InternalPipelineOptions

Definieert opties die worden gebruikt voor het configureren van beleid in de HTTP-pijplijn voor een SDK-client.

authPolicyFactory

RequestPolicyFactory

Een optionele verificatiebeleidsfactory die moet worden gebruikt voor ondertekeningsaanvragen.

Retouren

ServiceClientOptions

Een set opties die kunnen worden doorgegeven om een nieuwe ServiceClient te maken.

delay(number, DelayOptions)

Een wrapper voor setTimeout waarmee een promise na timeInMs milliseconden wordt omgezet.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Parameters

timeInMs

number

Het aantal milliseconden dat moet worden vertraagd.

options

DelayOptions

De opties voor vertraging - momenteel opties afbreken

Retouren

Promise<void>

Belofte die is opgelost na timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

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

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parameters

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

Retouren

RequestPolicyFactory

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

Op basis van een bepaalde set inhoudstypen die moeten worden geparseerd als JSON of XML, wordt het HTTP-antwoord gebruikt om het resultaatobject te produceren dat is gedefinieerd door de OperationSpec van de aanvraag.

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

Parameters

jsonContentTypes

string[]

Antwoordinhoudstypen om de hoofdtekst te parseren als JSON.

xmlContentTypes

string[]

Antwoordinhoudstypen om de hoofdtekst te parseren als XML.

response

HttpOperationResponse

HTTP-antwoord van de pijplijn.

options

SerializerOptions

Opties voor de serializer, meestal voor het configureren van de XML-parser indien nodig.

Retouren

Promise<HttpOperationResponse>

Een geparseerd HttpOperationResponse-object dat kan worden geretourneerd door de ServiceClient.

disableResponseDecompressionPolicy()

Retourneert een aanvraagbeleidsfactory die kan worden gebruikt om een exemplaar van <xref:DisableResponseDecompressionPolicy>te maken.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Retouren

RequestPolicyFactory

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[], unknown)

Hiermee wordt een matrix van beloftes 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 beloftes!

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

Parameters

promiseFactories

any[]

Een matrix met beloftefactory's (een functie die een belofte retourneert)

kickstart

unknown

Invoer voor de eerste belofte die wordt gebruikt om de belofteketen een kickstart te geven. Als deze niet is opgegeven, begint de belofteketen met niet-gedefinieerd.

Retouren

Promise<any>

Een keten van opgeloste of afgewezen beloftes

exponentialRetryPolicy(number, number, number)

Beleid waarmee de aanvraag zo vaak opnieuw wordt geprobeerd als is geconfigureerd, zolang het maximale interval voor opnieuw proberen is opgegeven. Elke nieuwe poging wacht langer om te beginnen dan de laatste keer.

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

Parameters

retryCount

number

Maximum aantal nieuwe pogingen.

retryInterval

number

Basistijd tussen nieuwe pogingen.

maxRetryInterval

number

Maximale tijd om te wachten tussen nieuwe pogingen.

Retouren

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parseert een HttpOperationResponse in een genormaliseerd HTTP-antwoordobject (RestResponse).

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

Parameters

_response

HttpOperationResponse

Wrapper-object voor HTTP-antwoord.

responseSpec

undefined | OperationResponse

Mappers voor het parseren van de antwoordeigenschappen.

Retouren

RestResponse

• Een genormaliseerd antwoordobject.

generateClientRequestIdPolicy(string)

Hiermee maakt u een beleid waarmee een unieke aanvraag-id wordt toegewezen aan uitgaande aanvragen.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parameters

requestIdHeaderName

string

De naam van de header die moet worden gebruikt bij het toewijzen van de unieke id aan de aanvraag.

Retouren

RequestPolicyFactory

generateUuid()

Gegenereerde UUID

function generateUuid(): string

Retouren

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Converteert een opgegeven URL van een proxyserver naar ProxySettings of probeert op te halen ProxySettings uit de huidige omgeving als deze niet wordt doorgegeven.

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

Parameters

proxyUrl

string

URL van de proxy

Retouren

ProxySettings | undefined

De standaardproxy-instellingen of niet gedefinieerd.

getDefaultUserAgentValue()

De standaardbenadering voor het genereren van gebruikersagents. Maakt gebruik van statische informatie uit dit pakket, plus systeeminformatie die beschikbaar is via de runtime.

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.

isTokenCredential(unknown)

Test een object om te bepalen of TokenCredential wordt geïmplementeerd.

function isTokenCredential(credential: unknown): credential

Parameters

credential

unknown

De veronderstelde TokenCredential die moet worden getest.

Retouren

credential

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.

keepAlivePolicy(KeepAliveOptions)

Hiermee maakt u een beleid dat bepaalt of HTTP-verbindingen worden onderhouden voor toekomstige aanvragen.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parameters

keepAliveOptions

KeepAliveOptions

Keep Alive-opties. Http-verbindingen worden standaard onderhouden voor toekomstige aanvragen.

Retouren

RequestPolicyFactory

Een exemplaar van de <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Hiermee maakt u een beleid dat informatie over de uitgaande aanvraag en de binnenkomende antwoorden registreert.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parameters

loggingOptions

LogPolicyOptions

Opties voor logboekregistratie.

Retouren

RequestPolicyFactory

Een exemplaar van de <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Converteert een OperationOptions naar een RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Parameters

opts

T

OperationOptions-object om te converteren naar RequestOptionsBase

Retouren

RequestOptionsBase

parseXML(string, SerializerOptions)

Converteert de opgegeven XML-tekenreeks naar JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Parameters

str

string

Tekenreeks met de XML-inhoud die moet worden geparseerd in JSON

opts

SerializerOptions

Opties voor het parseren van een bepaalde XML-tekenreeks

Retouren

Promise<any>

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>): (cb: Function) => void

Parameters

promise

Promise<any>

De belofte die moet worden geconverteerd naar een callback

Retouren

(cb: Function) => void

Een functie die de callback overneemt (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Converteert een Promise naar een service-callback.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

Parameters

promise

Promise<HttpOperationResponse>

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

Retouren

(cb: ServiceCallback<T>) => void

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

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Een beleid waarmee proxy-instellingen kunnen worden toegepast op alle aanvragen. Als de statische instellingen niet worden doorgegeven, worden deze opgehaald uit de omgevingsvariabelen HTTPS_PROXY of HTTP_PROXY.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): RequestPolicyFactory

Parameters

proxySettings

ProxySettings

ProxySettings te gebruiken voor elke aanvraag.

options

{ customNoProxyList?: string[] }

aanvullende instellingen, bijvoorbeeld aangepaste NO_PROXY patronen

Retouren

RequestPolicyFactory

redirectPolicy(number)

Hiermee maakt u een omleidingsbeleid, dat een herhaalt de aanvraag naar een nieuwe bestemming verzendt als een antwoord binnenkomt met een 'locatie'-header en een statuscode tussen 300 en 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameters

maximumRetries

number

Maximum aantal omleidingen dat moet worden gevolgd.

Retouren

RequestPolicyFactory

Een exemplaar van de <xref:RedirectPolicy>

serializeObject(unknown)

Hulpprogrammafunctie waarmee een object dat binaire informatie kan bevatten, wordt geserialiseerd in een object, matrix of tekenreeks.

function serializeObject(toSerialize: unknown): any

Parameters

toSerialize

unknown

Retouren

any

signingPolicy(ServiceClientCredentials)

Hiermee maakt u een beleid waarmee uitgaande aanvragen worden ondertekend door de opgegeven authenticationProvidersignRequest methode aan te roepen.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameters

authenticationProvider

ServiceClientCredentials

De verificatieprovider.

Retouren

RequestPolicyFactory

Een exemplaar van de <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Converteert een bepaald JSON-object naar EEN XML-tekenreeks

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Parameters

obj

unknown

JSON-object dat moet worden geconverteerd naar XML-tekenreeks

opts

SerializerOptions

Opties voor het parseren van een bepaald JSON-object

Retouren

string

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)

Een beleid dat opnieuw probeert wanneer er een systeemfout optreedt, geïdentificeerd door de codes 'ETIMEDOUT', 'ESOCKETTIMEDOUT', 'ECONNREFUSED', 'ECONNRESET' of 'ENOENT'.

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

Parameters

retryCount

number

Maximum aantal nieuwe pogingen.

retryInterval

number

Het interval voor opnieuw proberen van de client, in milliseconden.

minRetryInterval

number

Het minimale interval voor opnieuw proberen, in milliseconden.

maxRetryInterval

number

Het maximale interval voor opnieuw proberen, in milliseconden.

Retouren

RequestPolicyFactory

Een exemplaar van de <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Hiermee maakt u een beleid waarmee de aanvraag opnieuw wordt verzonden als het antwoord aangeeft dat de aanvraag is mislukt vanwege beperkingsredenen. Als het antwoord bijvoorbeeld een Retry-After header bevat, wordt de aanvraag opnieuw verzonden op basis van de waarde van die header.

Raadpleeg https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limitsvoor meer informatie , https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits en https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Retouren

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Hiermee maakt u een beleid waarmee uitgaande aanvragen worden verpakt met een traceringsbereik.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parameters

tracingOptions

TracingPolicyOptions

Traceringsopties.

Retouren

RequestPolicyFactory

Een exemplaar van de <xref:TracingPolicy> klasse.

userAgentPolicy(TelemetryInfo)

Retourneert een beleid waarmee de header van de gebruikersagent wordt toegevoegd aan uitgaande aanvragen op basis van de opgegeven TelemetryInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameters

userAgentData

TelemetryInfo

Telemetriegegevens.

Retouren

RequestPolicyFactory

Een nieuwe <xref:UserAgentPolicy>.