@azure/core-https package
Klassen
| DefaultHttpsClient |
Een HttpsClient-implementatie die gebruikmaakt van de "https"-module van Node om HTTPS-verzoeken te verzenden. |
| RestError |
Een aangepast fouttype voor mislukte pijplijnaanvragen. |
Interfaces
| AddPipelineOptions |
Opties bij het toevoegen van een beleid aan de pijplijn. Wordt gebruikt om afhankelijkheden van ander beleid uit te drukken. |
| BearerTokenAuthenticationPolicyOptions |
Opties voor het configureren van bearerTokenAuthenticationPolicy |
| ExponentialRetryPolicyOptions |
Opties voor het opnieuw proberen van mislukte aanvragen. |
| HttpHeaders |
Vertegenwoordigt een set HTTP-headers voor een aanvraag/antwoord. Headernamen worden behandeld als niet hoofdlettergevoelig. |
| HttpsClient |
De vereiste interface voor een client die HTTPS-aanvragen doet namens een pijplijn. |
| InternalPipelineOptions |
Definieert opties die worden gebruikt voor het configureren van interne opties van de HTTP-pijplijn voor een SDK-client. |
| LogPolicyOptions |
Opties voor het configureren van logPolicy. |
| Pipeline |
Vertegenwoordigt een pijplijn voor het indienen van een HTTPS-verzoek naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het bewerken van elke aanvraag voor en nadat deze op de server is aangebracht. |
| PipelineOptions |
Definieert opties die worden gebruikt voor het configureren van de HTTP-pijplijn voor een SDK-client. |
| PipelinePolicy |
Een pijplijnbeleid bewerkt een aanvraag tijdens het doorlopen van de pijplijn. Het is conceptueel 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 ingediend. |
| PipelineRequestOptions |
Instellingen voor het initialiseren van een aanvraag. Bijna gelijk aan Partial<PipelineRequest>, maar url is verplicht. |
| PipelineResponse |
Metagegevens over een antwoord dat door de pijplijn is ontvangen. |
| ProxySettings |
Opties voor het configureren van een proxy voor uitgaande aanvragen (alleenNode.js). |
| RedirectPolicyOptions |
Opties voor de manier waarop omleidingsreacties worden verwerkt. |
| RestErrorOptions |
De opties die worden ondersteund door RestError. |
| SystemErrorRetryPolicyOptions |
Opties voor het opnieuw proberen van mislukte aanvragen. |
| TracingPolicyOptions |
Opties voor het configureren van het traceringsbeleid. |
| UserAgentPolicyOptions |
Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen. |
Type-aliassen
| FormDataMap |
Een eenvoudig object dat formuliergegevens levert, alsof dit afkomstig is van een browserformulier. |
| FormDataValue |
Elke formuliergegevensinvoer kan een tekenreeks of (in de browser) een blob zijn. |
| HttpMethods |
Ondersteunde HTTP-methoden voor gebruik bij het indienen van aanvragen. |
| PipelinePhase |
Beleidsregels worden in fasen uitgevoerd. De uitvoeringsvolgorde is:
|
| RawHttpHeaders |
Een HttpHeaders-verzameling die wordt weergegeven als een eenvoudig JSON-object. |
| RequestBodyType |
Typen lichamen die op de aanvraag worden ondersteund. NodeJS.ReadableStream is alleen Node. Blob is alleen voor de browser. |
| SendRequest |
Een eenvoudige interface voor het maken van een pijplijnaanvraag en het ontvangen van een antwoord. |
| TransferProgressEvent |
Geactiveerd als reactie op het uploaden of downloaden van de voortgang. |
Functies
| bearer |
Een beleid dat een token kan aanvragen bij een TokenCredential-implementatie en dit vervolgens toepast op de autorisatieheader van een aanvraag als bearer-token. |
| create |
Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste. |
| create |
Hiermee maakt u een object dat voldoet aan de |
| create |
Maak een nieuwe pijplijn met een standaardset aanpasbare beleidsregels. |
| create |
Hiermee maakt u een nieuwe pijplijnaanvraag met de opgegeven opties. Deze methode is bedoeld om de eenvoudige instelling van standaardwaarden toe te staan en niet vereist. |
| decompress |
Een beleid voor het inschakelen van antwoorddecompressie volgens Accept-Encoding header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding |
| exponential |
Een beleid dat probeert aanvragen opnieuw uit te voeren terwijl een exponentieel toenemende vertraging wordt ingevoerd. |
| form |
Een beleid waarmee FormData op de aanvraag in de hoofdtekst wordt gecodeerd. |
| get |
Met deze methode wordt een proxy-URL geconverteerd naar |
| log |
Een beleid dat alle aanvragen en antwoorden registreert. |
| nd |
ndJsonPolicy is een beleid dat wordt gebruikt om de instellingen voor keep alive te beheren voor elke aanvraag. |
| proxy |
Een beleid waarmee een proxy-instellingen kan worden toegepast op alle aanvragen. Als er geen statische instellingen worden doorgegeven, worden ze opgehaald uit de HTTPS_PROXY of HTTP_PROXY omgevingsvariabelen. |
| redirect |
Een beleid voor het volgen van locatieheaders van de server om omleiding aan de serverzijde te ondersteunen. |
| set |
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. |
| system |
Een beleid voor opnieuw proberen waarmee specifiek wordt gezocht naar fouten in de onderliggende transportlaag (bijvoorbeeld DNS-opzoekfouten) in plaats van foutcodes van de server zelf opnieuw te proberen. |
| throttling |
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-limits, 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 voor meer informatie |
| tracing |
Een eenvoudig beleid voor het maken van OpenTelemetry Spans voor elke aanvraag die is gedaan door de pijplijn met SpanOptions met een bovenliggend item. Aanvragen die zonder bovenliggende span worden gedaan, worden niet vastgelegd. |
| user |
Een beleid waarmee de User-Agent header (of equivalent) wordt ingesteld om de bibliotheekversie weer te geven. |
Variabelen
| bearer |
De programmatische identificatie van de bearerTokenAuthenticationPolicy. |
| decompress |
De programmatische identificatiecode van de decompressResponsePolicy. |
| expontential |
De programmatische identificatie van de exponentiële RetryPolicy. |
| form |
De programmatische identificatie van de formDataPolicy. |
| log |
De programmatische identificatie van de logPolicy. |
| nd |
De programmatische identificatie van de ndJsonPolicy. |
| proxy |
De programmatische identificatie van het proxyPolicy. |
| redirect |
De programmatische identificatie van de redirectPolicy. |
| set |
De programmatische identificatie van de setClientRequestIdPolicy. |
| system |
De programmatische identificatie van de systemErrorRetryPolicy. |
| throttling |
De programmatische identificatie van de throttlingRetryPolicy. |
| tracing |
De programmatische identificatie van het tracingPolicy. |
| user |
De programmatische identificatie van de userAgentPolicy. |
Functiedetails
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
Een beleid dat een token kan aanvragen bij een TokenCredential-implementatie en dit vervolgens toepast op de autorisatieheader van een aanvraag als bearer-token.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
Parameters
Retouren
createEmptyPipeline()
Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste.
function createEmptyPipeline(): Pipeline
Retouren
createHttpHeaders(RawHttpHeaders)
Hiermee maakt u een object dat voldoet aan de HttpHeaders-interface.
function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders
Parameters
- rawHeaders
- RawHttpHeaders
Een eenvoudig object dat de eerste headers vertegenwoordigt
Retouren
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
createPipelineRequest(PipelineRequestOptions)
Hiermee maakt u een nieuwe pijplijnaanvraag met de opgegeven opties. Deze methode is bedoeld om de eenvoudige instelling van standaardwaarden toe te staan en niet vereist.
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest
Parameters
- options
- PipelineRequestOptions
De opties voor het maken van de aanvraag.
Retouren
decompressResponsePolicy()
Een beleid voor het inschakelen van antwoorddecompressie volgens Accept-Encoding header https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy
Retouren
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
formDataPolicy()
Een beleid waarmee FormData op de aanvraag in de hoofdtekst wordt gecodeerd.
function formDataPolicy(): PipelinePolicy
Retouren
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 te parseren uit de omgevingsvariabelen HTTPS_PROXY of HTTP_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
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
ndJsonPolicy()
ndJsonPolicy is een beleid dat wordt gebruikt om de instellingen voor keep alive te beheren voor elke aanvraag.
function ndJsonPolicy(): PipelinePolicy
Retouren
proxyPolicy(ProxySettings)
Een beleid waarmee een proxy-instellingen kan worden toegepast op alle aanvragen. Als er geen statische instellingen worden doorgegeven, worden ze opgehaald uit de HTTPS_PROXY of HTTP_PROXY omgevingsvariabelen.
function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy
Parameters
- proxySettings
- ProxySettings
ProxySettings die voor elke aanvraag moeten worden gebruikt.
Retouren
redirectPolicy(RedirectPolicyOptions)
Een beleid voor het volgen van locatieheaders van de server om omleiding aan de serverzijde te ondersteunen.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
Parameters
- options
- RedirectPolicyOptions
Opties voor het beheren van het gedrag van beleid.
Retouren
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
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
Een beleid voor opnieuw proberen waarmee specifiek wordt gezocht naar fouten in de onderliggende transportlaag (bijvoorbeeld DNS-opzoekfouten) in plaats van foutcodes van de server zelf opnieuw te proberen.
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy
Parameters
- options
- SystemErrorRetryPolicyOptions
Opties waarmee het beleid wordt aangepast.
Retouren
throttlingRetryPolicy()
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-limits, 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 voor meer informatie
function throttlingRetryPolicy(): PipelinePolicy
Retouren
tracingPolicy(TracingPolicyOptions)
Een eenvoudig beleid voor het maken van OpenTelemetry Spans voor elke aanvraag die is gedaan door de pijplijn met SpanOptions met een bovenliggend item. Aanvragen die zonder bovenliggende span worden gedaan, worden niet vastgelegd.
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy
Parameters
- options
- TracingPolicyOptions
Opties voor het configureren van de telemetrie die is vastgelegd door het traceringsbeleid.
Retouren
userAgentPolicy(UserAgentPolicyOptions)
Een beleid waarmee de User-Agent header (of equivalent) 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
Variable Details
bearerTokenAuthenticationPolicyName
De programmatische identificatie van de bearerTokenAuthenticationPolicy.
bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"
Type
"bearerTokenAuthenticationPolicy"
decompressResponsePolicyName
De programmatische identificatiecode van de decompressResponsePolicy.
decompressResponsePolicyName: "decompressResponsePolicy"
Type
"decompressResponsePolicy"
expontentialRetryPolicyName
De programmatische identificatie van de exponentiële RetryPolicy.
expontentialRetryPolicyName: "exponentialRetryPolicy"
Type
"exponentialRetryPolicy"
formDataPolicyName
De programmatische identificatie van de formDataPolicy.
formDataPolicyName: "formDataPolicy"
Type
"formDataPolicy"
logPolicyName
De programmatische identificatie van de logPolicy.
logPolicyName: "logPolicy"
Type
"logPolicy"
ndJsonPolicyName
De programmatische identificatie van de ndJsonPolicy.
ndJsonPolicyName: "ndJsonPolicy"
Type
"ndJsonPolicy"
proxyPolicyName
De programmatische identificatie van het proxyPolicy.
proxyPolicyName: "proxyPolicy"
Type
"proxyPolicy"
redirectPolicyName
De programmatische identificatie van de redirectPolicy.
redirectPolicyName: "redirectPolicy"
Type
"redirectPolicy"
setClientRequestIdPolicyName
De programmatische identificatie van de setClientRequestIdPolicy.
setClientRequestIdPolicyName: "setClientRequestIdPolicy"
Type
"setClientRequestIdPolicy"
systemErrorRetryPolicyName
De programmatische identificatie van de systemErrorRetryPolicy.
systemErrorRetryPolicyName: "systemErrorRetryPolicy"
Type
"systemErrorRetryPolicy"
throttlingRetryPolicyName
De programmatische identificatie van de throttlingRetryPolicy.
throttlingRetryPolicyName: "throttlingRetryPolicy"
Type
"throttlingRetryPolicy"
tracingPolicyName
De programmatische identificatie van het tracingPolicy.
tracingPolicyName: "tracingPolicy"
Type
"tracingPolicy"
userAgentPolicyName
De programmatische identificatie van de userAgentPolicy.
userAgentPolicyName: "userAgentPolicy"
Type
"userAgentPolicy"