@azure/core-rest-pipeline package

Klassen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Interfaces

AddPipelineOptions	Opties bij het toevoegen van een beleid aan de pijplijn. Wordt gebruikt om afhankelijkheden van andere beleidsregels uit te drukken.
Agent	Een interface die compatibel is met nodeJS's http.Agent. We willen voorkomen dat de werkelijke interface openbaar opnieuw wordt geëxporteerd, omdat deze kan variëren tussen runtimeversies.
AuthorizeRequestOnChallengeOptions	Opties die zijn verzonden naar de callback authorizeRequestOnChallenge
AuthorizeRequestOptions	Opties die zijn verzonden naar de callback authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Opties voor het configureren van de auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Opties voor het configureren van het bearerTokenAuthenticationPolicy
ChallengeCallbacks	Opties voor het overschrijven van de verwerking van uitdagingen voor continue toegangsevaluatie .
DefaultRetryPolicyOptions	Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.
ExponentialRetryPolicyOptions	Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.
HttpClient	De vereiste interface voor een client die HTTP-aanvragen namens een pijplijn doet.
HttpHeaders	Vertegenwoordigt een set HTTP-headers voor een aanvraag/antwoord. Headernamen worden behandeld als niet-hoofdlettergevoelig.
InternalPipelineOptions	Definieert opties die worden gebruikt voor het configureren van interne opties van de HTTP-pijplijn voor een SDK-client.
KeyObject	Een interface die compatibel is met nodeJS's tls.KeyObject. We willen voorkomen dat de werkelijke interface openbaar opnieuw wordt geëxporteerd, omdat deze kan variëren tussen runtimeversies.
LogPolicyOptions	Opties voor het configureren van de logPolicy.
Pipeline	Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het manipuleren van elke aanvraag voor en nadat deze naar de server is verzonden.
PipelineOptions	Hiermee definieert u opties die worden gebruikt voor het configureren van de HTTP-pijplijn voor een SDK-client.
PipelinePolicy	Een pijplijnbeleid manipuleert een aanvraag terwijl deze door de pijplijn wordt geleid. Het is conceptueel gezien een middleware die de aanvraag mag wijzigen voordat deze wordt gedaan, evenals het antwoord wanneer deze wordt ontvangen.
PipelineRequest	Metagegevens over een aanvraag die door de pijplijn wordt gedaan.
PipelineRequestOptions	Instellingen voor het initialiseren van een aanvraag. Bijna gelijk aan Gedeeltelijk, maar URL is verplicht.
PipelineResponse	Metagegevens over een antwoord dat door de pijplijn is ontvangen.
PipelineRetryOptions	Opties die bepalen hoe mislukte aanvragen opnieuw moeten worden geprobeerd.
ProxySettings	Opties voor het configureren van een proxy voor uitgaande aanvragen (alleen Node.js).
PxfObject	Een interface die compatibel is met nodeJS's tls.PxfObject. We willen voorkomen dat de werkelijke interface openbaar opnieuw wordt geëxporteerd, omdat deze kan variëren per runtimeversie.
RedirectPolicyOptions	Opties voor hoe omleidingsreacties worden verwerkt.
RestErrorOptions	De opties die worden ondersteund door RestError.
RetryInformation	Informatie die is verstrekt aan de strategie voor opnieuw proberen over de huidige voortgang van het beleid voor opnieuw proberen.
RetryModifiers	Eigenschappen die het gedrag van het beleid voor opnieuw proberen kunnen wijzigen.
RetryPolicyOptions	Opties voor het retryPolicy
RetryStrategy	Een strategie voor opnieuw proberen is bedoeld om te definiëren of het opnieuw moet worden geprobeerd en hoe het opnieuw moet worden geprobeerd.
SystemErrorRetryPolicyOptions	Opties voor het opnieuw proberen van mislukte aanvragen.
TelemetryOptions	Definieert opties die worden gebruikt voor het configureren van algemene telemetrie- en traceringsgegevens
ThrottlingRetryPolicyOptions	Opties voor het opnieuw proberen van mislukte aanvragen.
TlsSettings	Vertegenwoordigt een certificaat voor TLS-verificatie.
TracingPolicyOptions	Opties voor het configureren van het traceringsbeleid.
UserAgentPolicyOptions	Opties voor het toevoegen van details van de gebruikersagent aan uitgaande aanvragen.

