共用方式為

RequestPrepareOptions interface

  • 參考
套件:
@azure/core-http

準備連出 HTTP 要求的選項。

屬性

abortSignal

中止控制器的訊號。 可用來中止傳送網路要求和等候回應。
baseUrl

要求的基底 URL。 默認值為：“https://management.azure.com"。 這隻適用於 pathTemplate。 如果您要提供 options.url，則預期您會提供完整的 URL。
body

要求本文。 它可以是任何類型。 如果此值不是數據流，則會串行化此值。
bodyIsStream

指出要求本文是否為數據流（適用於檔案上傳案例）。
deserializationMapper

提供有關如何還原串行化回應本文的資訊。
disableClientRequestId

當設定為 true 時，指示用戶端不要將 「x-ms-client-request-id」 標頭設定為新的 Guid（）。
disableJsonStringifyOnBody

指出這個方法是否應該 JSON.stringify（） 要求本文。 默認值：false。
formData

用來建置要求本文的窗體數據。
headers

需要套用至要求之要求標頭的字典。 這裡的索引鍵是 “header-name”，而值為 “header-value”。 標頭值必須是字串類型。

  • ContentType 必須以密鑰名稱提供為 「Content-Type」。。 默認值 「application/json;charset=utf-8”。
  • 如果 “options.bodyIsStream” 設定為 true，預設會將 “Transfer-Encoding” 設定為 “chunked”。
  • 如果 「options.bodyIsStream」 設定為 true，則 「Content-Type」 預設會設定為 「application/octet-stream」。。
  • 默認會將 “accept-language” 設定為 “en-US”
  • 預設會將 「x-ms-client-request-id」 設定為新的 Guid。 若要不產生要求的 GUID，請將 options.disableClientRequestId 設定為 true
mappers

在 [de]serialization 時可使用的對應器字典。
method

HTTP 要求方法。 有效值為 “GET”、“PUT”、“HEAD”、“DELETE”、“OPTIONS”、“POST” 或 “PATCH”。
onDownloadProgress

允許追蹤下載傳入回應的進度。
onUploadProgress

允許追蹤上傳傳出要求的進度。
pathParameters

