@azure/core-rest-pipeline package

Klasy

RestError

Niestandardowy typ błędu dla żądań potoku, które zakończyły się niepowodzeniem.

Interfejsy

AddPipelineOptions	Opcje podczas dodawania zasad do potoku. Służy do wyrażania zależności od innych zasad.
Agent	Interfejs zgodny z platformą NodeJS http.Agent. Chcemy uniknąć publicznego ponownego eksportowania rzeczywistego interfejsu, ponieważ może się różnić w różnych wersjach środowiska uruchomieniowego.
AuthorizeRequestOnChallengeOptions	Opcje wysyłane do wywołania zwrotnego authorizeRequestOnChallenge
AuthorizeRequestOptions	Opcje wysyłane do wywołania zwrotnego authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Opcje konfigurowania obiektu auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Opcje konfigurowania elementu bearerTokenAuthenticationPolicy
ChallengeCallbacks	Opcje zastępowania przetwarzania wyzwań związanych z ciągłą oceną dostępu .
DefaultRetryPolicyOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
ExponentialRetryPolicyOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
HttpClient	Wymagany interfejs klienta, który wysyła żądania HTTP w imieniu potoku.
HttpHeaders	Reprezentuje zestaw nagłówków HTTP dla żądania/odpowiedzi. Nazwy nagłówków są traktowane jako bez uwzględniania wielkości liter.
InternalPipelineOptions	Definiuje opcje używane do konfigurowania wewnętrznych opcji potoku HTTP dla klienta zestawu SDK.
KeyObject	Interfejs zgodny z platformą NodeJS tls.KeyObject. Chcemy uniknąć publicznego ponownego eksportowania rzeczywistego interfejsu, ponieważ może się różnić w różnych wersjach środowiska uruchomieniowego.
LogPolicyOptions	Opcje konfigurowania zasad logPolicy.
Pipeline	Reprezentuje potok umożliwiający wysyłanie żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.
PipelineOptions	Definiuje opcje używane do konfigurowania potoku HTTP dla klienta zestawu SDK.
PipelinePolicy	Zasady potoku manipulują żądaniem podczas przechodzenia przez potok. Jest to oprogramowanie pośredniczące, które może zmodyfikować żądanie przed jego wykonaniem, a także odpowiedź po odebraniu.
PipelineRequest	Metadane dotyczące żądania wykonywanego przez potok.
PipelineRequestOptions	Ustawienia inicjowania żądania. Prawie równoważne częściowe, ale adres URL jest obowiązkowy.
PipelineResponse	Metadane dotyczące odpowiedzi odebranej przez potok.
PipelineRetryOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
ProxySettings	Opcje konfigurowania serwera proxy dla żądań wychodzących (tylko Node.js).
PxfObject	Interfejs zgodny z platformą NodeJS tls.PxfObject. Chcemy uniknąć publicznego ponownego eksportowania rzeczywistego interfejsu, ponieważ może się różnić w różnych wersjach środowiska uruchomieniowego.
RedirectPolicyOptions	Opcje obsługi odpowiedzi przekierowania.
RestErrorOptions	Opcje obsługiwane przez funkcję RestError.
RetryInformation	Informacje przekazane strategii ponawiania prób dotyczące bieżącego postępu zasad ponawiania.
RetryModifiers	Właściwości, które mogą modyfikować zachowanie zasad ponawiania.
RetryPolicyOptions	Opcje dla zasad retryPolicy
RetryStrategy	Strategia ponawiania prób ma na celu określenie, czy należy ponowić próbę, czy nie, i jak ponowić próbę.
SystemErrorRetryPolicyOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
TelemetryOptions	Definiuje opcje używane do konfigurowania typowych danych telemetrycznych i informacji o śledzeniu
ThrottlingRetryPolicyOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
TlsSettings	Reprezentuje certyfikat uwierzytelniania TLS.
TracingPolicyOptions	Opcje konfigurowania zasad śledzenia.
UserAgentPolicyOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Aliasy typu

