@azure/core-http package

Referensi

Kelas

AccessTokenRefresher	Membantu kebijakan autentikasi token core-http dengan meminta token baru jika saat ini kami tidak menunggu token baru.
ApiKeyCredentials	Mengautentikasi ke layanan menggunakan kunci API.
BaseRequestPolicy	Kelas dasar dari mana semua kebijakan permintaan berasal.
BasicAuthenticationCredentials	Sederhana <xref:ServiceClientCredential> yang mengautentikasi dengan nama pengguna dan kata sandi.
DefaultHttpClient	Klien HTTP yang menggunakan `node-fetch`.
ExpiringAccessTokenCache	Menyediakan implementasi AccessTokenCache yang menghapus cache AccessToken setelah expiresOnTimestamp berlalu.
HttpHeaders	Kumpulan pasangan kunci/nilai header HTTP.
RequestPolicyOptions	Properti opsional yang dapat digunakan saat membuat RequestPolicy.
RestError	Kesalahan yang dihasilkan dari permintaan HTTP ke titik akhir layanan.
Serializer	Digunakan untuk memetakan objek respons mentah ke bentuk akhir. Membantu pengemasan dan pembukaan Tanggal dan jenis berkode lainnya yang tidak intrinsik dengan JSON. Juga memungkinkan menarik nilai dari header, serta menyisipkan nilai dan konstanta default.
ServiceClient	ServiceClient mengirim permintaan layanan dan menerima respons.
TopicCredentials	Objek TopicCredentials yang digunakan untuk Azure Event Grid.
URLBuilder	Kelas yang menangani pembuatan, modifikasi, dan penguraian URL.
URLQuery	Kelas yang menangani bagian kueri dari URLBuilder.
WebResource	Membuat objek WebResource baru. Kelas ini menyediakan abstraksi atas panggilan REST dengan menjadi pustaka/implementasi agnostik dan membungkus properti yang diperlukan untuk memulai permintaan.

Antarmuka

