Share via

RequestPrepareOptions interface

  • リファレンス
パッケージ:
@azure/ms-rest-js

プロパティ

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" です。 ヘッダー値は string 型である必要があります。

  • ContentType には、キー名を "Content-Type" として指定する必要があります。 既定値 "application/json;charset=utf-8"
  • "options.bodyIsStream" が true に設定されている場合、"Transfer-Encoding" は既定で "チャンク" に設定されます。
  • "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" 形式を使用する必要があります。 オブジェクト形式を使用する場合、オブジェクトには"path-parameter-value" を提供する 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" 形式を使用する必要があります。 オブジェクト形式を使用する場合、オブジェクトには"query-parameter-value" を提供する 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 に追加されます。
redirectLimit

この要求に対して従うリダイレクトの数を制限します。 0 に設定すると、リダイレクトは実行されません。 未定義のままにすると、基になるnode_fetchの既定のリダイレクト動作が適用されます。
serializationMapper

要求本文をシリアル化する方法について説明します。
streamResponseBody
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?: object

プロパティ値

object

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" です。 ヘッダー値は string 型である必要があります。

  • ContentType には、キー名を "Content-Type" として指定する必要があります。 既定値 "application/json;charset=utf-8"
  • "options.bodyIsStream" が true に設定されている場合、"Transfer-Encoding" は既定で "チャンク" に設定されます。
  • "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" 形式を使用する必要があります。 オブジェクト形式を使用する場合、オブジェクトには"path-parameter-value" を提供する 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" 形式を使用する必要があります。 オブジェクト形式を使用する場合、オブジェクトには"query-parameter-value" を提供する 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}

redirectLimit

この要求に対して従うリダイレクトの数を制限します。 0 に設定すると、リダイレクトは実行されません。 未定義のままにすると、基になるnode_fetchの既定のリダイレクト動作が適用されます。

redirectLimit?: number

プロパティ値

number

serializationMapper

要求本文をシリアル化する方法について説明します。

serializationMapper?: Mapper

プロパティ値

Mapper

streamResponseBody 

streamResponseBody?: boolean

プロパティ値

boolean

url

要求 URL。 クエリ パラメーターが含まれる場合とない場合があります。 "url" を指定するか、options オブジェクトに "pathTemplate" を指定します。 どちらのオプションも相互に排他的です。

url?: string

プロパティ値

string