FormDataMap	Prosty obiekt, który dostarcza dane formularza, tak jak w przypadku formularza przeglądarki.
FormDataValue	Każdy wpis danych formularza może być ciągiem lub (w przeglądarce) obiektem blob.
HttpMethods	Obsługiwane metody HTTP do użycia podczas tworzenia żądań.
PipelinePhase	Zasady są wykonywane w fazach. Kolejność wykonywania to: Serializowanie fazy Zasady nie są w fazie Deserializowanie fazy Faza ponawiania prób Faza podpisywania
RawHttpHeaders	Kolekcja HttpHeaders reprezentowana jako prosty obiekt JSON.
RawHttpHeadersInput	Kolekcja HttpHeaders dla danych wejściowych reprezentowana jako prosty obiekt JSON.
RequestBodyType	Typy ciał obsługiwanych na żądanie. NodeJS.ReadableStream i () => NodeJS.ReadableStream jest tylko węzłem. Obiekty blob, ReadableStream i () => ReadableStream są tylko przeglądarką.
SendRequest	Prosty interfejs do tworzenia żądania potoku i odbierania odpowiedzi.
TransferProgressEvent	Wyzwolony w odpowiedzi na postęp przekazywania lub pobierania.

Funkcje

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Zasady dotyczące tokenów zewnętrznych do nagłówka x-ms-authorization-auxiliary . Ten nagłówek będzie używany podczas tworzenia aplikacji między dzierżawami, która może wymagać obsługi żądań uwierzytelniania dla zasobów, które znajdują się w różnych dzierżawach. Dokumentacji usługi ARM można zobaczyć w celu sprawdzenia, jak działa ta funkcja
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Zasady, które mogą zażądać tokenu z implementacji TokenCredential, a następnie zastosować je do nagłówka Autoryzacja żądania jako token elementu nośnego.
createDefaultHttpClient()	Utwórz poprawny element HttpClient dla bieżącego środowiska.
createEmptyPipeline()	Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego.
createHttpHeaders(RawHttpHeadersInput)	Tworzy obiekt spełniający wymagania interfejsu HttpHeaders .
createPipelineFromOptions(InternalPipelineOptions)	Utwórz nowy potok z domyślnym zestawem zasad, które można dostosowywać.
createPipelineRequest(PipelineRequestOptions)	Tworzy nowe żądanie potoku z podanymi opcjami. Ta metoda umożliwia łatwe ustawienie wartości domyślnych i nie jest wymagane.
decompressResponsePolicy()	Zasady umożliwiające dekompresję odpowiedzi zgodnie z nagłówkiem Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Zasady, które ponawia próbę zgodnie z trzema strategiami: Gdy serwer wysyła odpowiedź 429 z nagłówkiem Retry-After. W przypadku wystąpienia błędów w podstawowej warstwie transportu (np. niepowodzenia wyszukiwania DNS). W przeciwnym razie, jeśli żądanie wychodzące zakończy się niepowodzeniem, zostanie ponowiona próba z wykładniczo rosnącym opóźnieniem.
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Zasady, które próbują ponowić żądania, wprowadzając wykładniczo rosnące opóźnienie.
formDataPolicy()	Zasady, które koduje formData na żądanie do treści.
getDefaultProxySettings(string)	Ta metoda konwertuje adres URL serwera proxy na ProxySettings do użycia z zasadami proxy. Jeśli argument nie zostanie podany, próbuje przeanalizować adres URL serwera proxy ze zmiennych środowiskowych HTTPS_PROXY lub HTTP_PROXY.
isRestError(unknown)	Funkcja Typeguard dla błędu RestError
logPolicy(LogPolicyOptions)	Zasady, które rejestrują wszystkie żądania i odpowiedzi.
ndJsonPolicy()	ndJsonPolicy to zasady służące do kontrolowania ustawień zachowania aktywności dla każdego żądania.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Zasady, które umożliwiają stosowanie ustawień serwera proxy do wszystkich żądań. Jeśli ustawienia statyczne nie zostaną przekazane, zostaną pobrane z HTTPS_PROXY lub HTTP_PROXY zmiennych środowiskowych.
redirectPolicy(RedirectPolicyOptions)	Zasady, które mają być zgodne z nagłówkami Lokalizacji z serwera w celu obsługi przekierowania po stronie serwera. W przeglądarce te zasady nie są używane.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy to zasady ogólne umożliwiające ponawianie żądań po spełnieniu określonych warunków
setClientRequestIdPolicy(string)	Każde żądanie PipelineRequest otrzymuje unikatowy identyfikator podczas tworzenia. Te zasady przekazuje ten unikatowy identyfikator za pośrednictwem nagłówka HTTP, aby umożliwić lepszą telemetrię i śledzenie.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Zasady ponawiania, które w szczególności dążą do obsługi błędów w podstawowej warstwie transportu (np. niepowodzenia wyszukiwania DNS) zamiast ponawiania prób kodów błędów z samego serwera.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Zasady, które ponawia próbę, gdy serwer wysyła odpowiedź 429 z nagłówkiem Retry-After. Aby dowiedzieć się więcej, zapoznaj się z tematem 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 i https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tlsPolicy(TlsSettings)	Pobiera zasady potoku, które dodają certyfikat klienta do agenta HttpClient na potrzeby uwierzytelniania.
tracingPolicy(TracingPolicyOptions)	Proste zasady służące do tworzenia zakresów OpenTelemetry dla każdego żądania wykonanego przez potok zawierający element SpanOptions z elementem nadrzędnym. Żądania wykonane bez nadrzędnego zakresu nie zostaną zarejestrowane.
userAgentPolicy(UserAgentPolicyOptions)	Zasady, które ustawiają nagłówek User-Agent (lub odpowiednik) w celu odzwierciedlenia wersji biblioteki.

