@azure/core-https package

Klasserna

DefaultHttpsClient

En HttpsClient-implementering som använder Nodes "https"-modul för att skicka HTTPS-begäranden.

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.

BearerTokenAuthenticationPolicyOptions

Alternativ för att konfigurera bearerTokenAuthenticationPolicy

ExponentialRetryPolicyOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.

HttpHeaders

Representerar en uppsättning HTTP-huvuden för en begäran/ett svar. Rubriknamn behandlas som skiftlägesokänsliga.

HttpsClient

Det gränssnitt som krävs för en klient som gör HTTPS-begäranden för en pipeline.

InternalPipelineOptions

Definierar alternativ som används för att konfigurera interna alternativ för HTTP-pipelinen för en SDK-klient.

LogPolicyOptions

Alternativ för att konfigurera logPolicy.

Pipeline

Representerar en pipeline för att göra en HTTPS-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 motsvarar Partial<PipelineRequest>, men url är obligatoriskt.

PipelineResponse

Metadata om ett svar som tas emot av pipelinen.

ProxySettings

Alternativ för att konfigurera en proxy för utgående begäranden (endastNode.js).

RedirectPolicyOptions

Alternativ för hur omdirigeringssvar hanteras.

RestErrorOptions

De alternativ som stöds av RestError.

SystemErrorRetryPolicyOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.

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.

Typaliaser

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:

  1. Serialisera fas
  2. Principer som inte är i en fas
  3. Deserialisera fas
  4. Försök med fas igen
RawHttpHeaders

En HttpHeaders-samling som representeras som ett enkelt JSON-objekt.

RequestBodyType

Typer av organ som stöds i begäran. NodeJS.ReadableStream är endast Node. Blob ä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

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.

createEmptyPipeline()

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

createHttpHeaders(RawHttpHeaders)

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 rubrik https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

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.

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)

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.

redirectPolicy(RedirectPolicyOptions)

En princip för att följa platsrubriker från servern för att stödja omdirigering på serversidan.

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 transportskiktet (t.ex. DNS-sökningsfel) i stället för att försöka felkoder från själva servern.

throttlingRetryPolicy()

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

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) för att återspegla biblioteksversionen.

Variabler

bearerTokenAuthenticationPolicyName

Den programmatiska identifieraren för bärarenTokenAuthenticationPolicy.

decompressResponsePolicyName

Den programmatiska identifieraren för decompressResponsePolicy.

expontentialRetryPolicyName

Den programmatiska identifieraren för den exponentiella RetryPolicy.

formDataPolicyName

Den programmatiska identifieraren för formDataPolicy.

logPolicyName

Den programmatiska identifieraren för logPolicy.

ndJsonPolicyName

Den programmatiska identifieraren för ndJsonPolicy.

proxyPolicyName

Den programmatiska identifieraren för proxyPolicy.

redirectPolicyName

Den programmatiska identifieraren för redirectPolicy.

setClientRequestIdPolicyName

Den programmatiska identifieraren för setClientRequestIdPolicy.

systemErrorRetryPolicyName

Den programmatiska identifieraren för systemErrorRetryPolicy.

throttlingRetryPolicyName

Den programmatiska identifieraren för throttlingRetryPolicy.

tracingPolicyName

Den programmatiska identifieraren för tracingPolicy.

userAgentPolicyName

Den programmatiska identifieraren för userAgentPolicy.

Funktionsdetaljer

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

Returnerar

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Returnerar

createHttpHeaders(RawHttpHeaders)

Skapar ett objekt som uppfyller HttpHeaders-gränssnittet.

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parametrar

rawHeaders
RawHttpHeaders

Ett enkelt objekt som representerar inledande rubriker

Returnerar

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.

Returnerar

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.

Returnerar

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(): PipelinePolicy

Returnerar

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.

Returnerar

formDataPolicy()

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

function formDataPolicy(): PipelinePolicy

Returnerar

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.

Returnerar

ProxySettings | undefined

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.

Returnerar

ndJsonPolicy()

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

function ndJsonPolicy(): PipelinePolicy

Returnerar

proxyPolicy(ProxySettings)

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): PipelinePolicy

Parametrar

proxySettings
ProxySettings

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

Returnerar

redirectPolicy(RedirectPolicyOptions)

En princip för att följa platsrubriker från servern för att stödja omdirigering på serversidan.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametrar

options
RedirectPolicyOptions

Alternativ för att styra principbeteende.

Returnerar

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ärande-ID:t ska skickas till.

Returnerar

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): PipelinePolicy

Parametrar

options
SystemErrorRetryPolicyOptions

Alternativ som anpassar principen.

Returnerar

throttlingRetryPolicy()

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 telemetrin som loggas av spårningsprincipen.

Returnerar

userAgentPolicy(UserAgentPolicyOptions)

En princip som anger User-Agent-huvudet (eller motsvarande) för att återspegla biblioteksversionen.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametrar

options
UserAgentPolicyOptions

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

Returnerar

Variable Details

bearerTokenAuthenticationPolicyName

Den programmatiska identifieraren för bärarenTokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Typ

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

Den programmatiska identifieraren för decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Typ

"decompressResponsePolicy"

expontentialRetryPolicyName

Den programmatiska identifieraren för den exponentiella RetryPolicy.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Typ

"exponentialRetryPolicy"

formDataPolicyName

Den programmatiska identifieraren för formDataPolicy.

formDataPolicyName: "formDataPolicy"

Typ

"formDataPolicy"

logPolicyName

Den programmatiska identifieraren för logPolicy.

logPolicyName: "logPolicy"

Typ

"logPolicy"

ndJsonPolicyName

Den programmatiska identifieraren för ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Typ

"ndJsonPolicy"

proxyPolicyName

Den programmatiska identifieraren för proxyPolicy.

proxyPolicyName: "proxyPolicy"

Typ

"proxyPolicy"

redirectPolicyName

Den programmatiska identifieraren för redirectPolicy.

redirectPolicyName: "redirectPolicy"

Typ

"redirectPolicy"

setClientRequestIdPolicyName

Den programmatiska identifieraren för setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Typ

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

Den programmatiska identifieraren för systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Typ

"systemErrorRetryPolicy"

throttlingRetryPolicyName

Den programmatiska identifieraren för throttlingRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Typ

"throttlingRetryPolicy"

tracingPolicyName

Den programmatiska identifieraren för tracingPolicy.

tracingPolicyName: "tracingPolicy"

Typ

"tracingPolicy"

userAgentPolicyName

Den programmatiska identifieraren för userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Typ

"userAgentPolicy"