@azure/core-https package

Kelas

DefaultHttpsClient	Implementasi HttpsClient yang menggunakan modul "https" Node untuk mengirim permintaan HTTPS.
RestError	Jenis kesalahan kustom untuk permintaan alur yang gagal.

Antarmuka

AddPipelineOptions	Opsi saat menambahkan kebijakan ke alur. Digunakan untuk mengekspresikan dependensi pada kebijakan lain.
BearerTokenAuthenticationPolicyOptions	Opsi untuk mengonfigurasi bearerTokenAuthenticationPolicy
ExponentialRetryPolicyOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
HttpHeaders	Mewakili sekumpulan header HTTP pada permintaan/respons. Nama header diperlakukan sebagai tidak peka huruf besar/kecil.
HttpsClient	Antarmuka yang diperlukan untuk klien yang membuat permintaan HTTPS atas nama alur.
InternalPipelineOptions	Menentukan opsi yang digunakan untuk mengonfigurasi opsi internal alur HTTP untuk klien SDK.
LogPolicyOptions	Opsi untuk mengonfigurasi logPolicy.
Pipeline	Mewakili alur untuk membuat permintaan HTTPS ke URL. Alur dapat memiliki beberapa kebijakan untuk mengelola manipulasi setiap permintaan sebelum dan sesudah dibuat ke server.
PipelineOptions	Menentukan opsi yang digunakan untuk mengonfigurasi alur HTTP untuk klien SDK.
PipelinePolicy	Kebijakan alur memanipulasi permintaan saat melakukan perjalanan melalui alur. Ini secara konseptual adalah middleware yang diizinkan untuk memodifikasi permintaan sebelum dibuat serta respons ketika diterima.
PipelineRequest	Metadata tentang permintaan yang dibuat oleh alur.
PipelineRequestOptions	Pengaturan untuk menginisialisasi permintaan. Hampir setara dengan Partial<PipelineRequest>, tetapi url wajib.
PipelineResponse	Metadata tentang respons yang diterima oleh alur.
ProxySettings	Opsi untuk mengonfigurasi proksi untuk permintaan keluar (hanyaNode.js).
RedirectPolicyOptions	Opsi untuk bagaimana respons pengalihan ditangani.
RestErrorOptions	Opsi yang didukung oleh RestError.
SystemErrorRetryPolicyOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
TracingPolicyOptions	Opsi untuk mengonfigurasi kebijakan pelacakan.
UserAgentPolicyOptions	Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

Alias Jenis

FormDataMap	Objek sederhana yang menyediakan data formulir, seolah-olah dari formulir browser.
FormDataValue	Setiap entri data formulir dapat berupa string atau (di browser) Blob.
HttpMethods	Metode HTTP yang didukung untuk digunakan saat membuat permintaan.
PipelinePhase	Kebijakan dijalankan dalam fase. Urutan eksekusi adalah: Fase Serialisasi Kebijakan tidak dalam fase Fase Deserialisasi Fase Coba Lagi
RawHttpHeaders	Koleksi HttpHeaders direpresentasikan sebagai objek JSON sederhana.
RequestBodyType	Jenis isi yang didukung pada permintaan. NodeJS.ReadableStream hanya Node. Blob hanya browser.
SendRequest	Antarmuka sederhana untuk membuat permintaan alur dan menerima respons.
TransferProgressEvent	Diaktifkan sebagai respons terhadap kemajuan unggahan atau unduhan.