Szczegóły funkcji

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Zasady dotyczące tokenów zewnętrznych do nagłówka x-ms-authorization-auxiliary . Ten nagłówek będzie używany podczas tworzenia aplikacji między dzierżawami, która może wymagać obsługi żądań uwierzytelniania dla zasobów, które znajdują się w różnych dzierżawach. Dokumentacji usługi ARM można zobaczyć w celu sprawdzenia, jak działa ta funkcja

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parametry

options

AuxiliaryAuthenticationHeaderPolicyOptions

Zwraca

PipelinePolicy

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Zasady, które mogą zażądać tokenu z implementacji TokenCredential, a następnie zastosować je do nagłówka Autoryzacja żądania jako token elementu nośnego.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parametry

options

BearerTokenAuthenticationPolicyOptions

Zwraca

PipelinePolicy

createDefaultHttpClient()

Utwórz poprawny element HttpClient dla bieżącego środowiska.

function createDefaultHttpClient(): HttpClient

Zwraca

HttpClient

createEmptyPipeline()

Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego.

function createEmptyPipeline(): Pipeline

Zwraca

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Tworzy obiekt spełniający wymagania interfejsu HttpHeaders .

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametry

rawHeaders

RawHttpHeadersInput

Prosty obiekt reprezentujący początkowe nagłówki

Zwraca

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Utwórz nowy potok z domyślnym zestawem zasad, które można dostosowywać.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parametry

options

InternalPipelineOptions

Opcje konfigurowania potoku niestandardowego.

Zwraca

Pipeline

createPipelineRequest(PipelineRequestOptions)

Tworzy nowe żądanie potoku z podanymi opcjami. Ta metoda umożliwia łatwe ustawienie wartości domyślnych i nie jest wymagane.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametry

options

PipelineRequestOptions

Opcje tworzenia żądania za pomocą polecenia .

Zwraca

PipelineRequest

decompressResponsePolicy()

Zasady umożliwiające dekompresję odpowiedzi zgodnie z nagłówkiem Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Zwraca

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Zasady, które ponawia próbę zgodnie z trzema strategiami:

• Gdy serwer wysyła odpowiedź 429 z nagłówkiem Retry-After.
• W przypadku wystąpienia błędów w podstawowej warstwie transportu (np. niepowodzenia wyszukiwania DNS).
• W przeciwnym razie, jeśli żądanie wychodzące zakończy się niepowodzeniem, zostanie ponowiona próba z wykładniczo rosnącym opóźnieniem.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parametry

options

DefaultRetryPolicyOptions

Zwraca

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Zasady, które próbują ponowić żądania, wprowadzając wykładniczo rosnące opóźnienie.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parametry

options

ExponentialRetryPolicyOptions

Opcje, które konfigurują logikę ponawiania prób.