AbortSignalLike	Memungkinkan permintaan dibatalkan setelah pengaktifan peristiwa "batalkan". Kompatibel dengan AbortSignal bawaan browser dan polifill umum.
AccessToken	Mewakili token akses dengan waktu kedaluwarsa.
AccessTokenCache	Menyediakan cache untuk AccessToken yang dikembalikan dari TokenCredential.
ApiKeyCredentialOptions	Menjelaskan opsi yang akan disediakan saat membuat instans ApiKeyCredentials
BaseMapper	Definisi dasar pemeta. Dapat digunakan untuk XML dan objek JavaScript biasa.
CompositeMapper	Pemeta yang terdiri dari pemeta lain.
CompositeMapperType	Membantu membangun pemeta yang menjelaskan cara memetakan sekumpulan properti objek berdasarkan pemeta lain. Hanya salah satu properti berikut yang harus ada: `className`, `modelProperties` dan `additionalProperties`.
DeserializationContentTypes	Jenis konten yang akan menunjukkan bahwa respons operasi harus dideserialisasi dengan cara tertentu.
DeserializationOptions	Opsi untuk mengonfigurasi deserialisasi respons API.
DictionaryMapper	Pemeta yang menjelaskan objek JavaScript biasa yang digunakan sebagai pasangan kunci/nilai.
DictionaryMapperType	Membantu membangun pemeta yang menjelaskan cara mengurai kamus nilai yang dipetakan.
EnumMapper	Pemeta yang menjelaskan nilai enum.
EnumMapperType	Membantu membangun pemeta yang menjelaskan cara mengurai nilai enum.
GetTokenOptions	Menentukan opsi untuk TokenCredential.getToken.
HttpClient	Antarmuka yang dapat mengirim HttpRequests dan menerima HttpResponses yang dijanjikan.
HttpHeader	Header individual dalam koleksi HttpHeaders.
HttpHeadersLike	Kumpulan pasangan kunci/nilai header HTTP.
HttpOperationResponse	Objek pembungkus untuk permintaan dan respons http. Objek yang dideserialisasi disimpan di `parsedBody` properti saat isi respons diterima di JSON atau XML.
HttpPipelineLogger	Pencatat yang dapat ditambahkan ke HttpPipeline. Ini memungkinkan setiap RequestPolicy untuk mencatat pesan yang dapat digunakan untuk tujuan penelusuran kesalahan.
HttpResponse	Properti pada respons HTTP yang akan selalu ada.
InternalPipelineOptions	Menentukan opsi yang digunakan untuk mengonfigurasi opsi internal alur HTTP untuk klien SDK.
KeepAliveOptions	Opsi tentang bagaimana koneksi HTTP harus dipertahankan untuk permintaan di masa mendatang.
LogPolicyOptions	Opsi untuk meneruskan ke logPolicy. Secara default hanya daftar set header yang dicatat, meskipun ini dapat dikonfigurasi. Badan permintaan dan respons tidak pernah dicatat.
MapperConstraints	Deskripsi berbagai batasan nilai seperti rentang bilangan bulat dan regex string.
OperationArguments	Kumpulan properti yang berlaku untuk satu pemanggilan operasi.
OperationOptions	Jenis opsi dasar untuk semua operasi.
OperationParameter	Antarmuka umum yang diperluas semua parameter Operasi.
OperationQueryParameter	Parameter untuk operasi yang akan ditambahkan sebagai parameter kueri ke permintaan HTTP operasi.
OperationRequestOptions	Opsi yang memungkinkan konfigurasi penanganan permintaan HTTP yang dibuat oleh operasi SDK.
OperationResponse	OperationResponse yang dapat dikembalikan dari permintaan operasi untuk satu kode status.
OperationSpec	Spesifikasi yang menentukan cara melakukan operasi layanan tertentu melalui HTTP, termasuk cara membuat serialisasi informasi permintaan dengan benar ke dalam dan mendeserialisasi informasi respons ke dalam payload objek yang dapat dikembalikan oleh ServiceClient.
OperationURLParameter	Parameter untuk operasi yang akan diganti menjadi URL permintaan operasi.
ParameterValue	Nilai Parameter yang disediakan untuk parameter jalur atau kueri di RequestPrepareOptions
PipelineOptions	Menentukan opsi yang digunakan untuk mengonfigurasi alur HTTP untuk klien SDK.
PolymorphicDiscriminator	Digunakan untuk membedakan penyatuan jenis diskriminasi. Misalnya, jika respons dapat memiliki banyak bentuk tetapi juga menyertakan bidang 'jenis' (atau serupa), bidang tersebut dapat digunakan untuk menentukan cara mendeserialisasi respons ke jenis yang benar.
ProxySettings	Opsi untuk mengonfigurasi proksi untuk permintaan keluar (hanya Node.js).
RedirectOptions	Opsi tentang cara respons pengalihan ditangani.
RequestOptionsBase	Menjelaskan struktur dasar objek opsi yang akan digunakan dalam setiap operasi.
RequestPolicy	Struktur yang mendasar dari kebijakan permintaan.
RequestPolicyOptionsLike	Properti opsional yang dapat digunakan saat membuat RequestPolicy.
RequestPrepareOptions	Opsi untuk menyiapkan permintaan HTTP keluar.
RestResponse	Respons yang diratakan terhadap panggilan REST. Berisi HttpOperationResponse yang mendasar serta properti gabungan dari `parsedBody`, `parsedHeaders`, dll.
RetryOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
SequenceMapper	Pemeta yang menjelaskan array.
SequenceMapperType	Membantu membangun pemeta yang menjelaskan cara mengurai urutan nilai yang dipetakan.
SerializerOptions	Opsi untuk mengatur perilaku pengurai dan penyusun xml.
ServiceCallback
ServiceClientCredentials	Mewakili objek atau kelas dengan `signRequest` metode yang akan menandatangani permintaan keluar (misalnya, dengan mengatur `Authorization` header ).
ServiceClientOptions	Opsi yang akan disediakan saat membuat klien.
SimpleMapperType	Jenis pemeta sederhana.
TokenCredential	Mewakili kredensial yang mampu menyediakan token autentikasi.
TracingPolicyOptions	Opsi untuk menyesuaikan kebijakan pelacakan.
UrlParameterValue	Antarmuka yang mewakili nilai parameter URL.
UserAgentOptions	Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.
WebResourceLike	Deskripsi permintaan HTTP yang akan dibuat ke server jarak jauh.

