@azure/core-rest-pipeline package

Kelas

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

Antarmuka

AddPipelineOptions	Opsi saat menambahkan kebijakan ke alur. Digunakan untuk mengekspresikan dependensi pada kebijakan lain.
Agent	Antarmuka yang kompatibel dengan NodeJS http.Agent. Kami ingin menghindari mengekspor ulang antarmuka aktual secara publik, karena mungkin berbeda di seluruh versi runtime.
AuthorizeRequestOnChallengeOptions	Opsi yang dikirim ke callback authorizeRequestOnChallenge
AuthorizeRequestOptions	Opsi yang dikirim ke callback authorizeRequest
AuxiliaryAuthenticationHeaderPolicyOptions	Opsi untuk mengonfigurasi auxiliaryAuthenticationHeaderPolicy
BearerTokenAuthenticationPolicyOptions	Opsi untuk mengonfigurasi bearerTokenAuthenticationPolicy
ChallengeCallbacks	Opsi untuk mengambil alih pemrosesan tantangan Evaluasi Akses Berkelanjutan .
DefaultRetryPolicyOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
ExponentialRetryPolicyOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
HttpClient	Antarmuka yang diperlukan untuk klien yang membuat permintaan HTTP atas nama alur.
HttpHeaders	Mewakili sekumpulan header HTTP pada permintaan/respons. Nama header diperlakukan sebagai tidak peka huruf besar/kecil.
InternalPipelineOptions	Menentukan opsi yang digunakan untuk mengonfigurasi opsi internal alur HTTP untuk klien SDK.
KeyObject	Antarmuka yang kompatibel dengan NodeJS tls.KeyObject. Kami ingin menghindari mengekspor ulang antarmuka aktual secara publik, karena mungkin berbeda di seluruh versi runtime.
LogPolicyOptions	Opsi untuk mengonfigurasi logPolicy.
Pipeline	Mewakili alur untuk membuat permintaan HTTP 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 berjalan 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 Parsial, tetapi url bersifat wajib.
PipelineResponse	Metadata tentang respons yang diterima oleh alur.
PipelineRetryOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
ProxySettings	Opsi untuk mengonfigurasi proksi untuk permintaan keluar (hanya Node.js).
PxfObject	Antarmuka yang kompatibel dengan NodeJS tls.PxfObject. Kami ingin menghindari mengekspor ulang antarmuka aktual secara publik, karena mungkin berbeda di seluruh versi runtime.
RedirectPolicyOptions	Opsi tentang cara respons pengalihan ditangani.
RestErrorOptions	Opsi yang didukung oleh RestError.
RetryInformation	Informasi yang diberikan untuk strategi coba lagi tentang kemajuan kebijakan coba lagi saat ini.
RetryModifiers	Properti yang dapat mengubah perilaku kebijakan coba lagi.
RetryPolicyOptions	Opsi untuk retryPolicy
RetryStrategy	Strategi coba lagi dimaksudkan untuk menentukan apakah akan mencoba kembali atau tidak, dan cara mencoba kembali.
SystemErrorRetryPolicyOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
TelemetryOptions	Menentukan opsi yang digunakan untuk mengonfigurasi telemetri umum dan info pelacakan
ThrottlingRetryPolicyOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
TlsSettings	Mewakili sertifikat untuk autentikasi TLS.
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 Fase Tanda Tangan
RawHttpHeaders	Koleksi HttpHeaders direpresentasikan sebagai objek JSON sederhana.
RawHttpHeadersInput	Koleksi HttpHeaders untuk input, direpresentasikan sebagai objek JSON sederhana.
RequestBodyType	Jenis isi yang didukung pada permintaan. NodeJS.ReadableStream dan () => NodeJS.ReadableStream hanya node. Blob, ReadableStream, dan () => ReadableStream hanya browser.
SendRequest	Antarmuka sederhana untuk membuat permintaan alur dan menerima respons.
TransferProgressEvent	Diaktifkan sebagai respons terhadap kemajuan unggahan atau unduhan.

Fungsi

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)	Kebijakan untuk token eksternal ke x-ms-authorization-auxiliary header. Header ini akan digunakan saat membuat aplikasi lintas penyewa, kita mungkin perlu menangani permintaan autentikasi untuk sumber daya yang berada di penyewa yang berbeda. Anda dapat melihat dokumen ARM untuk rundown tentang cara kerja fitur ini
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)	Kebijakan yang dapat meminta token dari implementasi TokenCredential lalu menerapkannya ke header Otorisasi permintaan sebagai token Pembawa.
createDefaultHttpClient()	Buat HttpClient yang benar untuk lingkungan saat ini.
createEmptyPipeline()	Membuat alur yang benar-benar kosong. Berguna untuk menguji atau membuat yang kustom.
createHttpHeaders(RawHttpHeadersInput)	Membuat objek yang memenuhi HttpHeaders antarmuka.
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 header Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
defaultRetryPolicy(DefaultRetryPolicyOptions)	Kebijakan yang mencoba kembali sesuai dengan tiga strategi: Ketika server mengirim respons 429 dengan header Retry-After. Ketika ada kesalahan di lapisan transportasi yang mendasar (misalnya kegagalan pencarian DNS). Atau jika tidak, jika permintaan keluar gagal, permintaan akan mencoba kembali dengan penundaan yang meningkat secara eksponensial.
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 HTTPS_PROXY lingkungan atau HTTP_PROXY.
isRestError(unknown)	Typeguard untuk RestError
logPolicy(LogPolicyOptions)	Kebijakan yang mencatat semua permintaan dan respons.
ndJsonPolicy()	ndJsonPolicy adalah kebijakan yang digunakan untuk mengontrol pengaturan tetap aktif untuk setiap permintaan.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Kebijakan yang memungkinkan seseorang menerapkan pengaturan proksi ke semua permintaan. Jika tidak melewati pengaturan statis, pengaturan tersebut akan diambil dari variabel lingkungan HTTPS_PROXY atau HTTP_PROXY.
redirectPolicy(RedirectPolicyOptions)	Kebijakan untuk mengikuti Header lokasi dari server untuk mendukung pengalihan sisi server. Di browser, kebijakan ini tidak digunakan.
retryPolicy(RetryStrategy[], RetryPolicyOptions)	retryPolicy adalah kebijakan umum untuk mengaktifkan permintaan coba lagi ketika kondisi tertentu terpenuhi
setClientRequestIdPolicy(string)	Setiap PipelineRequest mendapatkan id unik saat dibuat. Kebijakan ini meneruskan id unik tersebut melalui header HTTP untuk mengaktifkan 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 mencoba kembali kode kesalahan dari server itu sendiri.
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)	Kebijakan yang mencoba kembali ketika server mengirim respons 429 dengan header Retry-After. Untuk mempelajari lebih lanjut, silakan merujuk ke 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
tlsPolicy(TlsSettings)	Mendapatkan kebijakan alur yang menambahkan sertifikat klien ke agen HttpClient untuk autentikasi.
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 menetapkan header User-Agent (atau setara) untuk mencerminkan versi pustaka.