Type-aliassen

FormDataMap	Een eenvoudig object dat formuliergegevens levert, als vanuit een browserformulier.
FormDataValue	Elke formuliergegevensinvoer kan een tekenreeks of (in de browser) een blob zijn.
HttpMethods	Ondersteunde HTTP-methoden die kunnen worden gebruikt bij het indienen van aanvragen.
PipelinePhase	Beleidsregels worden in fasen uitgevoerd. De uitvoeringsvolgorde is: Fase serialiseren Beleid dat zich niet in een fase bevindt Fase deserialiseren Fase voor opnieuw proberen Tekenfase
RawHttpHeaders	Een HttpHeaders-verzameling die wordt weergegeven als een eenvoudig JSON-object.
RawHttpHeadersInput	Een HttpHeaders-verzameling voor invoer, weergegeven als een eenvoudig JSON-object.
RequestBodyType	Typen instanties die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen Node. Blob, ReadableStream en () => ReadableStream zijn alleen browser.
SendRequest	Een eenvoudige interface voor het maken van een pijplijnaanvraag en het ontvangen van een antwoord.
TransferProgressEvent	Geactiveerd als reactie op de voortgang van het uploaden of downloaden.

Functies

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Een beleid voor externe tokens om te x-ms-authorization-auxiliary headeren. Deze header wordt gebruikt bij het maken van een toepassing voor meerdere tenants die mogelijk verificatieaanvragen moeten afhandelen voor resources die zich in verschillende tenants bevinden. U kunt ARM-documenten bekijken voor een overzicht van de werking van deze functie
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Een beleid dat een token kan aanvragen bij een TokenCredential-implementatie en dit vervolgens als bearer-token kan toepassen op de autorisatieheader van een aanvraag.
createDefaultHttpClient()	Maak de juiste HttpClient voor de huidige omgeving.
createEmptyPipeline()	Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste versie.
createHttpHeaders(RawHttpHeadersInput)	Hiermee maakt u een object dat voldoet aan de HttpHeaders interface.
createPipelineFromOptions(InternalPipelineOptions)	Maak een nieuwe pijplijn met een standaardset aanpasbare beleidsregels.
createPipelineRequest(PipelineRequestOptions)	Hiermee maakt u een nieuwe pijplijnaanvraag met de opgegeven opties. Deze methode is om de eenvoudige instelling van standaardwaarden mogelijk te maken en niet vereist.
decompressResponsePolicy()	Een beleid om antwoorddecompressie in te schakelen op basis van Accept-Encoding header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Een beleid dat opnieuw probeert volgens drie strategieën: Wanneer de server een 429-antwoord verzendt met een Retry-After-header. Wanneer er fouten optreden in de onderliggende transportlaag (bijvoorbeeld DNS-opzoekfouten). Of als de uitgaande aanvraag mislukt, wordt het opnieuw geprobeerd met een exponentieel toenemende vertraging.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Een beleid dat probeert aanvragen opnieuw uit te voeren terwijl een exponentieel toenemende vertraging wordt ingevoerd.
formDataPolicy()	Een beleid waarmee FormData voor de aanvraag in de hoofdtekst wordt gecodeerd.
getDefaultProxySettings(string)	Met deze methode wordt een proxy-URL geconverteerd naar ProxySettings voor gebruik met ProxyPolicy. Als er geen argument wordt gegeven, wordt geprobeerd een proxy-URL van de omgevingsvariabelen of HTTP_PROXYte parserenHTTPS_PROXY.
isRestError(unknown)	Typeguard voor RestError
logPolicy(LogPolicyOptions)	Een beleid dat alle aanvragen en antwoorden registreert.
ndJsonPolicy()	ndJsonPolicy is een beleid dat wordt gebruikt om keep alive-instellingen voor elke aanvraag te beheren.
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(RedirectPolicyOptions)	Een beleid om locatieheaders van de server te volgen om omleiding aan de serverzijde te ondersteunen. In de browser wordt dit beleid niet gebruikt.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy is een algemeen beleid voor het inschakelen van aanvragen voor opnieuw proberen wanneer aan bepaalde voorwaarden wordt voldaan
setClientRequestIdPolicy(string)	Elke PipelineRequest krijgt een unieke id bij het maken. Dit beleid geeft die unieke id door via een HTTP-header om betere telemetrie en tracering mogelijk te maken.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Een beleid voor opnieuw proberen dat specifiek gericht is op het afhandelen van fouten in de onderliggende transportlaag (bijvoorbeeld DNS-opzoekfouten) in plaats van foutcodes die opnieuw kunnen worden geprobeerd vanaf de server zelf.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Een beleid dat opnieuw probeert wanneer de server een 429-antwoord verzendt met een Retry-After-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
tlsPolicy(TlsSettings)	Hiermee haalt u een pijplijnbeleid op waarmee het clientcertificaat wordt toegevoegd aan de HttpClient-agent voor verificatie.
tracingPolicy(TracingPolicyOptions)	Een eenvoudig beleid voor het maken van OpenTelemetry Spans voor elke aanvraag die wordt gedaan door de pijplijn met SpanOptions met een bovenliggend item. Aanvragen zonder bovenliggende span worden niet vastgelegd.
userAgentPolicy(UserAgentPolicyOptions)	Een beleid waarmee de User-Agent-header (of gelijkwaardig) wordt ingesteld om de bibliotheekversie weer te geven.