Alias Jenis

Authenticator	Fungsi yang menerima tantangan dan menyelesaikan janji dengan token string.
CommonRequestInfo	URL string yang digunakan saat memanggil ke `fetch()`.
CommonRequestInit	Objek yang berisi informasi tentang permintaan HTTP keluar.
CommonResponse	Objek yang berisi informasi tentang respons HTTP masuk.
HttpMethods	Daftar metode HTTP yang didukung.
HttpRequestBody	Kemungkinan jenis isi permintaan HTTP
Mapper	Pemeta adalah definisi model data yang digunakan dalam pustaka. Model data ini adalah bagian dari definisi Operasi atau Klien dalam respons atau parameter.
MapperType	Jenis pemeta. Termasuk pemeta yang diketahui.
ParameterPath	Jalur yang menjelaskan cara mengakses properti tertentu di sumber data objek tertentu. Mungkin satu nama properti, array yang menunjukkan nama properti berlapis, atau sekumpulan beberapa properti bernama dengan jalur dalam kasus nilai objek kompleks.
ProxyOptions	Alias ProxySettings untuk digunakan di masa mendatang.
RawHttpHeaders	Koleksi HttpHeaders direpresentasikan sebagai objek JSON sederhana.
RequestPolicyFactory	Membuat RequestPolicy baru per permintaan yang menggunakan nextPolicy yang disediakan.
TelemetryInfo	Informasi telemetri. Pasangan kunci/nilai untuk disertakan di dalam string User-Agent.
TransferProgressEvent	Diaktifkan sebagai respons terhadap kemajuan unggahan atau pengunduhan.

Enum

HttpPipelineLogLevel	Berbagai tingkat log yang dapat digunakan dengan HttpPipelineLogger.
QueryCollectionFormat	Format yang akan digunakan untuk menggabungkan array nilai bersama-sama untuk nilai parameter kueri.
RetryMode	Menjelaskan jenis Mode Coba Lagi. Saat ini hanya mendukung Eksponensial.

Fungsi