Fungsi

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Kebijakan yang dapat meminta token dari implementasi TokenCredential lalu menerapkannya ke header Otorisasi permintaan sebagai token Pembawa.
createEmptyPipeline()	Membuat alur yang benar-benar kosong. Berguna untuk menguji atau membuat yang kustom.
createHttpHeaders(RawHttpHeaders)	Membuat objek yang memenuhi antarmuka HttpHeaders.
createPipelineFromOptions(InternalPipelineOptions)	Buat alur baru dengan sekumpulan kebijakan default yang dapat disesuaikan.
createPipelineRequest(PipelineRequestOptions)	Membuat permintaan alur baru dengan opsi yang diberikan. Metode ini untuk memungkinkan pengaturan nilai default yang mudah dan tidak diperlukan.
decompressResponsePolicy()	Kebijakan untuk mengaktifkan dekompresi respons sesuai dengan https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding header Accept-Encoding
exponentialRetryPolicy(ExponentialRetryPolicyOptions)	Kebijakan yang mencoba mencoba kembali permintaan sambil memperkenalkan penundaan yang meningkat secara eksponensial.
formDataPolicy()	Kebijakan yang mengodekan FormData pada permintaan ke dalam isi.
getDefaultProxySettings(string)	Metode ini mengonversi url proksi menjadi ProxySettings untuk digunakan dengan ProxyPolicy. Jika tidak ada argumen yang diberikan, ia mencoba mengurai URL proksi dari variabel lingkungan HTTPS_PROXY atau HTTP_PROXY.
logPolicy(LogPolicyOptions)	Kebijakan yang mencatat semua permintaan dan respons.
ndJsonPolicy()	ndJsonPolicy adalah kebijakan yang digunakan untuk mengontrol pengaturan tetap hidup untuk setiap permintaan.
proxyPolicy(ProxySettings)	Kebijakan yang memungkinkan seseorang menerapkan pengaturan proksi ke semua permintaan. Jika tidak melewati pengaturan statis, pengaturan akan diambil dari variabel lingkungan HTTPS_PROXY atau HTTP_PROXY.
redirectPolicy(RedirectPolicyOptions)	Kebijakan untuk mengikuti Header lokasi dari server untuk mendukung pengalihan sisi server.
setClientRequestIdPolicy(string)	Setiap PipelineRequest mendapatkan id unik saat dibuat. Kebijakan ini meneruskan id unik tersebut melalui header HTTP untuk memungkinkan telemetri dan pelacakan yang lebih baik.
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)	Kebijakan coba lagi yang secara khusus berusaha menangani kesalahan di lapisan transportasi yang mendasar (misalnya kegagalan pencarian DNS) daripada kode kesalahan yang dapat diulang dari server itu sendiri.
throttlingRetryPolicy()	Kebijakan yang mencoba kembali saat server mengirim respons 429 dengan header Retry-After. Untuk mempelajari lebih lanjut, lihat 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, dan https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Kebijakan sederhana untuk membuat Rentang OpenTelemetry untuk setiap permintaan yang dibuat oleh alur yang memiliki SpanOptions dengan induk. Permintaan yang dibuat tanpa rentang induk tidak akan direkam.
userAgentPolicy(UserAgentPolicyOptions)	Kebijakan yang mengatur header User-Agent (atau setara) untuk mencerminkan versi pustaka.

Variabel

bearerTokenAuthenticationPolicyName	Pengidentifikasi terprogram dari bearerTokenAuthenticationPolicy.
decompressResponsePolicyName	Pengidentifikasi terprogram decompressResponsePolicy.
expontentialRetryPolicyName	Pengidentifikasi terprogram dari RetryPolicy eksponensial.
formDataPolicyName	Pengidentifikasi terprogram formDataPolicy.
logPolicyName	Pengidentifikasi terprogram logPolicy.
ndJsonPolicyName	Pengidentifikasi terprogram ndJsonPolicy.
proxyPolicyName	Pengidentifikasi terprogram proxyPolicy.
redirectPolicyName	Pengidentifikasi terprogram dari redirectPolicy.
setClientRequestIdPolicyName	Pengidentifikasi terprogram setClientRequestIdPolicy.
systemErrorRetryPolicyName	Pengidentifikasi terprogram systemErrorRetryPolicy.
throttlingRetryPolicyName	Pengidentifikasi terprogram throttlingRetryPolicy.
tracingPolicyName	Pengidentifikasi terprogram dari TracingPolicy.
userAgentPolicyName	Pengidentifikasi terprogram userAgentPolicy.

Detail Fungsi

bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)

Kebijakan yang dapat meminta token dari implementasi TokenCredential lalu menerapkannya ke header Otorisasi permintaan sebagai token Pembawa.

function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy

Parameter