Zwraca

PipelinePolicy

formDataPolicy()

Zasady, które koduje formData na żądanie do treści.

function formDataPolicy(): PipelinePolicy

Zwraca

PipelinePolicy

getDefaultProxySettings(string)

Ta metoda konwertuje adres URL serwera proxy na ProxySettings do użycia z zasadami proxy. Jeśli argument nie zostanie podany, próbuje przeanalizować adres URL serwera proxy ze zmiennych środowiskowych HTTPS_PROXY lub HTTP_PROXY.

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

Parametry

proxyUrl

string

Adres URL serwera proxy do użycia. Może zawierać informacje o uwierzytelnianiu.

Zwraca

ProxySettings | undefined

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

logPolicy(LogPolicyOptions)

Zasady, które rejestrują wszystkie żądania i odpowiedzi.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parametry

options

LogPolicyOptions

Opcje konfigurowania zasad logPolicy.

Zwraca

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy to zasady służące do kontrolowania ustawień zachowania aktywności dla każdego żądania.

function ndJsonPolicy(): PipelinePolicy

Zwraca

PipelinePolicy

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

Zasady, które umożliwiają stosowanie ustawień serwera proxy do wszystkich żądań. Jeśli ustawienia statyczne nie zostaną przekazane, zostaną pobrane z HTTPS_PROXY lub HTTP_PROXY zmiennych środowiskowych.

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

Parametry

proxySettings

ProxySettings

ProxySettings do użycia w każdym żądaniu.

options

{ customNoProxyList?: string[] }

dodatkowe ustawienia, na przykład niestandardowe wzorce NO_PROXY

Zwraca

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Zasady, które mają być zgodne z nagłówkami Lokalizacji z serwera w celu obsługi przekierowania po stronie serwera. W przeglądarce te zasady nie są używane.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parametry

options

RedirectPolicyOptions

Opcje kontrolowania zachowania zasad.

Zwraca

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy to zasady ogólne umożliwiające ponawianie żądań po spełnieniu określonych warunków

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

Parametry

strategies

RetryStrategy[]

options

RetryPolicyOptions

Zwraca

PipelinePolicy

setClientRequestIdPolicy(string)

Każde żądanie PipelineRequest otrzymuje unikatowy identyfikator podczas tworzenia. Te zasady przekazuje ten unikatowy identyfikator za pośrednictwem nagłówka HTTP, aby umożliwić lepszą telemetrię i śledzenie.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parametry

requestIdHeaderName

string

Nazwa nagłówka, do którego ma być przekazywany identyfikator żądania.

Zwraca

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Zasady ponawiania, które w szczególności dążą do obsługi błędów w podstawowej warstwie transportu (np. niepowodzenia wyszukiwania DNS) zamiast ponawiania prób kodów błędów z samego serwera.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parametry

options

SystemErrorRetryPolicyOptions

Opcje, które dostosowują zasady.

Zwraca

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

Zasady, które ponawia próbę, gdy serwer wysyła odpowiedź 429 z nagłówkiem Retry-After.

Aby dowiedzieć się więcej, zapoznaj się z tematem 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 i https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parametry

options

ThrottlingRetryPolicyOptions

Opcje, które konfigurują logikę ponawiania prób.

Zwraca

PipelinePolicy

tlsPolicy(TlsSettings)

Pobiera zasady potoku, które dodają certyfikat klienta do agenta HttpClient na potrzeby uwierzytelniania.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parametry

tlsSettings

TlsSettings

Zwraca

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Proste zasady służące do tworzenia zakresów OpenTelemetry dla każdego żądania wykonanego przez potok zawierający element SpanOptions z elementem nadrzędnym. Żądania wykonane bez nadrzędnego zakresu nie zostaną zarejestrowane.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parametry

options

TracingPolicyOptions

Opcje konfigurowania telemetrii rejestrowanej przez zasady śledzenia.

Zwraca

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Zasady, które ustawiają nagłówek User-Agent (lub odpowiednik) w celu odzwierciedlenia wersji biblioteki.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parametry

options

UserAgentPolicyOptions

Opcje dostosowywania wartości agenta użytkownika.

Zwraca

PipelinePolicy