Functiedetails

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Een beleid voor externe tokens om te x-ms-authorization-auxiliary headeren. Deze header wordt gebruikt bij het maken van een toepassing voor meerdere tenants die mogelijk verificatieaanvragen moeten afhandelen voor resources die zich in verschillende tenants bevinden. U kunt ARM-documenten bekijken voor een overzicht van de werking van deze functie

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parameters

options

AuxiliaryAuthenticationHeaderPolicyOptions

Retouren

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Een beleid dat een token kan aanvragen bij een TokenCredential-implementatie en dit vervolgens als bearer-token kan toepassen op de autorisatieheader van een aanvraag.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parameters

options

BearerTokenAuthenticationPolicyOptions

Retouren

PipelinePolicy

createDefaultHttpClient()

Maak de juiste HttpClient voor de huidige omgeving.

function createDefaultHttpClient(): HttpClient

Retouren

HttpClient

createEmptyPipeline()

Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste versie.

function createEmptyPipeline(): Pipeline

Retouren

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Hiermee maakt u een object dat voldoet aan de HttpHeaders interface.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parameters

rawHeaders

RawHttpHeadersInput

Een eenvoudig object dat de eerste headers vertegenwoordigt

Retouren

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Maak een nieuwe pijplijn met een standaardset aanpasbare beleidsregels.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parameters

options

InternalPipelineOptions

Opties voor het configureren van een aangepaste pijplijn.

Retouren

Pipeline

createPipelineRequest(PipelineRequestOptions)

Hiermee maakt u een nieuwe pijplijnaanvraag met de opgegeven opties. Deze methode is om de eenvoudige instelling van standaardwaarden mogelijk te maken en niet vereist.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parameters

options

PipelineRequestOptions

De opties voor het maken van de aanvraag.

Retouren

PipelineRequest

decompressResponsePolicy()

Een beleid om antwoorddecompressie in te schakelen op basis van Accept-Encoding header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Retouren

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Een beleid dat opnieuw probeert volgens drie strategieën:

• Wanneer de server een 429-antwoord verzendt met een Retry-After-header.
• Wanneer er fouten optreden in de onderliggende transportlaag (bijvoorbeeld DNS-opzoekfouten).
• Of als de uitgaande aanvraag mislukt, wordt het opnieuw geprobeerd met een exponentieel toenemende vertraging.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parameters

options

DefaultRetryPolicyOptions

Retouren

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Een beleid dat probeert aanvragen opnieuw uit te voeren terwijl een exponentieel toenemende vertraging wordt ingevoerd.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parameters