options

BearerTokenAuthenticationPolicyOptions

Mengembalikan

PipelinePolicy

createEmptyPipeline()

Membuat alur yang benar-benar kosong. Berguna untuk menguji atau membuat yang kustom.

function createEmptyPipeline(): Pipeline

Mengembalikan

Pipeline

createHttpHeaders(RawHttpHeaders)

Membuat objek yang memenuhi antarmuka HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeaders): HttpHeaders

Parameter

rawHeaders

RawHttpHeaders

Objek sederhana yang mewakili header awal

Mengembalikan

HttpHeaders

createPipelineFromOptions(InternalPipelineOptions)

Buat alur baru dengan sekumpulan kebijakan default yang dapat disesuaikan.

function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline

Parameter

options

InternalPipelineOptions

Opsi untuk mengonfigurasi alur kustom.

Mengembalikan

Pipeline

createPipelineRequest(PipelineRequestOptions)

Membuat permintaan alur baru dengan opsi yang diberikan. Metode ini untuk memungkinkan pengaturan nilai default yang mudah dan tidak diperlukan.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parameter

options

PipelineRequestOptions

Opsi untuk membuat permintaan.

Mengembalikan

PipelineRequest

decompressResponsePolicy()

Kebijakan untuk mengaktifkan dekompresi respons sesuai dengan https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding header Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Mengembalikan

PipelinePolicy

exponentialRetryPolicy(ExponentialRetryPolicyOptions)

Kebijakan yang mencoba mencoba kembali permintaan sambil memperkenalkan penundaan yang meningkat secara eksponensial.

function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy

Parameter

options

ExponentialRetryPolicyOptions

Opsi yang mengonfigurasi logika coba lagi.

Mengembalikan

PipelinePolicy

formDataPolicy()

Kebijakan yang mengodekan FormData pada permintaan ke dalam isi.

function formDataPolicy(): PipelinePolicy

Mengembalikan

PipelinePolicy

getDefaultProxySettings(string)

Metode ini mengonversi url proksi menjadi ProxySettings untuk digunakan dengan ProxyPolicy. Jika tidak ada argumen yang diberikan, ia mencoba mengurai URL proksi dari variabel lingkungan HTTPS_PROXY atau HTTP_PROXY.

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

Parameter

proxyUrl

string

Url proksi yang akan digunakan. Mungkin berisi informasi autentikasi.

Mengembalikan

ProxySettings | undefined

logPolicy(LogPolicyOptions)

Kebijakan yang mencatat semua permintaan dan respons.

function logPolicy(options?: LogPolicyOptions): PipelinePolicy

Parameter

options

LogPolicyOptions

Opsi untuk mengonfigurasi logPolicy.

Mengembalikan

PipelinePolicy

ndJsonPolicy()

ndJsonPolicy adalah kebijakan yang digunakan untuk mengontrol pengaturan tetap hidup untuk setiap permintaan.

function ndJsonPolicy(): PipelinePolicy

Mengembalikan

PipelinePolicy

proxyPolicy(ProxySettings)

Kebijakan yang memungkinkan seseorang menerapkan pengaturan proksi ke semua permintaan. Jika tidak melewati pengaturan statis, pengaturan akan diambil dari variabel lingkungan HTTPS_PROXY atau HTTP_PROXY.

function proxyPolicy(proxySettings?: ProxySettings): PipelinePolicy

Parameter

proxySettings

ProxySettings

ProxySettings untuk digunakan pada setiap permintaan.

Mengembalikan

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Kebijakan untuk mengikuti Header lokasi dari server untuk mendukung pengalihan sisi server.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parameter

options

RedirectPolicyOptions

Opsi untuk mengontrol perilaku kebijakan.

Mengembalikan

PipelinePolicy

setClientRequestIdPolicy(string)

Setiap PipelineRequest mendapatkan id unik saat dibuat. Kebijakan ini meneruskan id unik tersebut melalui header HTTP untuk memungkinkan telemetri dan pelacakan yang lebih baik.

function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy

Parameter

requestIdHeaderName

string

Nama header untuk meneruskan ID permintaan.