applyMixins(unknown, any[])	Menerapkan properti pada prototipe sourceCtors ke prototipe targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	Membuat pabrik baru untuk RequestPolicy yang menerapkan token pembawa ke header permintaan `Authorization` .
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Membuat alur HTTP berdasarkan opsi yang diberikan.
delay(number, DelayOptions)	Pembungkus untuk setTimeout yang menyelesaikan janji setelah timeInMs milidetik.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Buat serialisasi baru RequestPolicyCreator yang akan menserialisasikan isi permintaan HTTP saat melewati alur HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Mengingat sekumpulan jenis konten tertentu untuk diurai sebagai JSON atau XML, menggunakan respons HTTP untuk menghasilkan objek hasil yang ditentukan oleh OperationSpec permintaan.
disableResponseDecompressionPolicy()	Mengembalikan pabrik kebijakan permintaan yang dapat digunakan untuk membuat instans <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Mengodekan URI.
executePromisesSequentially(any[], unknown)	Menjalankan array janji secara berurutan. Inspirasi metode ini ada di sini: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Sebuah blog yang luar biasa tentang janji!
exponentialRetryPolicy(number, number, number)	Kebijakan yang mencoba kembali permintaan sebanyak yang dikonfigurasi selama interval waktu coba lagi maksimum yang ditentukan, setiap coba lagi menunggu lebih lama untuk dimulai dari terakhir kali.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Mengurai HttpOperationResponse ke dalam objek respons HTTP yang dinormalisasi (RestResponse).
generateClientRequestIdPolicy(string)	Membuat kebijakan yang menetapkan id permintaan unik ke permintaan keluar.
generateUuid()	UUID yang dihasilkan
getDefaultProxySettings(string)	Mengonversi URL tertentu dari server proksi ke dalam `ProxySettings` atau mencoba mengambil `ProxySettings` dari lingkungan saat ini jika tidak diteruskan.
getDefaultUserAgentValue()	Pendekatan default untuk menghasilkan agen pengguna. Menggunakan informasi statis dari paket ini, ditambah informasi sistem yang tersedia dari runtime.
isDuration(string)	Menunjukkan apakah string yang diberikan dalam format ISO 8601.
isTokenCredential(unknown)	Menguji objek untuk menentukan apakah objek menerapkan TokenCredential.
isValidUuid(string)	Memvalidasi uuid yang diberikan sebagai string
keepAlivePolicy(KeepAliveOptions)	Membuat kebijakan yang mengontrol apakah koneksi HTTP dipertahankan pada permintaan di masa mendatang.
logPolicy(LogPolicyOptions)	Membuat kebijakan yang mencatat informasi tentang permintaan keluar dan respons masuk.
operationOptionsToRequestOptionsBase<T>(T)	Mengonversi OperationOptions menjadi RequestOptionsBase
parseXML(string, SerializerOptions)	Mengonversi string XML yang diberikan menjadi JSON
promiseToCallback(Promise<any>)	Mengonversi Promise menjadi panggilan balik.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Mengonversi panggilan balik Promise ke layanan.
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(number)	Membuat kebijakan pengalihan, yang mengirim permintaan berulang ke tujuan baru jika respons tiba dengan header "lokasi", dan kode status antara 300 dan 307.
serializeObject(unknown)	Fungsi utilitas yang menserialisasikan objek yang mungkin berisi informasi biner ke dalam objek biasa, array, atau string.
signingPolicy(ServiceClientCredentials)	Membuat kebijakan yang menandatangani permintaan keluar dengan memanggil metode yang disediakan`authenticationProvidersignRequest`.
stringifyXML(unknown, SerializerOptions)	Mengonversi objek JSON yang diberikan ke string XML
stripRequest(WebResourceLike)	Mengembalikan versi permintaan Http yang dilucuti yang tidak berisi header Otorisasi.
stripResponse(HttpOperationResponse)	Mengembalikan versi respons Http yang dilucuti yang hanya berisi isi, header, dan status.
systemErrorRetryPolicy(number, number, number, number)	Kebijakan yang mencoba kembali ketika ada kesalahan sistem, yang diidentifikasi oleh kode "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" atau "ENOENT".
throttlingRetryPolicy()	Membuat kebijakan yang mengirim ulang permintaan jika respons menunjukkan permintaan gagal karena alasan pembatasan. Misalnya, jika respons berisi `Retry-After` header, respons akan mencoba kembali mengirim permintaan berdasarkan nilai header tersebut. 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
tracingPolicy(TracingPolicyOptions)	Membuat kebijakan yang membungkus permintaan keluar dengan rentang pelacakan.
userAgentPolicy(TelemetryInfo)	Mengembalikan kebijakan yang menambahkan header agen pengguna ke permintaan keluar berdasarkan TelemetryInfo yang diberikan.

Detail Fungsi

applyMixins(unknown, any[])

Menerapkan properti pada prototipe sourceCtors ke prototipe targetCtor

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Parameter

targetCtorParam: unknown

sourceCtors: any[]

Array objek sumber dari mana properti perlu diambil.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Membuat pabrik baru untuk RequestPolicy yang menerapkan token pembawa ke header permintaan Authorization .

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Parameter

credential: TokenCredential

Implementasi TokenCredential yang dapat menyediakan token pembawa.

scopes: string | string[]

Cakupan tempat token pembawa berlaku.

Mengembalikan

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Membuat alur HTTP berdasarkan opsi yang diberikan.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Parameter

pipelineOptions: InternalPipelineOptions

Menentukan opsi yang digunakan untuk mengonfigurasi kebijakan dalam alur HTTP untuk klien SDK.

authPolicyFactory: RequestPolicyFactory

Pabrik kebijakan autentikasi opsional yang digunakan untuk menandatangani permintaan.

Mengembalikan

ServiceClientOptions

Sekumpulan opsi yang dapat diteruskan untuk membuat ServiceClient baru.

