@azure/core-rest-pipeline package
Klasy
RestError |
Niestandardowy typ błędu dla żądań potoku, który zakończył 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 |
AuthorizeRequestOnChallengeOptions |
Opcje wysyłane do wywołania zwrotnego authorizeRequestOnChallenge |
AuthorizeRequestOptions |
Opcje wysyłane do wywołania zwrotnego authorizeRequest |
AuxiliaryAuthenticationHeaderPolicyOptions |
Opcje konfigurowania obiektu pomocniczegoAuthenticationHeaderPolicy |
BearerTokenAuthenticationPolicyOptions |
Opcje konfigurowania elementu bearerTokenAuthenticationPolicy |
BodyPart |
Część treści żądania w żądaniu wieloczęściowym. |
ChallengeCallbacks |
Opcje zastąpienia przetwarzania oceny ciągłego dostępu wyzwania. |
CreateFileFromStreamOptions |
Dodatkowe opcje dla elementu createFile podczas przekazywania strumienia. |
CreateFileOptions |
Opcje przekazane do pliku createFile określające metadane dotyczące pliku. |
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 dla 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 |
LogPolicyOptions |
Opcje konfigurowania logPolicy. |
MultipartRequestBody |
Treść żądania składająca się z wielu części. |
Pipeline |
Reprezentuje potok do tworzenia żą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 modyfikować żą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 (tylkoNode.js). |
PxfObject |
Interfejs zgodny z |
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 prób. |
RetryModifiers |
Właściwości, które mogą modyfikować zachowanie zasad ponawiania. |
RetryPolicyOptions |
Opcje 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 informacji telemetrycznych i śledzenia |
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, obiektem blob lub plikiem. Jeśli chcesz przekazać plik o nazwie, ale nie masz dostępu do klasy File, możesz użyć pomocnika createFile, aby go utworzyć. |
HttpMethods |
Obsługiwane metody HTTP do użycia podczas wprowadzania żądań. |
PipelinePhase |
Zasady są wykonywane w fazach. Kolejność wykonywania to:
|
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
agent |
Pobiera zasady potoku, które ustawiają http.agent |
auxiliary |
Zasady dotyczące tokenów zewnętrznych do |
bearer |
Zasady, które mogą zażądać tokenu z implementacji TokenCredential, a następnie zastosować je do nagłówka autoryzacji żądania jako token elementu nośnego. |
create |
Utwórz prawidłowy obiekt HttpClient dla bieżącego środowiska. |
create |
Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego. |
create |
Utwórz obiekt, który implementuje interfejs File. Ten obiekt ma zostać przekazany do obiektu RequestBodyType.formData i nie ma gwarancji, że działa zgodnie z oczekiwaniami w innych sytuacjach. Użyj tej funkcji, aby utworzyć obiekt File do użycia w pliku RequestBodyType.formData w środowiskach, w których globalny obiekt File jest niedostępny. |
create |
Utwórz obiekt, który implementuje interfejs File. Ten obiekt ma zostać przekazany do obiektu RequestBodyType.formData i nie ma gwarancji, że działa zgodnie z oczekiwaniami w innych sytuacjach. Użyj tej funkcji, aby:
|
create |
Tworzy obiekt, który spełnia interfejs |
create |
Utwórz nowy potok z domyślnym zestawem zasad, które można dostosowywać. |
create |
Tworzy nowe żądanie potoku z podanymi opcjami. Ta metoda umożliwia łatwe ustawienie wartości domyślnych i nie jest wymagane. |
decompress |
Zasady umożliwiające dekompresję odpowiedzi zgodnie z https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding nagłówka Accept-Encoding |
default |
Zasady, które ponawiają próbę zgodnie z trzema strategiami:
|
exponential |
Zasady, które próbują ponowić żądania, wprowadzając wykładniczo rosnące opóźnienie. |
form |
Zasady, które koduje formData w żądaniu do treści. |
get |
Ta metoda konwertuje adres URL serwera proxy na |
is |
Funkcja Typeguard dla błędu RestError |
log |
Zasady, które rejestrują wszystkie żądania i odpowiedzi. |
multipart |
Zasady potoku dla żądań wieloczęściowych |
nd |
ndJsonPolicy to zasady służące do kontrolowania ustawień zachowania aktywności dla każdego żądania. |
proxy |
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. |
redirect |
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. |
retry |
retryPolicy to ogólne zasady umożliwiające ponawianie żądań po spełnieniu określonych warunków |
set |
Każde żądanie PipelineRequest pobiera unikatowy identyfikator podczas tworzenia. Te zasady przekazują ten unikatowy identyfikator za pośrednictwem nagłówka HTTP, aby umożliwić lepszą telemetrię i śledzenie. |
system |
Zasady ponawiania prób, które w szczególności mają na celu obsługę błędów w podstawowej warstwie transportu (np. błędy wyszukiwania DNS) zamiast ponawiania prób kodów błędów z samego serwera. |
throttling |
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 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 i https://learn.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors |
tls |
Pobiera zasady potoku, które dodaje certyfikat klienta do agenta HttpClient na potrzeby uwierzytelniania. |
tracing |
Proste zasady umożliwiające utworzenie funkcji OpenTelemetry Spans dla każdego żądania wykonanego przez potok, który ma element SpanOptions z elementem nadrzędnym. Żądania wysyłane bez nadrzędnego zakresu nie zostaną zarejestrowane. |
user |
Zasady, które ustawiają nagłówek User-Agent (lub równoważny) w celu odzwierciedlenia wersji biblioteki. |
Szczegóły funkcji
agentPolicy(Agent)
Pobiera zasady potoku, które ustawiają http.agent
function agentPolicy(agent?: Agent): PipelinePolicy
Parametry
- agent
- Agent
Zwraca
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
Zasady dotyczące tokenów zewnętrznych do x-ms-authorization-auxiliary
nagłówka.
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.
Aby uzyskać informacje na temat działania tej funkcji, można zobaczyć dokumentację usługi ARM
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy
Parametry
Zwraca
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
Zasady, które mogą zażądać tokenu z implementacji TokenCredential, a następnie zastosować je do nagłówka autoryzacji żądania jako token elementu nośnego.
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy
Parametry
Zwraca
createDefaultHttpClient()
Utwórz prawidłowy obiekt HttpClient dla bieżącego środowiska.
function createDefaultHttpClient(): HttpClient
Zwraca
createEmptyPipeline()
Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego.
function createEmptyPipeline(): Pipeline
Zwraca
createFile(Uint8Array, string, CreateFileOptions)
Utwórz obiekt, który implementuje interfejs File. Ten obiekt ma zostać przekazany do obiektu RequestBodyType.formData i nie ma gwarancji, że działa zgodnie z oczekiwaniami w innych sytuacjach.
Użyj tej funkcji, aby utworzyć obiekt File do użycia w pliku RequestBodyType.formData w środowiskach, w których globalny obiekt File jest niedostępny.
function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File
Parametry
- content
-
Uint8Array
zawartość pliku jako Uint8Array w pamięci.
- name
-
string
nazwa pliku.
- options
- CreateFileOptions
opcjonalne metadane dotyczące pliku, np. nazwa pliku, rozmiar pliku, typ MIME.
Zwraca
File
createFileFromStream(() => ReadableStream<Uint8Array> | ReadableStream, string, CreateFileFromStreamOptions)
Utwórz obiekt, który implementuje interfejs File. Ten obiekt ma zostać przekazany do obiektu RequestBodyType.formData i nie ma gwarancji, że działa zgodnie z oczekiwaniami w innych sytuacjach.
Użyj tej funkcji, aby:
- Utwórz obiekt File do użycia w pliku RequestBodyType.formData w środowiskach, w których globalny obiekt File jest niedostępny.
- Utwórz obiekt podobny do pliku na podstawie czytelnego strumienia bez odczytywania strumienia do pamięci.
function createFileFromStream(stream: () => ReadableStream<Uint8Array> | ReadableStream, name: string, options?: CreateFileFromStreamOptions): File
Parametry
- stream
-
() => ReadableStream<Uint8Array> | ReadableStream
zawartość pliku jako wywołanie zwrotne zwracające strumień. Gdy obiekt File utworzony przy użyciu metody createFile jest przekazywany na mapie danych formularza żądania, strumień nie będzie odczytywany do pamięci i zamiast tego będzie przesyłany strumieniowo po wysłaniu żądania. W przypadku ponawiania próby strumień musi być ponownie odczytany, więc to wywołanie zwrotne POWINNO zwrócić nowy strumień, jeśli to możliwe.
- name
-
string
nazwa pliku.
- options
- CreateFileFromStreamOptions
opcjonalne metadane dotyczące pliku, np. nazwa pliku, rozmiar pliku, typ MIME.
Zwraca
File
createHttpHeaders(RawHttpHeadersInput)
Tworzy obiekt, który spełnia interfejs HttpHeaders
.
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders
Parametry
- rawHeaders
- RawHttpHeadersInput
Prosty obiekt reprezentujący początkowe nagłówki
Zwraca
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
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
decompressResponsePolicy()
Zasady umożliwiające dekompresję odpowiedzi zgodnie z https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding nagłówka Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy
Zwraca
defaultRetryPolicy(DefaultRetryPolicyOptions)
Zasady, które ponawiają 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, ponowi próbę z wykładniczo rosnącym opóźnieniem.
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy
Parametry
- options
- DefaultRetryPolicyOptions
Zwraca
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
formDataPolicy()
Zasady, które koduje formData w żądaniu do treści.
function formDataPolicy(): PipelinePolicy
Zwraca
getDefaultProxySettings(string)
Ostrzeżenie
Ten interfejs API jest już przestarzały.
- Internally this method is no longer necessary when setting proxy information.
Ta metoda konwertuje adres URL serwera proxy na ProxySettings
do użycia z serwerem ProxyPolicy.
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
multipartPolicy()
Zasady potoku dla żądań wieloczęściowych
function multipartPolicy(): PipelinePolicy
Zwraca
ndJsonPolicy()
ndJsonPolicy to zasady służące do kontrolowania ustawień zachowania aktywności dla każdego żądania.
function ndJsonPolicy(): PipelinePolicy
Zwraca
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
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
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy to ogólne zasady umożliwiające ponawianie żądań po spełnieniu określonych warunków
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy
Parametry
- strategies
- options
- RetryPolicyOptions
Zwraca
setClientRequestIdPolicy(string)
Każde żądanie PipelineRequest pobiera unikatowy identyfikator podczas tworzenia. Te zasady przekazują 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 przekazać identyfikator żądania.
Zwraca
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
Zasady ponawiania prób, które w szczególności mają na celu obsługę błędów w podstawowej warstwie transportu (np. błędy 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 dostosują zasady.
Zwraca
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 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 i https://learn.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
tlsPolicy(TlsSettings)
Pobiera zasady potoku, które dodaje certyfikat klienta do agenta HttpClient na potrzeby uwierzytelniania.
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy
Parametry
- tlsSettings
- TlsSettings
Zwraca
tracingPolicy(TracingPolicyOptions)
Proste zasady umożliwiające utworzenie funkcji OpenTelemetry Spans dla każdego żądania wykonanego przez potok, który ma element SpanOptions z elementem nadrzędnym. Żądania wysyłane bez nadrzędnego zakresu nie zostaną zarejestrowane.
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy
Parametry
- options
- TracingPolicyOptions
Opcje konfigurowania telemetrii rejestrowanej przez zasady śledzenia.
Zwraca
userAgentPolicy(UserAgentPolicyOptions)
Zasady, które ustawiają nagłówek User-Agent (lub równoważny) w celu odzwierciedlenia wersji biblioteki.
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy
Parametry
- options
- UserAgentPolicyOptions
Opcje dostosowywania wartości agenta użytkownika.