Mengembalikan

PipelinePolicy

systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)

Kebijakan coba lagi yang secara khusus berusaha menangani kesalahan di lapisan transportasi yang mendasar (misalnya kegagalan pencarian DNS) daripada kode kesalahan yang dapat diulang dari server itu sendiri.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parameter

options

SystemErrorRetryPolicyOptions

Opsi yang menyesuaikan kebijakan.

Mengembalikan

PipelinePolicy

throttlingRetryPolicy()

Kebijakan yang mencoba kembali saat server mengirim respons 429 dengan header Retry-After.

Untuk mempelajari lebih lanjut, lihat 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, dan https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): PipelinePolicy

Mengembalikan

PipelinePolicy

tracingPolicy(TracingPolicyOptions)

Kebijakan sederhana untuk membuat Rentang OpenTelemetry untuk setiap permintaan yang dibuat oleh alur yang memiliki SpanOptions dengan induk. Permintaan yang dibuat tanpa rentang induk tidak akan direkam.

function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy

Parameter

options

TracingPolicyOptions

Opsi untuk mengonfigurasi telemetri yang dicatat oleh kebijakan pelacakan.

Mengembalikan

PipelinePolicy

userAgentPolicy(UserAgentPolicyOptions)

Kebijakan yang mengatur header User-Agent (atau setara) untuk mencerminkan versi pustaka.

function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy

Parameter

options

UserAgentPolicyOptions

Opsi untuk menyesuaikan nilai agen pengguna.

Mengembalikan

PipelinePolicy

Variable Details

bearerTokenAuthenticationPolicyName

Pengidentifikasi terprogram dari bearerTokenAuthenticationPolicy.

bearerTokenAuthenticationPolicyName: "bearerTokenAuthenticationPolicy"

Jenis

"bearerTokenAuthenticationPolicy"

decompressResponsePolicyName

Pengidentifikasi terprogram decompressResponsePolicy.

decompressResponsePolicyName: "decompressResponsePolicy"

Jenis

"decompressResponsePolicy"

expontentialRetryPolicyName

Pengidentifikasi terprogram dari RetryPolicy eksponensial.

expontentialRetryPolicyName: "exponentialRetryPolicy"

Jenis

"exponentialRetryPolicy"

formDataPolicyName

Pengidentifikasi terprogram formDataPolicy.

formDataPolicyName: "formDataPolicy"

Jenis

"formDataPolicy"

logPolicyName

Pengidentifikasi terprogram logPolicy.

logPolicyName: "logPolicy"

Jenis

"logPolicy"

ndJsonPolicyName

Pengidentifikasi terprogram ndJsonPolicy.

ndJsonPolicyName: "ndJsonPolicy"

Jenis

"ndJsonPolicy"

proxyPolicyName

Pengidentifikasi terprogram proxyPolicy.

proxyPolicyName: "proxyPolicy"

Jenis

"proxyPolicy"

redirectPolicyName

Pengidentifikasi terprogram dari redirectPolicy.

redirectPolicyName: "redirectPolicy"

Jenis

"redirectPolicy"

setClientRequestIdPolicyName

Pengidentifikasi terprogram setClientRequestIdPolicy.

setClientRequestIdPolicyName: "setClientRequestIdPolicy"

Jenis

"setClientRequestIdPolicy"

systemErrorRetryPolicyName

Pengidentifikasi terprogram systemErrorRetryPolicy.

systemErrorRetryPolicyName: "systemErrorRetryPolicy"

Jenis

"systemErrorRetryPolicy"

throttlingRetryPolicyName

Pengidentifikasi terprogram throttlingRetryPolicy.

throttlingRetryPolicyName: "throttlingRetryPolicy"

Jenis

"throttlingRetryPolicy"

tracingPolicyName

Pengidentifikasi terprogram dari TracingPolicy.

tracingPolicyName: "tracingPolicy"

Jenis

"tracingPolicy"

userAgentPolicyName

Pengidentifikasi terprogram userAgentPolicy.

userAgentPolicyName: "userAgentPolicy"

Jenis

"userAgentPolicy"