Поделиться через

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-value". Значение заголовка должно иметь строку типа.

  • 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". Формат "object" должен использоваться, если требуется пропустить кодировку URL-адресов. При использовании формата объекта объект должен иметь свойство с именем значения, которое предоставляет значение path-parameter-value. Пример:

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

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

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

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

Содержит сведения о сериализации текста запроса.
spanOptions

Трассировка: параметры, используемые для создания диапазона при включении трассировки.
tracingContext

Трассировка: контекст, используемый при создании диапазонов.
url

URL-адрес запроса. В нем могут быть или нет параметров запроса. Укажите url-адрес или укажите 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-value". Значение заголовка должно иметь строку типа.

  • 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". Формат "object" должен использоваться, если требуется пропустить кодировку URL-адресов. При использовании формата объекта объект должен иметь свойство с именем значения, которое предоставляет значение path-parameter-value. Пример:

  • path-parameter-value в формате object: { "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 в объекте параметров. Оба варианта являются взаимоисключающими. Пример: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

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

string

queryParameters

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

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

url?: string

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

string