Bagikan melalui

RequestPrepareOptions interface

  • Referensi
Paket:
@azure/core-http

Opsi untuk menyiapkan permintaan HTTP keluar.

Properti

abortSignal

Sinyal pengontrol batal. Dapat digunakan untuk membatalkan pengiriman permintaan jaringan dan menunggu respons.
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

Menyediakan 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

Data formulir, digunakan untuk membangun isi permintaan.
headers

Kamus header permintaan yang perlu diterapkan ke permintaan. Di sini kuncinya adalah "header-name" dan nilainya adalah "header-value". Nilai header HARUS dari jenis 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

Memungkinkan melacak kemajuan pengunduhan respons masuk.
onUploadProgress

Memungkinkan melacak kemajuan pengunggahan permintaan keluar.
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 ini 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 "value" 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.
serializationMapper

Menyediakan informasi tentang cara membuat serialisasi isi permintaan.
spanOptions

Pelacakan: Opsi yang digunakan untuk membuat rentang saat pelacakan diaktifkan.
tracingContext

Pelacakan: Konteks yang digunakan saat membuat rentang.
url

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

Detail Properti

abortSignal

Sinyal pengontrol batal. Dapat digunakan untuk membatalkan pengiriman permintaan jaringan dan menunggu respons.

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

Menyediakan informasi tentang cara mendeserialisasi isi respons.

deserializationMapper?: Record<string, unknown>

Nilai Properti

Record<string, unknown>

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

Data formulir, digunakan untuk membangun isi permintaan.

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 dari jenis 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

Memungkinkan melacak kemajuan pengunduhan respons masuk.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

onUploadProgress

Memungkinkan melacak kemajuan pengunggahan permintaan keluar.

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 ini 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 "value" 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}

serializationMapper

Menyediakan informasi tentang cara membuat serialisasi isi permintaan.

serializationMapper?: Mapper

Nilai Properti

Mapper

spanOptions

Pelacakan: Opsi yang digunakan untuk membuat rentang saat pelacakan diaktifkan.

spanOptions?: SpanOptions

Nilai Properti

@azure/core-tracing.SpanOptions

tracingContext

Pelacakan: Konteks yang digunakan saat membuat rentang.

tracingContext?: Context

Nilai Properti

@azure/core-tracing.Context

url

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

url?: string

Nilai Properti

string