@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 ander beleid uit te drukken. |
Agent |
Een interface die compatibel is met de |
AuthorizeRequestOnChallengeOptions |
Opties die worden verzonden naar de callback authorizeRequestOnChallenge |
AuthorizeRequestOptions |
Opties die worden verzonden naar de callback van authorizeRequest |
AuxiliaryAuthenticationHeaderPolicyOptions |
Opties voor het configureren van de auxiliaryAuthenticationHeaderPolicy |
BearerTokenAuthenticationPolicyOptions |
Opties voor het configureren van bearerTokenAuthenticationPolicy |
BodyPart |
Een deel van de aanvraagbody in een aanvraag met meerdere onderdelen. |
ChallengeCallbacks |
Opties voor het negeren van de verwerking van Continue toegangsevaluatie uitdagingen. |
CreateFileFromStreamOptions |
Extra opties voor createFile wanneer een stream wordt doorgegeven. |
CreateFileOptions |
Opties die zijn doorgegeven aan createFile die metagegevens over het bestand opgeven. |
DefaultRetryPolicyOptions |
Opties voor het opnieuw proberen van mislukte aanvragen. |
ExponentialRetryPolicyOptions |
Opties voor het opnieuw proberen van mislukte aanvragen. |
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 de |
LogPolicyOptions |
Opties voor het configureren van logPolicy. |
MultipartRequestBody |
Een aanvraagbody die bestaat uit meerdere onderdelen. |
Pipeline |
Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag 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 Gedeeltelijk, maar de URL is verplicht. |
PipelineResponse |
Metagegevens over een antwoord dat door de pijplijn is ontvangen. |
PipelineRetryOptions |
Opties voor het opnieuw proberen van mislukte aanvragen. |
ProxySettings |
Opties voor het configureren van een proxy voor uitgaande aanvragen (alleenNode.js). |
PxfObject |
Een interface die compatibel is met de |
RedirectPolicyOptions |
Opties voor de manier waarop omleidingsreacties worden verwerkt. |
RestErrorOptions |
De opties die worden ondersteund door RestError. |
RetryInformation |
Informatie over de strategie voor opnieuw proberen over de huidige voortgang van het beleid voor opnieuw proberen. |
RetryModifiers |
Eigenschappen waarmee het gedrag van het beleid voor opnieuw proberen kan worden gewijzigd. |
RetryPolicyOptions |
Opties voor de retryPolicy- |
RetryStrategy |
Een strategie voor opnieuw proberen is bedoeld om te definiëren of u het opnieuw wilt proberen en hoe u het opnieuw moet proberen. |
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 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, blob of een bestand zijn. Als u een bestand met een naam wilt doorgeven, maar geen toegang hebt tot de bestandsklasse, kunt u de createFile-helper gebruiken om er een te maken. |
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. |
RawHttpHeadersInput |
Een HttpHeaders-verzameling voor invoer, weergegeven als een eenvoudig JSON-object. |
RequestBodyType |
Typen lichamen die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen knooppunt. 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 het uploaden of downloaden van de voortgang. |
Functies
agent |
Hiermee haalt u een pijplijnbeleid op waarmee http.agent wordt ingesteld |
auxiliary |
Een beleid voor externe tokens voor |
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 |
Maak de juiste HttpClient voor de huidige omgeving. |
create |
Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste. |
create |
Maak een object waarmee de bestandsinterface wordt geïmplementeerd. Dit object is bedoeld om door te geven aan RequestBodyType.formData en werkt niet zoals verwacht in andere situaties. Met deze functie maakt u een bestandsobject voor gebruik in RequestBodyType.formData in omgevingen waarin het globale bestandsobject niet beschikbaar is. |
create |
Maak een object waarmee de bestandsinterface wordt geïmplementeerd. Dit object is bedoeld om door te geven aan RequestBodyType.formData en werkt niet zoals verwacht in andere situaties. Gebruik deze functie om:
|
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 |
default |
Een beleid dat opnieuw wordt geprobeerd volgens drie strategieën:
|
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 |
is |
Typeguard voor RestError |
log |
Een beleid dat alle aanvragen en antwoorden registreert. |
multipart |
Pijplijnbeleid voor aanvragen met meerdere onderdelen |
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. In de browser wordt dit beleid niet gebruikt. |
retry |
retryPolicy is een algemeen beleid om het opnieuw proberen van aanvragen in te schakelen wanneer aan bepaalde voorwaarden wordt voldaan |
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://learn.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://learn.microsoft.com/en-us/azure/azure-subscription-service-limits en https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors voor meer informatie |
tls |
Hiermee haalt u een pijplijnbeleid op waarmee het clientcertificaat wordt toegevoegd aan de HttpClient-agent voor verificatie. |
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. |
Functiedetails
agentPolicy(Agent)
Hiermee haalt u een pijplijnbeleid op waarmee http.agent wordt ingesteld
function agentPolicy(agent?: Agent): PipelinePolicy
Parameters
- agent
- Agent
Retouren
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
Een beleid voor externe tokens voor x-ms-authorization-auxiliary
header.
Deze header wordt gebruikt bij het maken van een toepassing voor meerdere tenants. Mogelijk moeten we verificatieaanvragen verwerken voor resources die zich in verschillende tenants bevinden.
U kunt ARM-documenten zien voor een overzicht van hoe deze functie werkt
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
Parameters
Retouren
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
createDefaultHttpClient()
Maak de juiste HttpClient voor de huidige omgeving.
function createDefaultHttpClient(): HttpClient
Retouren
createEmptyPipeline()
Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste.
function createEmptyPipeline(): Pipeline
Retouren
createFile(Uint8Array, string, CreateFileOptions)
Maak een object waarmee de bestandsinterface wordt geïmplementeerd. Dit object is bedoeld om door te geven aan RequestBodyType.formData en werkt niet zoals verwacht in andere situaties.
Met deze functie maakt u een bestandsobject voor gebruik in RequestBodyType.formData in omgevingen waarin het globale bestandsobject niet beschikbaar is.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File
Parameters
- content
-
Uint8Array
de inhoud van het bestand als een Uint8Array in het geheugen.
- name
-
string
de naam van het bestand.
- options
- CreateFileOptions
optionele metagegevens over het bestand, bijvoorbeeld bestandsnaam, bestandsgrootte, MIME-type.
Retouren
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
Maak een object waarmee de bestandsinterface wordt geïmplementeerd. Dit object is bedoeld om door te geven aan RequestBodyType.formData en werkt niet zoals verwacht in andere situaties.
Gebruik deze functie om:
- Maak een bestandsobject voor gebruik in RequestBodyType.formData in omgevingen waarin het globale bestandsobject niet beschikbaar is.
- Maak een bestandachtig object van een leesbare stream zonder de stroom in het geheugen te lezen.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File
Parameters
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
de inhoud van het bestand als een callback die een stream retourneert. Wanneer een bestandsobject dat is gemaakt met createFile wordt doorgegeven in de formuliergegevenstoewijzing van een aanvraag, wordt de stream niet in het geheugen gelezen en wordt in plaats daarvan gestreamd wanneer de aanvraag wordt gedaan. In het geval van een nieuwe poging moet de stream opnieuw worden gelezen, dus deze callback moet indien mogelijk een nieuwe stream retourneren.
- name
-
string
de naam van het bestand.
- options
- CreateFileFromStreamOptions
optionele metagegevens over het bestand, bijvoorbeeld bestandsnaam, bestandsgrootte, MIME-type.
Retouren
File
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
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
defaultRetryPolicy(DefaultRetryPolicyOptions)
Een beleid dat opnieuw wordt geprobeerd volgens drie strategieën:
- Wanneer de server een 429-antwoord verzendt met een Retry-After header.
- Wanneer er fouten zijn opgetreden 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
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)
Waarschuwing
Deze API is nu afgeschaft.
- Internally this method is no longer necessary when setting proxy information.
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
isRestError(unknown)
Typeguard voor RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Iets betrapt 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
multipartPolicy()
Pijplijnbeleid voor aanvragen met meerdere onderdelen
function multipartPolicy(): PipelinePolicy
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, { customNoProxyList?: string[] })
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, options?: { customNoProxyList?: string[] }): PipelinePolicy
Parameters
- proxySettings
- ProxySettings
ProxySettings die voor elke aanvraag moeten worden gebruikt.
- options
-
{ customNoProxyList?: string[] }
aanvullende instellingen, bijvoorbeeld aangepaste NO_PROXY patronen
Retouren
redirectPolicy(RedirectPolicyOptions)
Een beleid voor het volgen van locatieheaders van de server 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
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy is een algemeen beleid om het opnieuw proberen van aanvragen in te schakelen wanneer aan bepaalde voorwaarden wordt voldaan
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy
Parameters
- strategies
- options
- RetryPolicyOptions
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(ThrottlingRetryPolicyOptions)
Een beleid dat opnieuw probeert wanneer de server een 429-antwoord verzendt met een Retry-After header.
Raadpleeg 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 en https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors voor meer informatie
function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy
Parameters
- options
- ThrottlingRetryPolicyOptions
Opties voor het configureren van logica voor opnieuw proberen.
Retouren
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
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.