Detail Fungsi

auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)

Kebijakan untuk token eksternal ke x-ms-authorization-auxiliary header. Header ini akan digunakan saat membuat aplikasi lintas penyewa, kita mungkin perlu menangani permintaan autentikasi untuk sumber daya yang berada di penyewa yang berbeda. Anda dapat melihat dokumen ARM untuk rundown tentang cara kerja fitur ini

function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy

Parameter

options

AuxiliaryAuthenticationHeaderPolicyOptions

Mengembalikan

PipelinePolicy

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

createDefaultHttpClient()

Buat HttpClient yang benar untuk lingkungan saat ini.

function createDefaultHttpClient(): HttpClient

Mengembalikan

HttpClient

createEmptyPipeline()

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

function createEmptyPipeline(): Pipeline

Mengembalikan

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Membuat objek yang memenuhi HttpHeaders antarmuka.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parameter

rawHeaders

RawHttpHeadersInput

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 header Accept-Encoding https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding

function decompressResponsePolicy(): PipelinePolicy

Mengembalikan

PipelinePolicy

defaultRetryPolicy(DefaultRetryPolicyOptions)

Kebijakan yang mencoba kembali sesuai dengan tiga strategi:

• Ketika server mengirim respons 429 dengan header Retry-After.
• Ketika ada kesalahan di lapisan transportasi yang mendasar (misalnya kegagalan pencarian DNS).
• Atau jika tidak, jika permintaan keluar gagal, permintaan akan mencoba kembali dengan penundaan yang meningkat secara eksponensial.

function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy

Parameter

options

DefaultRetryPolicyOptions

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 HTTPS_PROXY lingkungan atau HTTP_PROXY.

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

Parameter

proxyUrl

string

Url proksi yang akan digunakan. Mungkin berisi informasi autentikasi.

Mengembalikan

ProxySettings | undefined

isRestError(unknown)

Typeguard untuk RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Sesuatu tertangkap oleh klausul tangkapan.

Mengembalikan

e

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 aktif untuk setiap permintaan.

function ndJsonPolicy(): PipelinePolicy

Mengembalikan

PipelinePolicy

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

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

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

Parameter

proxySettings

ProxySettings

ProxySettings untuk digunakan pada setiap permintaan.

options

{ customNoProxyList?: string[] }

pengaturan tambahan, misalnya, pola NO_PROXY kustom

Mengembalikan

PipelinePolicy

redirectPolicy(RedirectPolicyOptions)

Kebijakan untuk mengikuti Header lokasi dari server untuk mendukung pengalihan sisi server. Di browser, kebijakan ini tidak digunakan.

function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy

Parameter

options

RedirectPolicyOptions

Opsi untuk mengontrol perilaku kebijakan.

Mengembalikan

PipelinePolicy

retryPolicy(RetryStrategy[], RetryPolicyOptions)

retryPolicy adalah kebijakan umum untuk mengaktifkan permintaan coba lagi ketika kondisi tertentu terpenuhi

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

Parameter

strategies

RetryStrategy[]

options

RetryPolicyOptions

Mengembalikan

PipelinePolicy

setClientRequestIdPolicy(string)

Setiap PipelineRequest mendapatkan id unik saat dibuat. Kebijakan ini meneruskan id unik tersebut melalui header HTTP untuk mengaktifkan 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 mencoba kembali kode kesalahan dari server itu sendiri.

function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy

Parameter

options

SystemErrorRetryPolicyOptions

Opsi yang menyesuaikan kebijakan.

Mengembalikan

PipelinePolicy

throttlingRetryPolicy(ThrottlingRetryPolicyOptions)

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

Untuk mempelajari lebih lanjut, silakan merujuk ke 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(options?: ThrottlingRetryPolicyOptions): PipelinePolicy

Parameter

options

ThrottlingRetryPolicyOptions

Opsi yang mengonfigurasi logika coba lagi.

Mengembalikan

PipelinePolicy

tlsPolicy(TlsSettings)

Mendapatkan kebijakan alur yang menambahkan sertifikat klien ke agen HttpClient untuk autentikasi.

function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy

Parameter

tlsSettings

TlsSettings

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 menetapkan 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