@azure/ms-rest-js package

Referensi

Kelas

ApiKeyCredentials	Mengautentikasi ke layanan menggunakan kunci API.
AzureIdentityCredentialAdapter	Kelas ini menyediakan ekstensi sederhana untuk digunakan <xref:TokenCredential> dari `@azure/identity` pustaka untuk digunakan dengan Azure SDK warisan yang menerima keluarga kredensial ServiceClientCredentials untuk autentikasi.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials	Mengautentikasi ke layanan menggunakan kunci API.
HttpHeaders	Kumpulan pasangan kunci/nilai header HTTP.
RequestPolicyOptions	Properti opsional yang dapat digunakan saat membuat RequestPolicy.
RestError
Serializer
ServiceClient
TokenCredentials	Objek kredensial yang menggunakan string token dan skema otorisasi untuk mengautentikasi.
TopicCredentials	Mengautentikasi ke layanan menggunakan kunci API.
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 agnostik pustaka/implementasi 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.
AgentSettings	Agen HTTP dan HTTPS (hanya Node.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes	Jenis konten yang akan menunjukkan bahwa respons operasi harus dideserialisasi dengan cara tertentu.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
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.
MapperConstraints
OperationArguments	Kumpulan properti yang berlaku untuk satu pemanggilan operasi.
OperationParameter	Antarmuka umum yang diperluas oleh semua parameter Operasi.
OperationQueryParameter	Parameter untuk operasi yang akan ditambahkan sebagai parameter kueri ke permintaan HTTP operasi.
OperationResponse	Respons Operasi yang dapat dikembalikan dari permintaan operasi untuk satu kode status.
OperationSpec	Spesifikasi yang mendefinisikan operasi.
OperationURLParameter	Parameter untuk operasi yang akan diganti ke dalam URL permintaan operasi.
ParameterValue	Nilai Parameter yang disediakan untuk parameter jalur atau kueri di RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings	Pengaturan proksi HTTP (hanya Node.js)
RedirectOptions	Opsi tentang cara respons pengalihan ditangani.
RequestOptionsBase	Menjelaskan struktur dasar objek opsi yang akan digunakan dalam setiap operasi.
RequestPolicy
RequestPolicyOptionsLike	Properti opsional yang dapat digunakan saat membuat RequestPolicy.
RequestPrepareOptions
RestResponse	Respons yang diratakan ke panggilan REST. Berisi HttpOperationResponse yang mendasar serta properti gabungan parsedBody, parsedHeaders, dll.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions	Opsi yang akan disediakan saat membuat klien.
SimpleMapperType
TokenResponse	TokenResponse didefinisikan dalam dan disalin `@azure/ms-rest-nodeauth` di sini untuk tidak menambahkan dependensi yang tidak perlu.
UrlParameterValue
WebResourceLike	Abstraksi melalui panggilan REST.

Alias Jenis

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders	Koleksi HttpHeaders direpresentasikan sebagai objek JSON sederhana.
RequestPolicyFactory	Membuat RequestPolicy baru per permintaan yang menggunakan nextPolicy yang disediakan.
TelemetryInfo
TransferProgressEvent	Diaktifkan sebagai respons terhadap kemajuan unggahan atau unduhan.

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.

Fungsi

agentPolicy(AgentSettings)
applyMixins(any, any[])	Menerapkan properti pada prototipe sourceCtors ke prototipe targetCtor
delay<T>(number, T)	Pembungkus untuk setTimeout yang menyelesaikan janji setelah t milidetik.
deserializationPolicy(DeserializationContentTypes)	Buat serialisasi baru RequestPolicyCreator yang akan menserialisasikan badan permintaan HTTP saat melewati alur HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)	Mengodekan URI.
executePromisesSequentially(any[], any)	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, number)
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()	UUID yang dihasilkan
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)	Menunjukkan apakah string yang diberikan dalam format ISO 8601.
isValidUuid(string)	Memvalidasi uuid yang diberikan sebagai string
logPolicy(any)
promiseToCallback(Promise<any>)	Mengonversi Promise menjadi panggilan balik.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Mengonversi panggilan balik Promise ke layanan.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
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)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

