@azure-rest/core-client package

Antarmuka

AddCredentialPipelinePolicyOptions	Parameter opsional untuk menambahkan kebijakan kredensial ke alur.
AdditionalPolicyConfig	Digunakan untuk mengonfigurasi kebijakan tambahan yang ditambahkan ke alur saat konstruksi.
Client	Bentuk Klien Tingkat Istirahat
ErrorModel	Objek kesalahan.
ErrorResponse	Respons yang berisi detail kesalahan.
FullOperationResponse	Objek pembungkus untuk permintaan dan respons http. Objek yang dideserialisasi disimpan di properti parsedBody ketika isi respons diterima di JSON.
InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
NodeJSReadableStream	Aliran Node.js Dapat Dibaca yang juga memiliki destroy metode .
OperationOptions	Jenis opsi dasar untuk semua operasi.
OperationRequestOptions	Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.
PathParameterWithOptions	Objek yang dapat diteruskan sebagai parameter jalur, memungkinkan opsi tambahan diatur yang berkaitan dengan bagaimana parameter dikodekan.
ResourceMethods	Menentukan metode yang dapat dipanggil pada sumber daya

Alias Jenis

ClientOptions	Opsi umum yang dapat diambil oleh Klien Tingkat Istirahat
HttpBrowserStreamResponse	Respons Http isi mana yang merupakan objek aliran NodeJS
HttpNodeStreamResponse	Respons Http isi mana yang merupakan objek aliran NodeJS
HttpResponse	Mewakili bentuk HttpResponse
PathParameters	Jenis pembantu yang digunakan untuk mendeteksi parameter dalam teks templat jalur yang dikelilingi oleh {} akan dianggap sebagai parameter jalur
PathUnchecked	Menentukan tanda tangan untuk pathUnchecked.
PathUncheckedResponse	Ketik untuk digunakan dengan pathUnchecked, mengambil alih jenis isi ke apa pun untuk memungkinkan fleksibilitas
RawResponseCallback	Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali. Panggilan balik ini akan dipanggil dengan dua parameter: respons mentah, termasuk header dan isi respons; dan objek kesalahan yang akan disediakan jika kesalahan dilemparkan saat memproses permintaan. Parameter __legacyError ketiga disediakan hanya untuk kompatibilitas mundur dan akan memiliki nilai yang identik dengan parameter error.
RequestParameters	Bentuk parameter permintaan default, ini mungkin ditimpa oleh jenis permintaan tertentu untuk menyediakan jenis yang kuat
StreamableMethod	Menentukan jenis untuk metode yang mendukung mendapatkan isi respons sebagai aliran mentah

Fungsi

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	Menambahkan kebijakan kredensial ke alur jika kredensial disediakan. Jika tidak ada yang disediakan, tidak ada kebijakan yang ditambahkan.
createRestError(PathUncheckedResponse)	Membuat kesalahan sisa dari respons PathUnchecked
createRestError(string, PathUncheckedResponse)	Membuat kesalahan istirahat dari pesan kesalahan dan respons PathUnchecked
getClient(string, ClientOptions)	Membuat klien dengan alur default
getClient(string, TokenCredential | KeyCredential, ClientOptions)	Membuat klien dengan alur default
operationOptionsToRequestParameters(OperationOptions)	Fungsi pembantu untuk mengonversi OperationOptions ke RequestParameters

Detail Fungsi

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Menambahkan kebijakan kredensial ke alur jika kredensial disediakan. Jika tidak ada yang disediakan, tidak ada kebijakan yang ditambahkan.

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

Parameter

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Membuat kesalahan sisa dari respons PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parameter

response

PathUncheckedResponse

Mengembalikan

RestError

createRestError(string, PathUncheckedResponse)

Membuat kesalahan istirahat dari pesan kesalahan dan respons PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

Parameter

message

string

response

PathUncheckedResponse

Mengembalikan

RestError

getClient(string, ClientOptions)

Membuat klien dengan alur default

function getClient(endpoint: string, options?: ClientOptions): Client

Parameter

endpoint

string

Titik akhir dasar untuk klien

options

ClientOptions

Opsi klien

Mengembalikan

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Membuat klien dengan alur default

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

Parameter

endpoint

string

Titik akhir dasar untuk klien

credentials

TokenCredential | KeyCredential

Kredensial untuk mengautentikasi permintaan

options

ClientOptions

Opsi klien

Mengembalikan

Client

operationOptionsToRequestParameters(OperationOptions)

Fungsi pembantu untuk mengonversi OperationOptions ke RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parameter

options

OperationOptions

opsi yang digunakan oleh lapisan Modular untuk mengirim permintaan

Mengembalikan

RequestParameters

hasil konversi dalam RequestParameters lapisan RLC