通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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] 序列化时可以使用的映射器的字典。
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] 序列化时可以使用的映射器的字典。

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