Detail Fungsi

agentPolicy(AgentSettings)

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Parameter

agentSettings: AgentSettings

Mengembalikan

RequestPolicyFactory

applyMixins(any, any[])

Menerapkan properti pada prototipe sourceCtors ke prototipe targetCtor

function applyMixins(targetCtor: any, sourceCtors: any[])

Parameter

targetCtor: any

Objek target tempat properti perlu diterapkan.

sourceCtors: any[]

Array objek sumber tempat properti perlu diambil.

delay<T>(number, T)

Pembungkus untuk setTimeout yang menyelesaikan janji setelah t milidetik.

function delay<T>(t: number, value?: T): Promise<T>

Parameter

t: number

Jumlah milidetik yang akan ditunda.

value: T

Nilai yang akan diselesaikan setelah batas waktu t milidetik.

Mengembalikan

Promise<T>

Janji terselesaikan

deserializationPolicy(DeserializationContentTypes)

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

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Parameter

deserializationContentTypes: DeserializationContentTypes

Mengembalikan

RequestPolicyFactory

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

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

Parameter

jsonContentTypes: string[]

xmlContentTypes: string[]

response: HttpOperationResponse

Mengembalikan

Promise<HttpOperationResponse>

encodeUri(string)

Mengodekan URI.

function encodeUri(uri: string): string

Parameter

uri: string

URI yang akan dikodekan.

Mengembalikan

string

URI yang dikodekan.

executePromisesSequentially(any[], any)

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?: any): Promise<any>

Parameter

promiseFactories: any[]

Array pabrik janji (Fungsi yang mengembalikan janji)

kickstart: any

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, number)

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

Parameter

retryCount: number

retryInterval: number

minRetryInterval: number

maxRetryInterval: number

Mengembalikan

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

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

Parameter

_response: HttpOperationResponse

responseSpec: undefined | OperationResponse

Mengembalikan

RestResponse

generateClientRequestIdPolicy(string)

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Parameter

requestIdHeaderName: string

Mengembalikan

RequestPolicyFactory

generateUuid()

UUID yang dihasilkan

function generateUuid(): string

Mengembalikan

string

RFC4122 v4 UUID.

getDefaultProxySettings(string)

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

Parameter

proxyUrl: string

Mengembalikan

ProxySettings | undefined

getDefaultUserAgentValue()

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.

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.

logPolicy(any)

function logPolicy(logger?: any): RequestPolicyFactory

Parameter

logger: any

Mengembalikan

RequestPolicyFactory

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>): Function

Parameter

promise: Promise<any>

Janji untuk dikonversi menjadi panggilan balik

Mengembalikan

Function

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Mengonversi panggilan balik Promise ke layanan.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function

Parameter

promise: Promise<HttpOperationResponse>

Promise of HttpOperationResponse untuk dikonversi ke panggilan balik layanan

Mengembalikan

Function

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

proxyPolicy(ProxySettings)

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Parameter

proxySettings: ProxySettings

Mengembalikan

RequestPolicyFactory

redirectPolicy(number)

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Parameter

maximumRetries: number

Mengembalikan

RequestPolicyFactory

serializeObject(any)

function serializeObject(toSerialize: any): any

Parameter

toSerialize: any

Mengembalikan

any

signingPolicy(ServiceClientCredentials)

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Parameter

authenticationProvider: ServiceClientCredentials

Mengembalikan

RequestPolicyFactory

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)

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

Parameter

retryCount: number

retryInterval: number

minRetryInterval: number

maxRetryInterval: number

Mengembalikan

RequestPolicyFactory

throttlingRetryPolicy(number)

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Parameter

maxRetries: number

Mengembalikan

RequestPolicyFactory

userAgentPolicy(TelemetryInfo)

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Parameter

userAgentData: TelemetryInfo

Mengembalikan

RequestPolicyFactory