options

ExponentialRetryPolicyOptions

Opties voor het configureren van logica voor opnieuw proberen.

Retouren

PipelinePolicy

formDataPolicy()

Een beleid waarmee FormData voor de aanvraag in de hoofdtekst wordt gecodeerd.

function formDataPolicy(): PipelinePolicy

Retouren

PipelinePolicy

getDefaultProxySettings(string)

Met deze methode wordt een proxy-URL geconverteerd naar ProxySettings voor gebruik met ProxyPolicy. Als er geen argument wordt gegeven, wordt geprobeerd een proxy-URL van de omgevingsvariabelen of HTTP_PROXYte parserenHTTPS_PROXY.

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

Parameters

proxyUrl

string

De URL van de proxy die moet worden gebruikt. Kan verificatiegegevens bevatten.

Retouren

ProxySettings | undefined

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Iets gevangen door een catch-component.

Retouren

e

logPolicy(LogPolicyOptions)

Een beleid dat alle aanvragen en antwoorden registreert.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parameters

options

LogPolicyOptions

Opties voor het configureren van logPolicy.

Retouren

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy is een beleid dat wordt gebruikt om keep alive-instellingen voor elke aanvraag te beheren.

function ndJsonPolicy(): PipelinePolicy

Retouren

PipelinePolicy

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[] }): PipelinePolicy

Parameters

proxySettings

ProxySettings

ProxySettings te gebruiken voor elke aanvraag.

options

{ customNoProxyList?: string[] }

aanvullende instellingen, bijvoorbeeld aangepaste NO_PROXY patronen

Retouren

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Een beleid om locatieheaders van de server te volgen om omleiding aan de serverzijde te ondersteunen. In de browser wordt dit beleid niet gebruikt.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parameters

options

RedirectPolicyOptions

Opties voor het beheren van het gedrag van beleid.

Retouren

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy is een algemeen beleid voor het inschakelen van aanvragen voor opnieuw proberen wanneer aan bepaalde voorwaarden wordt voldaan

function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy

Parameters

strategies

RetryStrategy[]

options

RetryPolicyOptions

Retouren

PipelinePolicy

setClientRequestIdPolicy(string)

Elke PipelineRequest krijgt een unieke id bij het maken. Dit beleid geeft die unieke id door via een HTTP-header om betere telemetrie en tracering mogelijk te maken.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parameters

requestIdHeaderName

string

De naam van de header waaraan de aanvraag-id moet worden doorgegeven.

Retouren

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Een beleid voor opnieuw proberen dat specifiek gericht is op het afhandelen van fouten in de onderliggende transportlaag (bijvoorbeeld DNS-opzoekfouten) in plaats van foutcodes die opnieuw kunnen worden geprobeerd vanaf de server zelf.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parameters

options

SystemErrorRetryPolicyOptions

Opties waarmee het beleid wordt aangepast.

Retouren

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Een beleid dat opnieuw probeert wanneer de server een 429-antwoord verzendt met een Retry-After-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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parameters

options

ThrottlingRetryPolicyOptions

Opties voor het configureren van logica voor opnieuw proberen.

Retouren

PipelinePolicy

tlsPolicy(TlsSettings)

Hiermee haalt u een pijplijnbeleid op waarmee het clientcertificaat wordt toegevoegd aan de HttpClient-agent voor verificatie.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parameters

tlsSettings

TlsSettings

Retouren

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Een eenvoudig beleid voor het maken van OpenTelemetry Spans voor elke aanvraag die wordt gedaan door de pijplijn met SpanOptions met een bovenliggend item. Aanvragen zonder bovenliggende span worden niet vastgelegd.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parameters

options

TracingPolicyOptions

Opties voor het configureren van de telemetrie die wordt geregistreerd door het traceringsbeleid.

Retouren

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Een beleid waarmee de User-Agent-header (of gelijkwaardig) wordt ingesteld om de bibliotheekversie weer te geven.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parameters

options

UserAgentPolicyOptions

Opties voor het aanpassen van de waarde van de gebruikersagent.

Retouren

PipelinePolicy