@azure/core-rest-pipeline package

Klasser

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Gränssnitt

AddPipelineOptions	Alternativ när du lägger till en princip i pipelinen. Används för att uttrycka beroenden för andra principer.
Agent	Ett gränssnitt som är kompatibelt med NodeJS: s http.Agent. Vi vill undvika att exportera det faktiska gränssnittet offentligt, eftersom det kan variera mellan körningsversioner.
AuthorizeRequestOnChallengeOptions	Alternativ som skickas till återanropet authorizeRequestOnChallenge
AuthorizeRequestOptions	Alternativ som skickas till återanropet authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Alternativ för att konfigurera auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Alternativ för att konfigurera bearerTokenAuthenticationPolicy
ChallengeCallbacks	Alternativ för att åsidosätta bearbetningen av utmaningar med kontinuerlig åtkomstutvärdering .
DefaultRetryPolicyOptions	Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
ExponentialRetryPolicyOptions	Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
HttpClient	Det nödvändiga gränssnittet för en klient som gör HTTP-begäranden för en pipeline.
HttpHeaders	Representerar en uppsättning HTTP-huvuden för en begäran/ett svar. Rubriknamn behandlas som skiftlägesokänsliga.
InternalPipelineOptions	Definierar alternativ som används för att konfigurera interna alternativ för HTTP-pipelinen för en SDK-klient.
KeyObject	Ett gränssnitt som är kompatibelt med NodeJS: s tls.KeyObject. Vi vill undvika att exportera det faktiska gränssnittet offentligt, eftersom det kan variera mellan körningsversioner.
LogPolicyOptions	Alternativ för att konfigurera logPolicy.
Pipeline	Representerar en pipeline för att göra en HTTP-begäran till en URL. Pipelines kan ha flera principer för att hantera hantering av varje begäran före och efter att den har gjorts till servern.
PipelineOptions	Definierar alternativ som används för att konfigurera HTTP-pipelinen för en SDK-klient.
PipelinePolicy	En pipelineprincip manipulerar en begäran när den överförs via pipelinen. Det är konceptuellt ett mellanprogram som kan ändra begäran innan den görs samt svaret när den tas emot.
PipelineRequest	Metadata om en begäran som görs av pipelinen.
PipelineRequestOptions	Inställningar för att initiera en begäran. Nästan likvärdigt med Partiell, men URL är obligatoriskt.
PipelineResponse	Metadata om ett svar som tas emot av pipelinen.
PipelineRetryOptions	Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
ProxySettings	Alternativ för att konfigurera en proxy för utgående begäranden (endast Node.js).
PxfObject	Ett gränssnitt som är kompatibelt med NodeJS: s tls.PxfObject. Vi vill undvika att exportera det faktiska gränssnittet offentligt, eftersom det kan variera mellan körningsversioner.
RedirectPolicyOptions	Alternativ för hur omdirigeringssvar hanteras.
RestErrorOptions	Alternativen som stöds av RestError.
RetryInformation	Information som tillhandahålls till återförsöksstrategin om den aktuella förloppet för återförsöksprincipen.
RetryModifiers	Egenskaper som kan ändra beteendet för återförsöksprincipen.
RetryPolicyOptions	Alternativ till retryPolicy
RetryStrategy	En återförsöksstrategi är avsedd att definiera om du vill försöka igen eller inte och hur du försöker igen.
SystemErrorRetryPolicyOptions	Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
TelemetryOptions	Definierar alternativ som används för att konfigurera vanlig telemetri- och spårningsinformation
ThrottlingRetryPolicyOptions	Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
TlsSettings	Representerar ett certifikat för TLS-autentisering.
TracingPolicyOptions	Alternativ för att konfigurera spårningsprincipen.
UserAgentPolicyOptions	Alternativ för att lägga till användaragentinformation i utgående begäranden.

Typalias

FormDataMap	Ett enkelt objekt som tillhandahåller formulärdata, som från ett webbläsarformulär.
FormDataValue	Varje formulärdatapost kan vara en sträng eller (i webbläsaren) en blob.
HttpMethods	HTTP-metoder som stöds när begäranden görs.
PipelinePhase	Principer körs i faser. Körningsordningen är: Serialisera fas Principer som inte är i en fas Deserialisera fas Återförsöksfas Teckenfas
RawHttpHeaders	En HttpHeaders-samling som representeras som ett enkelt JSON-objekt.
RawHttpHeadersInput	En HttpHeaders-samling för indata, representerad som ett enkelt JSON-objekt.
RequestBodyType	Typer av organ som stöds i begäran. NodeJS.ReadableStream och () => NodeJS.ReadableStream är endast Node. Blob, ReadableStream och () => ReadableStream är endast webbläsare.
SendRequest	Ett enkelt gränssnitt för att göra en pipelinebegäran och ta emot ett svar.
TransferProgressEvent	Utlöstes som svar på överförings- eller nedladdningsstatus.