需要取代為 pathTemplate 中實際值之路徑參數的字典。 在這裡，索引鍵是 “path-parameter-name”，而值為 “path-parameter-value”。 “path-parameter-value” 可以是 “string” 類型，也可以是 “object” 類型。 當您想要略過 URL 編碼時，應該使用 「object」 格式。 使用物件格式時，對象必須具有名為 value 的屬性，以提供 “path-parameter-value”。 例：

  • “object” 格式的 path-parameter-value：{ "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • “string” 格式的 path-parameter-value：{ "path-parameter-name": "path-parameter-value" }。
pathTemplate

要求 URL 的路徑範本。 提供 「url」 或提供 options 物件中的 「pathTemplate」。。 這兩個選項都是互斥的。 範例：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters

要附加至 URL 的查詢參數位典，其中 “key” 是 “query-parameter-name”，而 “value” 是 “query-parameter-value”。 “query-parameter-value” 可以是 “string” 類型，也可以是 “object” 類型。 當您想要略過 URL 編碼時，應該使用 「object」 格式。 使用物件格式時，對象必須具有名為 value 的屬性，以提供 “query-parameter-value”。 例：

  • “object” 格式的 query-parameter-value：{ "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • “string” 格式的 query-parameter-value：{ "query-parameter-name": "query-parameter-value"}。 注意：「如果 options.url 已經有一些查詢參數，則 options.queryParameters 中提供的值將會附加至 URL。
serializationMapper

提供有關如何串行化要求本文的資訊。
spanOptions

追蹤：啟用追蹤時用來建立範圍的選項。
tracingContext

追蹤：建立範圍時所使用的內容。
url

要求 URL。 它可能或可能沒有查詢參數。 提供 「url」 或提供 options 物件中的 「pathTemplate」。。 這兩個選項都是互斥的。

屬性詳細資料

abortSignal

中止控制器的訊號。 可用來中止傳送網路要求和等候回應。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

baseUrl

要求的基底 URL。 默認值為：“https://management.azure.com"。 這隻適用於 pathTemplate。 如果您要提供 options.url，則預期您會提供完整的 URL。

baseUrl?: string

屬性值

string

body

要求本文。 它可以是任何類型。 如果此值不是數據流，則會串行化此值。

body?: any

屬性值

any

bodyIsStream

指出要求本文是否為數據流（適用於檔案上傳案例）。

bodyIsStream?: boolean

屬性值

boolean

deserializationMapper

提供有關如何還原串行化回應本文的資訊。

deserializationMapper?: Record<string, unknown>

屬性值

Record<string, unknown>

disableClientRequestId

當設定為 true 時，指示用戶端不要將 「x-ms-client-request-id」 標頭設定為新的 Guid（）。

disableClientRequestId?: boolean

屬性值

boolean

disableJsonStringifyOnBody

指出這個方法是否應該 JSON.stringify（） 要求本文。 默認值：false。

disableJsonStringifyOnBody?: boolean

屬性值

boolean

formData

用來建置要求本文的窗體數據。

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

屬性值

{[key: string]: any}

headers

需要套用至要求之要求標頭的字典。 這裡的索引鍵是 “header-name”，而值為 “header-value”。 標頭值必須是字串類型。

  • ContentType 必須以密鑰名稱提供為 「Content-Type」。。 默認值 「application/json;charset=utf-8”。
  • 如果 “options.bodyIsStream” 設定為 true，預設會將 “Transfer-Encoding” 設定為 “chunked”。
  • 如果 「options.bodyIsStream」 設定為 true，則 「Content-Type」 預設會設定為 「application/octet-stream」。。
  • 默認會將 “accept-language” 設定為 “en-US”
  • 預設會將 「x-ms-client-request-id」 設定為新的 Guid。 若要不產生要求的 GUID，請將 options.disableClientRequestId 設定為 true
headers?: {[key: string]: any}

屬性值

{[key: string]: any}

mappers

在 [de]serialization 時可使用的對應器字典。

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

屬性值

{[x: string]: any}

method

HTTP 要求方法。 有效值為 “GET”、“PUT”、“HEAD”、“DELETE”、“OPTIONS”、“POST” 或 “PATCH”。

method: HttpMethods

屬性值

HttpMethods

onDownloadProgress

允許追蹤下載傳入回應的進度。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

onUploadProgress

允許追蹤上傳傳出要求的進度。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

pathParameters

需要取代為 pathTemplate 中實際值之路徑參數的字典。 在這裡，索引鍵是 “path-parameter-name”，而值為 “path-parameter-value”。 “path-parameter-value” 可以是 “string” 類型，也可以是 “object” 類型。 當您想要略過 URL 編碼時，應該使用 「object」 格式。 使用物件格式時，對象必須具有名為 value 的屬性，以提供 “path-parameter-value”。 例：

  • “object” 格式的 path-parameter-value：{ "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
  • “string” 格式的 path-parameter-value：{ "path-parameter-name": "path-parameter-value" }。
pathParameters?: {[key: string]: any | ParameterValue}

屬性值

{[key: string]: any | ParameterValue}

pathTemplate

要求 URL 的路徑範本。 提供 「url」 或提供 options 物件中的 「pathTemplate」。。 這兩個選項都是互斥的。 範例：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

屬性值

string

queryParameters

要附加至 URL 的查詢參數位典，其中 “key” 是 “query-parameter-name”，而 “value” 是 “query-parameter-value”。 “query-parameter-value” 可以是 “string” 類型，也可以是 “object” 類型。 當您想要略過 URL 編碼時，應該使用 「object」 格式。 使用物件格式時，對象必須具有名為 value 的屬性，以提供 “query-parameter-value”。 例：

  • “object” 格式的 query-parameter-value：{ "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • “string” 格式的 query-parameter-value：{ "query-parameter-name": "query-parameter-value"}。 注意：「如果 options.url 已經有一些查詢參數，則 options.queryParameters 中提供的值將會附加至 URL。
queryParameters?: {[key: string]: any | ParameterValue}

屬性值

{[key: string]: any | ParameterValue}

serializationMapper

提供有關如何串行化要求本文的資訊。

serializationMapper?: Mapper

屬性值

Mapper

spanOptions

追蹤：啟用追蹤時用來建立範圍的選項。

spanOptions?: SpanOptions

屬性值

@azure/core-tracing.SpanOptions

tracingContext

追蹤：建立範圍時所使用的內容。

tracingContext?: Context

屬性值

@azure/core-tracing.Context

url

要求 URL。 它可能或可能沒有查詢參數。 提供 「url」 或提供 options 物件中的 「pathTemplate」。。 這兩個選項都是互斥的。

url?: string

屬性值

string