@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 |
| AuthorizeRequestOnChallengeOptions |
Alternativ som skickas till återanropet authorizeRequestOnChallenge |
| AuthorizeRequestOptions |
Alternativ som skickas till auktoriseraRequest-återanropet |
| AuxiliaryAuthenticationHeaderPolicyOptions |
Alternativ för att konfigurera auxiliaryAuthenticationHeaderPolicy |
| BearerTokenAuthenticationPolicyOptions |
Alternativ för att konfigurera bearerTokenAuthenticationPolicy |
| BodyPart |
En del av begärandetexten i en begäran i flera delar. |
| ChallengeCallbacks |
Alternativ för att åsidosätta bearbetningen av utvärdering av kontinuerlig åtkomst utmaningar. |
| CreateFileFromStreamOptions |
Extra alternativ för createFile när en dataström skickas. |
| CreateFileOptions |
Alternativ som skickas till createFile som anger metadata om filen. |
| 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 pipelines räkning. |
| 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 |
| LogPolicyOptions |
Alternativ för att konfigurera logPolicy. |
| MultipartRequestBody |
En begärandetext som består av flera delar. |
| 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 tillåts ä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 (endastNode.js). |
| PxfObject |
Ett gränssnitt som är kompatibelt med NodeJS |
| RedirectPolicyOptions |
Alternativ för hur omdirigeringssvar hanteras. |
| RestErrorOptions |
De alternativ som stöds av RestError. |
| RetryInformation |
Information som ges 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 för 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 gemensam 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 information om användaragenten 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, blob eller en fil. Om du vill skicka en fil med ett namn men inte har åtkomst till klassen Arkiv kan du använda hjälpverktyget createFile för att skapa en. |
| HttpMethods |
HTTP-metoder som stöds när begäranden görs. |
| PipelinePhase |
Principer körs i faser. Körningsordningen är:
|
| 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 nedladdningsframsteg. |
Funktioner
| agent |
Hämtar en pipelineprincip som anger http.agent |
| auxiliary |
En princip för externa token som ska |
| bearer |
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. |
| create |
Skapa rätt HttpClient för den aktuella miljön. |
| create |
Skapar en helt tom pipeline. Användbart för att testa eller skapa en anpassad. |
| create |
Skapa ett objekt som implementerar filgränssnittet. Det här objektet är avsett att skickas till RequestBodyType.formData och är inte garanterat att fungera som förväntat i andra situationer. Använd den här funktionen för att skapa ett filobjekt som ska användas i RequestBodyType.formData i miljöer där det globala filobjektet inte är tillgängligt. |
| create |
Skapa ett objekt som implementerar filgränssnittet. Det här objektet är avsett att skickas till RequestBodyType.formData och är inte garanterat att fungera som förväntat i andra situationer. Använd den här funktionen för att:
|
| create |
Skapar ett objekt som uppfyller |
| create |
Skapa en ny pipeline med en standarduppsättning anpassningsbara principer. |
| create |
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. |
| decompress |
En princip för att aktivera svarsdekomprimering enligt Accept-Encoding rubrik https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
| default |
En princip som försöker igen enligt tre strategier:
|
| exponential |
En princip som försöker försöka begäranden igen samtidigt som en exponentiellt ökande fördröjning införs. |
| form |
En princip som kodar FormData på begäran till brödtexten. |
| get |
Den här metoden konverterar en proxy-URL till |
| is |
Typeguard för RestError |
| log |
En princip som loggar alla begäranden och svar. |
| multipart |
Pipelineprincip för begäranden med flera delar |
| nd |
ndJsonPolicy är en princip som används för att styra keep alive-inställningar för varje begäran. |
| proxy |
En princip som gör att en kan tillämpa proxyinställningar på alla begäranden. Om de inte skickas med statiska inställningar hämtas de från miljövariablerna HTTPS_PROXY eller HTTP_PROXY. |
| redirect |
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. |
| retry |
retryPolicy är en allmän princip för att aktivera återförsök av begäranden när vissa villkor uppfylls |
| set |
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. |
| system |
En återförsöksprincip som specifikt syftar till att hantera fel i det underliggande transportskiktet (t.ex. DNS-sökningsfel) i stället för att försöka felkoder från själva servern. |
| throttling |
En princip som försöker igen när servern skickar ett 429-svar med ett Retry-After-huvud. Mer information finns i https://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits och https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
| tls |
Hämtar en pipelineprincip som lägger till klientcertifikatet i HttpClient-agenten för autentisering. |
| tracing |
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. |
| user |
En princip som anger User-Agent-huvudet (eller motsvarande) för att återspegla biblioteksversionen. |
Funktionsinformation
agentPolicy(Agent)
Hämtar en pipelineprincip som anger http.agent
function agentPolicy(agent?: Agent): PipelinePolicyParametrar
- agent
- Agent
Returer
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
En princip för externa token som ska x-ms-authorization-auxiliary huvud.
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): PipelinePolicyParametrar
Returer
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): PipelinePolicyParametrar
Returer
createDefaultHttpClient()
Skapa rätt HttpClient för den aktuella miljön.
function createDefaultHttpClient(): HttpClientReturer
createEmptyPipeline()
Skapar en helt tom pipeline. Användbart för att testa eller skapa en anpassad.
function createEmptyPipeline(): PipelineReturer
createFile(Uint8Array, string, CreateFileOptions)
Skapa ett objekt som implementerar filgränssnittet. Det här objektet är avsett att skickas till RequestBodyType.formData och är inte garanterat att fungera som förväntat i andra situationer.
Använd den här funktionen för att skapa ett filobjekt som ska användas i RequestBodyType.formData i miljöer där det globala filobjektet inte är tillgängligt.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): FileParametrar
- content
-
Uint8Array
innehållet i filen som en Uint8Array i minnet.
- name
-
string
namnet på filen.
- options
- CreateFileOptions
valfria metadata om filen, t.ex. filnamn, filstorlek, MIME-typ.
Returer
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
Skapa ett objekt som implementerar filgränssnittet. Det här objektet är avsett att skickas till RequestBodyType.formData och är inte garanterat att fungera som förväntat i andra situationer.
Använd den här funktionen för att:
- Skapa ett filobjekt som ska användas i RequestBodyType.formData i miljöer där det globala filobjektet inte är tillgängligt.
- Skapa ett filliknande objekt från en läsbar ström utan att läsa strömmen i minnet.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): FileParametrar
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
innehållet i filen som ett återanrop som returnerar en ström. När ett filobjekt som skapats med createFile skickas i en begärans formulärdatakarta, läss inte dataströmmen in i minnet utan strömmas i stället när begäran görs. Vid ett nytt försök måste strömmen läsas igen, så återanropet ska returnera en ny ström om möjligt.
- name
-
string
namnet på filen.
- options
- CreateFileFromStreamOptions
valfria metadata om filen, t.ex. filnamn, filstorlek, MIME-typ.
Returer
File
createHttpHeaders(RawHttpHeadersInput)
Skapar ett objekt som uppfyller HttpHeaders-gränssnittet.
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeadersParametrar
- rawHeaders
- RawHttpHeadersInput
Ett enkelt objekt som representerar inledande rubriker
Returer
createPipelineFromOptions(InternalPipelineOptions)
Skapa en ny pipeline med en standarduppsättning anpassningsbara principer.
function createPipelineFromOptions(options: InternalPipelineOptions): PipelineParametrar
- options
- InternalPipelineOptions
Alternativ för att konfigurera en anpassad pipeline.
Returer
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): PipelineRequestParametrar
- options
- PipelineRequestOptions
Alternativen för att skapa begäran med.
Returer
decompressResponsePolicy()
En princip för att aktivera svarsdekomprimering enligt Accept-Encoding rubrik https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicyReturer
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 transportskiktet (t.ex. DNS-sökningsfel).
- Om den utgående begäran misslyckas försöker den annars igen med en exponentiellt ökande fördröjning.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicyParametrar
- options
- DefaultRetryPolicyOptions
Returer
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): PipelinePolicyParametrar
- options
- ExponentialRetryPolicyOptions
Alternativ som konfigurerar logik för återförsök.
Returer
formDataPolicy()
En princip som kodar FormData på begäran till brödtexten.
function formDataPolicy(): PipelinePolicyReturer
getDefaultProxySettings(string)
Varning
Det här API:et är nu inaktuellt.
- Internally this method is no longer necessary when setting proxy information.
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 | undefinedParametrar
- 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): eParametrar
- 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): PipelinePolicyParametrar
- options
- LogPolicyOptions
Alternativ för att konfigurera logPolicy.
Returer
multipartPolicy()
Pipelineprincip för begäranden med flera delar
function multipartPolicy(): PipelinePolicyReturer
ndJsonPolicy()
ndJsonPolicy är en princip som används för att styra keep alive-inställningar för varje begäran.
function ndJsonPolicy(): PipelinePolicyReturer
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
En princip som gör att en kan tillämpa proxyinställningar på alla begäranden. Om de inte skickas med statiska inställningar hämtas de från miljövariablerna HTTPS_PROXY eller HTTP_PROXY.
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicyParametrar
- 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
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): PipelinePolicyParametrar
- options
- RedirectPolicyOptions
Alternativ för att styra principbeteende.
Returer
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): PipelinePolicyParametrar
- strategies
- options
- RetryPolicyOptions
Returer
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): PipelinePolicyParametrar
- requestIdHeaderName
-
string
Namnet på rubriken som begärande-ID:t ska skickas till.
Returer
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
En återförsöksprincip som specifikt syftar till att hantera fel i det underliggande transportskiktet (t.ex. DNS-sökningsfel) i stället för att försöka felkoder från själva servern.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicyParametrar
- options
- SystemErrorRetryPolicyOptions
Alternativ som anpassar principen.
Returer
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://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits och https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicyParametrar
- options
- ThrottlingRetryPolicyOptions
Alternativ som konfigurerar logik för återförsök.
Returer
tlsPolicy(TlsSettings)
Hämtar en pipelineprincip som lägger till klientcertifikatet i HttpClient-agenten för autentisering.
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicyParametrar
- tlsSettings
- TlsSettings
Returer
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): PipelinePolicyParametrar
- options
- TracingPolicyOptions
Alternativ för att konfigurera telemetrin som loggas av spårningsprincipen.
Returer
userAgentPolicy(UserAgentPolicyOptions)
En princip som anger User-Agent-huvudet (eller motsvarande) för att återspegla biblioteksversionen.
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicyParametrar
- options
- UserAgentPolicyOptions
Alternativ för att anpassa värdet för användaragenten.