Funktioner

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	En princip för externa token till x-ms-authorization-auxiliary sidhuvud. Det här huvudet används när du skapar ett program mellan klientorganisationer som vi kan behöva hantera autentiseringsbegäranden för resurser som finns i olika klientorganisationer. Du kan se ARM-dokument för en genomgång av hur den här funktionen fungerar
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	En princip som kan begära en token från en TokenCredential-implementering och sedan tillämpa den på auktoriseringshuvudet för en begäran som en ägartoken.
createDefaultHttpClient()	Skapa rätt HttpClient för den aktuella miljön.
createEmptyPipeline()	Skapar en helt tom pipeline. Användbart för att testa eller skapa en anpassad.
createHttpHeaders(RawHttpHeadersInput)	Skapar ett objekt som uppfyller HttpHeaders gränssnittet.
createPipelineFromOptions(InternalPipelineOptions)	Skapa en ny pipeline med en standarduppsättning anpassningsbara principer.
createPipelineRequest(PipelineRequestOptions)	Skapar en ny pipelinebegäran med de angivna alternativen. Den här metoden är att tillåta enkel inställning av standardvärden och inte krävs.
decompressResponsePolicy()	En princip för att aktivera svarsdekomprimering enligt Accept-Encoding sidhuvud https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	En princip som försöker igen enligt tre strategier: När servern skickar ett 429-svar med ett Retry-After-huvud. När det finns fel i det underliggande transportlagret (t.ex. DNS-sökningsfel). Eller om den utgående begäran misslyckas försöker den igen med en exponentiellt ökande fördröjning.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	En princip som försöker försöka begäranden igen samtidigt som en exponentiellt ökande fördröjning införs.
formDataPolicy()	En princip som kodar FormData på begäran till brödtexten.
getDefaultProxySettings(string)	Den här metoden konverterar en proxy-URL till ProxySettings för användning med ProxyPolicy. Om inget argument anges försöker det parsa en proxy-URL från miljövariablerna HTTPS_PROXY eller HTTP_PROXY.
isRestError(unknown)	Typeguard för RestError
logPolicy(LogPolicyOptions)	En princip som loggar alla begäranden och svar.
ndJsonPolicy()	ndJsonPolicy är en princip som används för att styra keep alive-inställningar för varje begäran.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	En princip som gör att en kan tillämpa proxyinställningar på alla begäranden. Om de inte skickas statiska inställningar hämtas de från HTTPS_PROXY- eller HTTP_PROXY miljövariablerna.
redirectPolicy(RedirectPolicyOptions)	En princip för att följa platsrubriker från servern för att stödja omdirigering på serversidan. I webbläsaren används inte den här principen.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy är en allmän princip för att aktivera återförsök av begäranden när vissa villkor uppfylls
setClientRequestIdPolicy(string)	Varje PipelineRequest får ett unikt ID när de skapas. Den här principen skickar det unika ID:t via ett HTTP-huvud för att möjliggöra bättre telemetri och spårning.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	En återförsöksprincip som specifikt syftar till att hantera fel i det underliggande transportlagret (t.ex. DNS-sökningsfel) i stället för återförsöksbara felkoder från själva servern.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	En princip som försöker igen när servern skickar ett 429-svar med ett Retry-After-huvud. Mer information finns i https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits och https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Hämtar en pipelineprincip som lägger till klientcertifikatet till HttpClient-agenten för autentisering.
tracingPolicy(TracingPolicyOptions)	En enkel princip för att skapa OpenTelemetry Spans för varje begäran som görs av pipelinen som har SpanOptions med en överordnad. Begäranden som görs utan ett överordnat spann registreras inte.
userAgentPolicy(UserAgentPolicyOptions)	En princip som anger User-Agent -huvudet (eller motsvarande) så att det återspeglar biblioteksversionen.

Funktionsinformation

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

En princip för externa token till x-ms-authorization-auxiliary sidhuvud. Det här huvudet används när du skapar ett program mellan klientorganisationer som vi kan behöva hantera autentiseringsbegäranden för resurser som finns i olika klientorganisationer. Du kan se ARM-dokument för en genomgång av hur den här funktionen fungerar

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametrar

options

AuxiliaryAuthenticationHeaderPolicyOptions

Returer

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

En princip som kan begära en token från en TokenCredential-implementering och sedan tillämpa den på auktoriseringshuvudet för en begäran som en ägartoken.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parametrar

options

BearerTokenAuthenticationPolicyOptions

Returer

PipelinePolicy

createDefaultHttpClient()

Skapa rätt HttpClient för den aktuella miljön.

function createDefaultHttpClient(): HttpClient

Returer

HttpClient

createEmptyPipeline()

Skapar en helt tom pipeline. Användbart för att testa eller skapa en anpassad.

function createEmptyPipeline(): Pipeline

Returer

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Skapar ett objekt som uppfyller HttpHeaders gränssnittet.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametrar

