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".
  • Для параметра Transfer-Encoding по умолчанию задано значение "фрагментированные", если для options.bodyIsStream задано значение true.
  • Для параметра Content-Type по умолчанию задано значение application/octet-stream, если для options.bodyIsStream задано значение true.
  • Для параметра 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-адреса, следует использовать формат "объект". При использовании формата объекта объект должен иметь свойство с именем value, которое предоставляет значение path-parameter-value. Пример

  • path-parameter-value в формате объекта: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } } }
  • path-parameter-value в формате string: { "path-parameter-name": "path-parameter-value" }.
pathTemplate

Шаблон пути URL-адреса запроса. Укажите url-адрес или pathTemplate в объекте options. Оба варианта являются взаимоисключающими. Пример: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}".
queryParameters

Словарь параметров запроса, добавляемых к URL-адресу, где "key" — это "имя-параметра запроса", а "значение" — "query-parameter-value". Параметр query-parameter-value может иметь тип string или тип object. Если вы хотите пропустить кодирование URL-адреса, следует использовать формат "объект". При использовании формата объекта объект должен иметь свойство с именем value, которое предоставляет значение query-parameter-value. Пример

  • query-parameter-value в формате "объект": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value в формате string: { "query-parameter-name": "query-parameter-value"}. Примечание. Если у options.url уже есть некоторые параметры запроса, к URL-адресу будет добавлено значение, указанное в options.queryParameters.
redirectLimit

Ограничьте количество перенаправлений для этого запроса. Если задано значение 0, перенаправления не будут следовать. Если этот параметр не определен, будет применяться поведение перенаправления по умолчанию для базового node_fetch.
serializationMapper

Предоставляет сведения о сериализации текста запроса.
streamResponseBody
url

URL-адрес запроса. В ней могут быть параметры запроса. Укажите url-адрес или pathTemplate в объекте options. Оба варианта являются взаимоисключающими.

Сведения о свойстве

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".
  • Для параметра Transfer-Encoding по умолчанию задано значение "фрагментированные", если для options.bodyIsStream задано значение true.
  • Для параметра Content-Type по умолчанию задано значение application/octet-stream, если для options.bodyIsStream задано значение true.
  • Для параметра 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-адреса, следует использовать формат "объект". При использовании формата объекта объект должен иметь свойство с именем value, которое предоставляет значение path-parameter-value. Пример

  • path-parameter-value в формате объекта: { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } } }
  • path-parameter-value в формате string: { "path-parameter-name": "path-parameter-value" }.
pathParameters?: {[key: string]: any | ParameterValue}

Значение свойства

{[key: string]: any | ParameterValue}

pathTemplate

Шаблон пути URL-адреса запроса. Укажите url-адрес или pathTemplate в объекте options. Оба варианта являются взаимоисключающими. Пример: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}".

pathTemplate?: string

Значение свойства

string

queryParameters

Словарь параметров запроса, добавляемых к URL-адресу, где "key" — это "имя-параметра запроса", а "значение" — "query-parameter-value". Параметр query-parameter-value может иметь тип string или тип object. Если вы хотите пропустить кодирование URL-адреса, следует использовать формат "объект". При использовании формата объекта объект должен иметь свойство с именем value, которое предоставляет значение query-parameter-value. Пример

  • query-parameter-value в формате "объект": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
  • query-parameter-value в формате string: { "query-parameter-name": "query-parameter-value"}. Примечание. Если у options.url уже есть некоторые параметры запроса, к URL-адресу будет добавлено значение, указанное в options.queryParameters.
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-адрес или pathTemplate в объекте options. Оба варианта являются взаимоисключающими.

url?: string

Значение свойства

string