delay(number, DelayOptions)

Pembungkus untuk setTimeout yang menyelesaikan janji setelah timeInMs milidetik.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Parameter

timeInMs: number

Jumlah milidetik yang akan ditunda.

options: DelayOptions

Opsi untuk penundaan - opsi yang saat ini dibatalkan

Mengembalikan

Promise<void>

Janji yang diselesaikan setelah timeInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Buat serialisasi baru RequestPolicyCreator yang akan menserialisasikan isi permintaan HTTP saat melewati alur HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parameter

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Mengembalikan

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Mengingat sekumpulan jenis konten tertentu untuk diurai sebagai JSON atau XML, menggunakan respons HTTP untuk menghasilkan objek hasil yang ditentukan oleh OperationSpec permintaan.

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

Parameter

jsonContentTypes: string[]

Jenis konten respons untuk mengurai isi sebagai JSON.

xmlContentTypes: string[]

Jenis konten respons untuk mengurai isi sebagai XML.

response: HttpOperationResponse

Respons HTTP dari alur.

options: SerializerOptions

Opsi untuk serializer, sebagian besar untuk mengonfigurasi pengurai XML jika diperlukan.

Mengembalikan

Promise<HttpOperationResponse>

Objek HttpOperationResponse yang diurai yang dapat dikembalikan oleh ServiceClient.

disableResponseDecompressionPolicy()

Mengembalikan pabrik kebijakan permintaan yang dapat digunakan untuk membuat instans <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Mengembalikan

RequestPolicyFactory

encodeUri(string)

Mengodekan URI.

function encodeUri(uri: string): string

Parameter

uri: string

URI yang akan dikodekan.

Mengembalikan

string

URI yang dikodekan.

executePromisesSequentially(any[], unknown)

Menjalankan array janji secara berurutan. Inspirasi metode ini ada di sini: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Sebuah blog yang luar biasa tentang janji!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

Parameter

promiseFactories: any[]

Array pabrik janji (Fungsi yang mengembalikan janji)

kickstart: unknown

Masukan ke janji pertama yang digunakan untuk memulai rantai janji. Jika tidak disediakan maka rantai janji dimulai dengan tidak terdefinisi.

Mengembalikan

Promise<any>

Rantai janji yang diselesaikan atau ditolak

exponentialRetryPolicy(number, number, number)

Kebijakan yang mencoba kembali permintaan sebanyak yang dikonfigurasi selama interval waktu coba lagi maksimum yang ditentukan, setiap coba lagi menunggu lebih lama untuk dimulai dari terakhir kali.

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Parameter

retryCount: number

Jumlah maksimum percobaan ulang.

retryInterval: number

Waktu dasar antara percobaan ulang.

maxRetryInterval: number

Waktu maksimum untuk menunggu di antara percobaan ulang.

Mengembalikan

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Mengurai HttpOperationResponse ke dalam objek respons HTTP yang dinormalisasi (RestResponse).

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

Parameter

_response: HttpOperationResponse

Objek pembungkus untuk respons http.

responseSpec: undefined | OperationResponse

Pemeta tentang cara mengurai properti respons.

Mengembalikan

RestResponse

Objek respons yang dinormalisasi.

generateClientRequestIdPolicy(string)

Membuat kebijakan yang menetapkan id permintaan unik ke permintaan keluar.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parameter

requestIdHeaderName: string

Nama header yang akan digunakan saat menetapkan id unik ke permintaan.

Mengembalikan

RequestPolicyFactory

generateUuid()

UUID yang dihasilkan

function generateUuid(): string

Mengembalikan

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

Mengonversi URL tertentu dari server proksi ke dalam ProxySettings atau mencoba mengambil ProxySettings dari lingkungan saat ini jika tidak diteruskan.

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

Parameter

proxyUrl: string

URL proksi

Mengembalikan

ProxySettings | undefined

Pengaturan proksi default, atau tidak terdefinis.

getDefaultUserAgentValue()

Pendekatan default untuk menghasilkan agen pengguna. Menggunakan informasi statis dari paket ini, ditambah informasi sistem yang tersedia dari runtime.