rawHeaders

RawHttpHeadersInput

Ett enkelt objekt som representerar inledande rubriker

Returer

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Skapa en ny pipeline med en standarduppsättning anpassningsbara principer.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parametrar

options

InternalPipelineOptions

Alternativ för att konfigurera en anpassad pipeline.

Returer

Pipeline

createPipelineRequest(PipelineRequestOptions)

Skapar en ny pipelinebegäran med de angivna alternativen. Den här metoden är att tillåta enkel inställning av standardvärden och inte krävs.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametrar

options

PipelineRequestOptions

Alternativen för att skapa begäran med.

Returer

PipelineRequest

decompressResponsePolicy()

En princip för att aktivera svarsdekomprimering enligt Accept-Encoding sidhuvud https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Returer

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

En princip som försöker igen enligt tre strategier:

• När servern skickar ett 429-svar med ett Retry-After-huvud.
• När det finns fel i det underliggande transportlagret (t.ex. DNS-sökningsfel).
• Eller om den utgående begäran misslyckas försöker den igen med en exponentiellt ökande fördröjning.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametrar

options

DefaultRetryPolicyOptions

Returer

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

En princip som försöker försöka begäranden igen samtidigt som en exponentiellt ökande fördröjning införs.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametrar

options

ExponentialRetryPolicyOptions

Alternativ som konfigurerar logik för återförsök.

Returer

PipelinePolicy

formDataPolicy()

En princip som kodar FormData på begäran till brödtexten.

function formDataPolicy(): PipelinePolicy

Returer

PipelinePolicy

getDefaultProxySettings(string)

Den här metoden konverterar en proxy-URL till ProxySettings för användning med ProxyPolicy. Om inget argument anges försöker det parsa en proxy-URL från miljövariablerna HTTPS_PROXY eller HTTP_PROXY.

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

Parametrar

proxyUrl

string

Url:en för proxyn som ska användas. Kan innehålla autentiseringsinformation.

Returer

ProxySettings | undefined

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

logPolicy(LogPolicyOptions)

En princip som loggar alla begäranden och svar.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parametrar

options

LogPolicyOptions

Alternativ för att konfigurera logPolicy.

Returer

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy är en princip som används för att styra keep alive-inställningar för varje begäran.

function ndJsonPolicy(): PipelinePolicy

Returer

PipelinePolicy

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

En princip som gör att en kan tillämpa proxyinställningar på alla begäranden. Om de inte skickas statiska inställningar hämtas de från HTTPS_PROXY- eller HTTP_PROXY miljövariablerna.

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

Parametrar

proxySettings

ProxySettings

ProxyInställningar som ska användas för varje begäran.

options

{ customNoProxyList?: string[] }

ytterligare inställningar, till exempel anpassade NO_PROXY mönster

Returer

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

En princip för att följa platsrubriker från servern för att stödja omdirigering på serversidan. I webbläsaren används inte den här principen.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametrar

options

RedirectPolicyOptions

Alternativ för att styra principbeteende.

Returer

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy är en allmän princip för att aktivera återförsök av begäranden när vissa villkor uppfylls

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

Parametrar

strategies

RetryStrategy[]

options

RetryPolicyOptions

Returer

PipelinePolicy

setClientRequestIdPolicy(string)

Varje PipelineRequest får ett unikt ID när de skapas. Den här principen skickar det unika ID:t via ett HTTP-huvud för att möjliggöra bättre telemetri och spårning.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametrar

requestIdHeaderName

string

Namnet på rubriken som begärans ID ska skickas till.

Returer

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

En återförsöksprincip som specifikt syftar till att hantera fel i det underliggande transportlagret (t.ex. DNS-sökningsfel) i stället för återförsöksbara felkoder från själva servern.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parametrar

options

SystemErrorRetryPolicyOptions

Alternativ som anpassar principen.

Returer

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

En princip som försöker igen när servern skickar ett 429-svar med ett Retry-After-huvud.

Mer information finns i https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits och https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parametrar

options

ThrottlingRetryPolicyOptions

Alternativ som konfigurerar logik för återförsök.

Returer

PipelinePolicy

tlsPolicy(TlsSettings)

Hämtar en pipelineprincip som lägger till klientcertifikatet till HttpClient-agenten för autentisering.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parametrar

tlsSettings

TlsSettings

Returer

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

En enkel princip för att skapa OpenTelemetry Spans för varje begäran som görs av pipelinen som har SpanOptions med en överordnad. Begäranden som görs utan ett överordnat spann registreras inte.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parametrar

options

TracingPolicyOptions

Alternativ för att konfigurera telemetri som loggas av spårningsprincipen.

Returer

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

En princip som anger User-Agent -huvudet (eller motsvarande) så att det återspeglar biblioteksversionen.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametrar

options

UserAgentPolicyOptions

Alternativ för att anpassa värdet för användaragenten.

Returer

PipelinePolicy