RequestPrepareOptions interface

  • Referensi
Paket:
@azure/ms-rest-js

Properti

abortSignal
baseUrl

Url dasar permintaan. Nilai defaultnya adalah: "https://management.azure.com". Ini hanya berlaku dengan pathTemplate. Jika Anda menyediakan options.url maka diharapkan Anda memberikan url lengkap.
body

Isi permintaan. Ini bisa dari jenis apa pun. Nilai ini akan diserialisasikan jika bukan aliran.
bodyIsStream

Menunjukkan apakah isi permintaan adalah aliran (berguna untuk skenario pengunggahan file).
deserializationMapper

Memberikan informasi tentang cara mendeserialisasi isi respons.
disableClientRequestId

Ketika diatur ke true, menginstruksikan klien untuk tidak mengatur header "x-ms-client-request-id" ke Guid() baru.
disableJsonStringifyOnBody

Menunjukkan apakah metode ini harus JSON.stringify() isi permintaan. Nilai default: false.
formData
headers

Kamus header permintaan yang perlu diterapkan ke permintaan. Di sini kuncinya adalah "header-name" dan nilainya adalah "header-value". Nilai header HARUS berjenis string.

  • ContentType harus disediakan dengan nama kunci sebagai "Content-Type". Nilai default "application/json; charset=utf-8".
  • "Transfer-Encoding" diatur ke "dipotong" secara default jika "options.bodyIsStream" diatur ke true.
  • "Content-Type" diatur ke "application/octet-stream" secara default jika "options.bodyIsStream" diatur ke true.
  • "accept-language" secara default diatur ke "en-US"
  • "x-ms-client-request-id" secara default diatur ke Guid baru. Untuk tidak menghasilkan guid untuk permintaan, atur options.disableClientRequestId ke true
mappers

Kamus pemeta yang dapat digunakan saat [de]serialisasi.
method

Metode permintaan HTTP. Nilai yang valid adalah "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST", atau "PATCH".
onDownloadProgress
onUploadProgress
pathParameters

Kamus parameter jalur yang perlu diganti dengan nilai aktual di pathTemplate. Di sini kuncinya adalah "path-parameter-name" dan nilainya adalah "path-parameter-value". "path-parameter-value" dapat berjenis "string" atau dapat berjenis "object". Format "objek" harus digunakan saat Anda ingin melewati pengodean url. Saat menggunakan format objek, objek harus memiliki properti bernama nilai yang menyediakan "path-parameter-value". Contoh:

  • path-parameter-value dalam format "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value dalam format "string": { "path-parameter-name": "path-parameter-value" }.
pathTemplate

Templat jalur url permintaan. Berikan "url" atau berikan "pathTemplate" di objek opsi. Kedua opsi saling eksklusif. Contoh: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"
queryParameters

Kamus parameter kueri yang akan ditambahkan ke url, di mana "kunci" adalah "query-parameter-name" dan "nilai" adalah "query-parameter-value". "query-parameter-value" dapat berjenis "string" atau dapat berjenis "object". Format "objek" harus digunakan saat Anda ingin melewati pengodean url. Saat menggunakan format objek, objek harus memiliki properti bernama nilai yang menyediakan "query-parameter-value". Contoh:

  • query-parameter-value dalam format "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value dalam format "string": { "query-parameter-name": "query-parameter-value"}. Catatan: "Jika options.url sudah memiliki beberapa parameter kueri, maka nilai yang disediakan di options.queryParameters akan ditambahkan ke url.
redirectLimit

Batasi jumlah pengalihan yang diikuti untuk permintaan ini. Jika diatur ke 0, pengalihan tidak akan diikuti. Jika dibiarkan tidak terdefinisi, perilaku pengalihan default dari node_fetch yang mendasar akan berlaku.
serializationMapper

Memberikan informasi tentang cara membuat serialisasi isi permintaan.
streamResponseBody
url

Url permintaan. Ini mungkin atau mungkin tidak memiliki parameter kueri di dalamnya. Berikan "url" atau berikan "pathTemplate" di objek opsi. Kedua opsi saling eksklusif.

Detail Properti

abortSignal 

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

baseUrl

Url dasar permintaan. Nilai defaultnya adalah: "https://management.azure.com". Ini hanya berlaku dengan pathTemplate. Jika Anda menyediakan options.url maka diharapkan Anda memberikan url lengkap.

baseUrl?: string

Nilai Properti

string

body

Isi permintaan. Ini bisa dari jenis apa pun. Nilai ini akan diserialisasikan jika bukan aliran.

body?: any

Nilai Properti

any

bodyIsStream