function getDefaultUserAgentValue(): string

Mengembalikan

string

isDuration(string)

Menunjukkan apakah string yang diberikan dalam format ISO 8601.

function isDuration(value: string): boolean

Parameter

value: string

Nilai yang akan divalidasi untuk format durasi ISO 8601.

Mengembalikan

boolean

true jika valid, false jika tidak.

isTokenCredential(unknown)

Menguji objek untuk menentukan apakah objek menerapkan TokenCredential.

function isTokenCredential(credential: unknown): credential

Parameter

credential: unknown

TokenCredential yang diasumsikan akan diuji.

Mengembalikan

credential

isValidUuid(string)

Memvalidasi uuid yang diberikan sebagai string

function isValidUuid(uuid: string): boolean

Parameter

uuid: string

Uuid sebagai string yang perlu divalidasi

Mengembalikan

boolean

Benar jika uuid valid; false jika tidak.

keepAlivePolicy(KeepAliveOptions)

Membuat kebijakan yang mengontrol apakah koneksi HTTP dipertahankan pada permintaan di masa mendatang.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Parameter

keepAliveOptions: KeepAliveOptions

Tetap hidup pilihan. Secara default, koneksi HTTP dipertahankan untuk permintaan di masa mendatang.

Mengembalikan

RequestPolicyFactory

Instans dari <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Membuat kebijakan yang mencatat informasi tentang permintaan keluar dan respons masuk.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Parameter

loggingOptions: LogPolicyOptions

Opsi pengelogan.

Mengembalikan

RequestPolicyFactory

Instans dari <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Mengonversi OperationOptions menjadi RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Parameter

opts: T

Objek OperationOptions untuk dikonversi ke RequestOptionsBase

Mengembalikan

RequestOptionsBase

parseXML(string, SerializerOptions)

Mengonversi string XML yang diberikan menjadi JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Parameter

str: string

String yang berisi konten XML yang akan diurai ke dalam JSON

opts: SerializerOptions

Opsi yang mengatur penguraian string xml yang diberikan

Mengembalikan

Promise<any>

promiseToCallback(Promise<any>)

Peringatan

API ini sudah tidak digunakan lagi.

generated code should instead depend on responseToBody

Mengonversi Promise menjadi panggilan balik.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

Parameter

promise: Promise<any>

Janji untuk dikonversi menjadi panggilan balik

Mengembalikan

(cb: Function) => void

Fungsi yang mengambil panggilan balik (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Mengonversi panggilan balik Promise ke layanan.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

Parameter

promise: Promise<HttpOperationResponse>

Promise of HttpOperationResponse untuk dikonversi ke panggilan balik layanan

Mengembalikan

(cb: ServiceCallback<T>) => void

Fungsi yang mengambil panggilan balik layanan (cb: ServiceCallback): batal

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[] }): RequestPolicyFactory

Parameter

proxySettings: ProxySettings

ProxySettings untuk digunakan pada setiap permintaan.

options: { customNoProxyList?: string[] }

pengaturan tambahan, misalnya, pola NO_PROXY kustom

Mengembalikan

RequestPolicyFactory

redirectPolicy(number)

Membuat kebijakan pengalihan, yang mengirim permintaan berulang ke tujuan baru jika respons tiba dengan header "lokasi", dan kode status antara 300 dan 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameter

maximumRetries: number

Jumlah maksimum pengalihan yang harus diikuti.

Mengembalikan

RequestPolicyFactory

Instans dari <xref:RedirectPolicy>

serializeObject(unknown)

Fungsi utilitas yang menserialisasikan objek yang mungkin berisi informasi biner ke dalam objek biasa, array, atau string.

function serializeObject(toSerialize: unknown): any

Parameter

toSerialize: unknown

Mengembalikan

any

signingPolicy(ServiceClientCredentials)

Membuat kebijakan yang menandatangani permintaan keluar dengan memanggil metode yang disediakanauthenticationProvidersignRequest.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameter

authenticationProvider: ServiceClientCredentials

Penyedia autentikasi.

Mengembalikan

RequestPolicyFactory

