@azure/core-https package
Klasy
| DefaultHttpsClient |
Implementacja HttpsClient, która używa modułu "https" węzła do wysyłania żądań HTTPS. |
| RestError |
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem. |
Interfejsów
| AddPipelineOptions |
Opcje podczas dodawania zasad do potoku. Służy do wyrażania zależności od innych zasad. |
| BearerTokenAuthenticationPolicyOptions |
Opcje konfigurowania elementu bearerTokenAuthenticationPolicy |
| ExponentialRetryPolicyOptions |
Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem. |
| HttpHeaders |
Reprezentuje zestaw nagłówków HTTP dla żądania/odpowiedzi. Nazwy nagłówków są traktowane jako bez uwzględniania wielkości liter. |
| HttpsClient |
Wymagany interfejs dla klienta, który wysyła żądania HTTPS w imieniu potoku. |
| InternalPipelineOptions |
Definiuje opcje używane do konfigurowania wewnętrznych opcji potoku HTTP dla klienta zestawu SDK. |
| LogPolicyOptions |
Opcje konfigurowania logPolicy. |
| Pipeline |
Reprezentuje potok służący do wysyłania żądania HTTPS 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 odpowiednik Partial<PipelineRequest>, ale url jest obowiązkowy. |
| PipelineResponse |
Metadane dotyczące odpowiedzi odebranej przez potok. |
| ProxySettings |
Opcje konfigurowania serwera proxy dla żądań wychodzących (tylkoNode.js). |
| RedirectPolicyOptions |
Opcje obsługi odpowiedzi przekierowania. |
| RestErrorOptions |
Opcje obsługiwane przez funkcję RestError. |
| SystemErrorRetryPolicyOptions |
Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem. |
| 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 w formularzu może być ciągiem znaków lub (w przeglądarce) obiektem blob. |
| 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. |
| RequestBodyType |
Typy ciał obsługiwanych na żądanie. NodeJS.ReadableStream to tylko węzeł. Blob jest tylko przeglądarką. |
| SendRequest |
Prosty interfejs do tworzenia żądania potoku i odbierania odpowiedzi. |
| TransferProgressEvent |
Wyzwolony w odpowiedzi na postęp przekazywania lub pobierania. |
Functions
| 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 |
Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego. |
| 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 |
| 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 |
| log |
Zasady, które rejestrują wszystkie żądania i odpowiedzi. |
| 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. |
| 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://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 |
| 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. |
Zmiennych
| bearer |
Programowy identyfikator nośnikaTokenAuthenticationPolicy. |
| decompress |
Programowy identyfikator decompressResponsePolicy. |
| expontential |
Programowy identyfikator wykładniczej RetryPolicy. |
| form |
Identyfikator programowy formularza DataPolicy. |
| log |
Programowy identyfikator logPolicy. |
| nd |
Programowy identyfikator ndJsonPolicy. |
| proxy |
Programowy identyfikator proxyPolicy. |
| redirect |
Programowy identyfikator polityki przekierowania. |
| set |
Programowy identyfikator setClientRequestIdPolicy. |
| system |
Programowy identyfikator systemErrorRetryPolicy. |
| throttling |
Programowy identyfikator throttlingRetryPolicy. |
| tracing |
Programowy identyfikator polityki śledzenia. |
| user |
Programowy identyfikator userAgentPolicy. |
Szczegóły funkcji
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
createEmptyPipeline()
Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego.
function createEmptyPipeline(): Pipeline
Zwraca
createHttpHeaders(RawHttpHeaders)
Tworzy obiekt, który spełnia interfejs HttpHeaders.
function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders
Parametry
- rawHeaders
- RawHttpHeaders
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
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)
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
logPolicy(LogPolicyOptions)
Zasady, które rejestrują wszystkie żądania i odpowiedzi.
function logPolicy(options?: LogPolicyOptions): PipelinePolicy
Parametry
- options
- LogPolicyOptions
Opcje konfigurowania zasad logPolicy.
Zwraca
ndJsonPolicy()
ndJsonPolicy to zasady służące do kontrolowania ustawień zachowania aktywności dla każdego żądania.
function ndJsonPolicy(): PipelinePolicy
Zwraca
proxyPolicy(ProxySettings)
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): PipelinePolicy
Parametry
- proxySettings
- ProxySettings
ProxySettings do użycia w każdym żądaniu.
Zwraca
redirectPolicy(RedirectPolicyOptions)
Zasady, które mają być zgodne z nagłówkami lokalizacji z serwera w celu obsługi przekierowania po stronie serwera.
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy
Parametry
- options
- RedirectPolicyOptions
Opcje kontrolowania zachowania zasad.
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()
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://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(): PipelinePolicy
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.
Zwraca
Variable Details
bearerTokenAuthenticationPolicyName
Programowy identyfikator nośnikaTokenAuthenticationPolicy.
bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"
Typ
"bearerTokenAuthenticationPolicy"
decompressResponsePolicyName
Programowy identyfikator decompressResponsePolicy.
decompressResponsePolicyName: "decompressResponsePolicy"
Typ
"decompressResponsePolicy"
expontentialRetryPolicyName
Programowy identyfikator wykładniczej RetryPolicy.
expontentialRetryPolicyName: "exponentialRetryPolicy"
Typ
"exponentialRetryPolicy"
formDataPolicyName
Identyfikator programowy formularza DataPolicy.
formDataPolicyName: "formDataPolicy"
Typ
"formDataPolicy"
logPolicyName
Programowy identyfikator logPolicy.
logPolicyName: "logPolicy"
Typ
"logPolicy"
ndJsonPolicyName
Programowy identyfikator ndJsonPolicy.
ndJsonPolicyName: "ndJsonPolicy"
Typ
"ndJsonPolicy"
proxyPolicyName
Programowy identyfikator proxyPolicy.
proxyPolicyName: "proxyPolicy"
Typ
"proxyPolicy"
redirectPolicyName
Programowy identyfikator polityki przekierowania.
redirectPolicyName: "redirectPolicy"
Typ
"redirectPolicy"
setClientRequestIdPolicyName
Programowy identyfikator setClientRequestIdPolicy.
setClientRequestIdPolicyName: "setClientRequestIdPolicy"
Typ
"setClientRequestIdPolicy"
systemErrorRetryPolicyName
Programowy identyfikator systemErrorRetryPolicy.
systemErrorRetryPolicyName: "systemErrorRetryPolicy"
Typ
"systemErrorRetryPolicy"
throttlingRetryPolicyName
Programowy identyfikator throttlingRetryPolicy.
throttlingRetryPolicyName: "throttlingRetryPolicy"
Typ
"throttlingRetryPolicy"
tracingPolicyName
Programowy identyfikator polityki śledzenia.
tracingPolicyName: "tracingPolicy"
Typ
"tracingPolicy"
userAgentPolicyName
Programowy identyfikator userAgentPolicy.
userAgentPolicyName: "userAgentPolicy"
Typ
"userAgentPolicy"