Menunjukkan apakah isi permintaan adalah aliran (berguna untuk skenario pengunggahan file).

bodyIsStream?: boolean

Nilai Properti

boolean

deserializationMapper

Memberikan informasi tentang cara mendeserialisasi isi respons.

deserializationMapper?: object

Nilai Properti

object

disableClientRequestId

Ketika diatur ke true, menginstruksikan klien untuk tidak mengatur header "x-ms-client-request-id" ke Guid() baru.

disableClientRequestId?: boolean

Nilai Properti

boolean

disableJsonStringifyOnBody

Menunjukkan apakah metode ini harus JSON.stringify() isi permintaan. Nilai default: false.

disableJsonStringifyOnBody?: boolean

Nilai Properti

boolean

formData 

formData?: {[key: string]: any}

Nilai Properti

{[key: string]: any}

headers

Kamus header permintaan yang perlu diterapkan ke permintaan. Di sini kuncinya adalah "header-name" dan nilainya adalah "header-value". Nilai header HARUS berjenis string.

  • ContentType harus disediakan dengan nama kunci sebagai "Content-Type". Nilai default "application/json; charset=utf-8".
  • "Transfer-Encoding" diatur ke "dipotong" secara default jika "options.bodyIsStream" diatur ke true.
  • "Content-Type" diatur ke "application/octet-stream" secara default jika "options.bodyIsStream" diatur ke true.
  • "accept-language" secara default diatur ke "en-US"
  • "x-ms-client-request-id" secara default diatur ke Guid baru. Untuk tidak menghasilkan guid untuk permintaan, atur options.disableClientRequestId ke true
headers?: {[key: string]: any}

Nilai Properti

{[key: string]: any}

mappers

Kamus pemeta yang dapat digunakan saat [de]serialisasi.

mappers?: {[x: string]: any}

Nilai Properti

{[x: string]: any}

method

Metode permintaan HTTP. Nilai yang valid adalah "GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST", atau "PATCH".

method: HttpMethods

Nilai Properti

HttpMethods

onDownloadProgress 

onDownloadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

onUploadProgress 

onUploadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

pathParameters

Kamus parameter jalur yang perlu diganti dengan nilai aktual di pathTemplate. Di sini kuncinya adalah "path-parameter-name" dan nilainya adalah "path-parameter-value". "path-parameter-value" dapat berjenis "string" atau dapat berjenis "object". Format "objek" harus digunakan saat Anda ingin melewati pengodean url. Saat menggunakan format objek, objek harus memiliki properti bernama nilai yang menyediakan "path-parameter-value". Contoh:

  • path-parameter-value dalam format "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • path-parameter-value dalam format "string": { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Nilai Properti

{[key: string]: any | ParameterValue}

pathTemplate

Templat jalur url permintaan. Berikan "url" atau berikan "pathTemplate" di objek opsi. Kedua opsi saling eksklusif. Contoh: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}"

pathTemplate?: string

Nilai Properti

string

queryParameters

Kamus parameter kueri yang akan ditambahkan ke url, di mana "kunci" adalah "query-parameter-name" dan "nilai" adalah "query-parameter-value". "query-parameter-value" dapat berjenis "string" atau dapat berjenis "object". Format "objek" harus digunakan saat Anda ingin melewati pengodean url. Saat menggunakan format objek, objek harus memiliki properti bernama nilai yang menyediakan "query-parameter-value". Contoh:

  • query-parameter-value dalam format "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value dalam format "string": { "query-parameter-name": "query-parameter-value"}. Catatan: "Jika options.url sudah memiliki beberapa parameter kueri, maka nilai yang disediakan di options.queryParameters akan ditambahkan ke url.
queryParameters?: {[key: string]: any | ParameterValue}

Nilai Properti

{[key: string]: any | ParameterValue}

redirectLimit

Batasi jumlah pengalihan yang diikuti untuk permintaan ini. Jika diatur ke 0, pengalihan tidak akan diikuti. Jika dibiarkan tidak terdefinisi, perilaku pengalihan default dari node_fetch yang mendasar akan berlaku.

redirectLimit?: number

Nilai Properti

number

serializationMapper

Memberikan informasi tentang cara membuat serialisasi isi permintaan.

serializationMapper?: Mapper

Nilai Properti

Mapper

streamResponseBody 

streamResponseBody?: boolean

Nilai Properti

boolean

url

Url permintaan. Ini mungkin atau mungkin tidak memiliki parameter kueri di dalamnya. Berikan "url" atau berikan "pathTemplate" di objek opsi. Kedua opsi saling eksklusif.

url?: string

Nilai Properti

string