Instans dari <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Mengonversi objek JSON yang diberikan ke string XML

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Parameter

obj: unknown

Objek JSON yang akan dikonversi menjadi string XML

opts: SerializerOptions

Opsi yang mengatur penguraian objek JSON yang diberikan

Mengembalikan

string

stripRequest(WebResourceLike)

Mengembalikan versi permintaan Http yang dilucuti yang tidak berisi header Otorisasi.

function stripRequest(request: WebResourceLike): WebResourceLike

Parameter

request: WebResourceLike

Objek Permintaan Http

Mengembalikan

WebResourceLike

Versi Permintaan Http yang dilucuti.

stripResponse(HttpOperationResponse)

Mengembalikan versi respons Http yang dilucuti yang hanya berisi isi, header, dan status.

function stripResponse(response: HttpOperationResponse): any

Parameter

response: HttpOperationResponse

Respons Http

Mengembalikan

any

Versi Respons Http yang dilucuti.

systemErrorRetryPolicy(number, number, number, number)

Kebijakan yang mencoba kembali ketika ada kesalahan sistem, yang diidentifikasi oleh kode "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" atau "ENOENT".

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Parameter

retryCount: number

Jumlah maksimum percobaan ulang.

retryInterval: number

Interval coba lagi klien, dalam milidetik.

minRetryInterval: number

Interval coba lagi minimum, dalam milidetik.

maxRetryInterval: number

Interval coba lagi maksimum, dalam milidetik.

Mengembalikan

RequestPolicyFactory

Instans dari <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Membuat kebijakan yang mengirim ulang permintaan jika respons menunjukkan permintaan gagal karena alasan pembatasan. Misalnya, jika respons berisi Retry-After header, respons akan mencoba kembali mengirim permintaan berdasarkan nilai header tersebut.

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(): RequestPolicyFactory

Mengembalikan

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Membuat kebijakan yang membungkus permintaan keluar dengan rentang pelacakan.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Parameter

tracingOptions: TracingPolicyOptions

Opsi pelacakan.

Mengembalikan

RequestPolicyFactory

Instans <xref:TracingPolicy> kelas .

userAgentPolicy(TelemetryInfo)

Mengembalikan kebijakan yang menambahkan header agen pengguna ke permintaan keluar berdasarkan TelemetryInfo yang diberikan.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameter

userAgentData: TelemetryInfo

Informasi telemetri.

Mengembalikan

RequestPolicyFactory

<xref:UserAgentPolicy>Baru.

Bagikan melalui

@azure/core-http package

Kelas

Antarmuka

Alias Jenis

Enum

Fungsi

Detail Fungsi

applyMixins(unknown, any[])

Parameter

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Parameter

Mengembalikan

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Parameter

Mengembalikan

delay(number, DelayOptions)

Parameter

Mengembalikan

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Parameter

Mengembalikan

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Parameter

Mengembalikan

disableResponseDecompressionPolicy()

Mengembalikan

encodeUri(string)

Parameter

Mengembalikan

executePromisesSequentially(any[], unknown)

Parameter

Mengembalikan

exponentialRetryPolicy(number, number, number)

Parameter

Mengembalikan

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Parameter

Mengembalikan

generateClientRequestIdPolicy(string)

Parameter

Mengembalikan

generateUuid()

Mengembalikan

getDefaultProxySettings(string)

Parameter

Mengembalikan

getDefaultUserAgentValue()

Mengembalikan

isDuration(string)

Parameter

Mengembalikan

isTokenCredential(unknown)

Parameter

Mengembalikan

isValidUuid(string)

Parameter

Mengembalikan

keepAlivePolicy(KeepAliveOptions)

Parameter

Mengembalikan

logPolicy(LogPolicyOptions)

Parameter

Mengembalikan

operationOptionsToRequestOptionsBase<T>(T)

Parameter

Mengembalikan

parseXML(string, SerializerOptions)

Parameter

Mengembalikan

promiseToCallback(Promise<any>)

Parameter

Mengembalikan

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Parameter

Mengembalikan

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

Parameter

Mengembalikan

redirectPolicy(number)