@azure/core-http package

Ссылка

Классы

AccessTokenRefresher	Помогает политикам проверки подлинности маркера core-http запрашивать новый маркер, если в настоящее время мы не ждем нового маркера.
ApiKeyCredentials	Выполняет проверку подлинности в службе с помощью ключа API.
BaseRequestPolicy	Базовый класс, из которого наследуют все политики запросов.
BasicAuthenticationCredentials	Простая <xref:ServiceClientCredential>, которая проходит проверку подлинности с помощью имени пользователя и пароля.
DefaultHttpClient	HTTP-клиент, использующий `node-fetch`.
ExpiringAccessTokenCache	Предоставляет реализацию AccessTokenCache, которая очищает кэшированные AccessTokenпосле истечения срока действияOnTimestamp.
HttpHeaders	Коллекция пар ключей и значений заголовка HTTP.
RequestPolicyOptions	Необязательные свойства, которые можно использовать при создании RequestPolicy.
RestError	Ошибка, полученная из HTTP-запроса к конечной точке службы.
Serializer	Используется для сопоставления необработанных объектов отклика с конечными фигурами. Помогает упаковывать и распаковывать даты и другие типы в кодировке JSON. Также позволяет извлекать значения из заголовков, а также вставлять значения и константы по умолчанию.
ServiceClient	ServiceClient отправляет запросы на обслуживание и получает ответы.
TopicCredentials	Объект TopicCredentials, используемый для сетки событий Azure.
URLBuilder	Класс, обрабатывающий создание, изменение и анализ URL-адресов.
URLQuery	Класс, обрабатывающий часть запроса URLBuilder.
WebResource	Создает новый объект WebResource. Этот класс предоставляет абстракцию по вызову REST, будучи библиотекой или реализацией неактивным и упаковав необходимые свойства для запуска запроса.

Интерфейсы

AbortSignalLike	Позволяет прервать запрос при срабатывании события прерывания. Совместим с встроенным браузером AbortSignal и общими полизаполнениями.
AccessToken	Представляет маркер доступа с истечением срока действия.
AccessTokenCache	Предоставляет кэш для AccessToken, который был возвращен из TokenCredential.
ApiKeyCredentialOptions	Описание параметров, предоставляемых при создании экземпляра ApiKeyCredentials
BaseMapper	Базовое определение карты. Можно использовать для xml-объектов и простых объектов JavaScript.
CompositeMapper	Mapper, состоящий из других карт.
CompositeMapperType	Помогает создать схему, описывающую сопоставление набора свойств объекта на основе других карт. Должно присутствовать только одно из следующих свойств: `className`, `modelProperties` и `additionalProperties`.
DeserializationContentTypes	Типы контента, указывающие, что ответ операции должен быть десериализирован определенным образом.
DeserializationOptions	Параметры настройки десериализации ответа API.
DictionaryMapper	Схема, описывающая обычные объекты JavaScript, используемые в качестве пар "ключ-значение".
DictionaryMapperType	Помогает создать сопоставителя, описывающего анализ словаря сопоставленных значений.
EnumMapper	Схема, описывающая значение перечисления.
EnumMapperType	Помогает создать приложение mapper, описывающее анализ значения перечисления.
GetTokenOptions	Определяет параметры tokenCredential.getToken.
HttpClient	Интерфейс, который может отправлять httpRequests и получать обещанные httpResponses.
HttpHeader	Отдельный заголовок в коллекции HttpHeaders.
HttpHeadersLike	Коллекция пар ключей и значений заголовка HTTP.
HttpOperationResponse	Объект-оболочка для http-запроса и ответа. Десериализированный объект хранится в свойстве `parsedBody` при получении текста ответа в формате JSON или XML.
HttpPipelineLogger	Средство ведения журнала, которое можно добавить в httpPipeline. Это позволяет каждому requestPolicy регистрировать сообщения, которые можно использовать для отладки.
HttpResponse	Свойства http-ответа, который всегда будет присутствовать.
InternalPipelineOptions	Определяет параметры, используемые для настройки внутренних параметров конвейера HTTP для клиента ПАКЕТА SDK.
KeepAliveOptions	Параметры того, как должны поддерживаться HTTP-подключения для будущих запросов.
LogPolicyOptions	Параметры передачи в logPolicy. По умолчанию регистрируются только список заголовков набора, хотя это можно настроить. Тела запросов и ответов никогда не регистрируются.
MapperConstraints	Описание различных ограничений значений, таких как целые диапазоны и строковый regex.
OperationArguments	Коллекция свойств, которые применяются к одному вызову операции.
OperationOptions	Базовый тип параметров для всех операций.
OperationParameter	Общий интерфейс, расширяющий все параметры операции.
OperationQueryParameter	Параметр для операции, которая будет добавлена в качестве параметра запроса в HTTP-запрос операции.
OperationRequestOptions	Параметры, позволяющие настроить обработку HTTP-запросов, сделанных операцией пакета SDK.
OperationResponse	ОперацияResponse, которую можно вернуть из запроса операции для одного кода состояния.
OperationSpec	Спецификация, определяющая выполнение определенной операции службы по протоколу HTTP, в том числе способ правильной сериализации сведений запроса в сведения о ответе и десериализации сведений об ответе в полезные данные объекта, возвращаемые ServiceClient.
OperationURLParameter	Параметр для операции, которая будет заменена URL-адресом запроса операции.
ParameterValue	Значение параметра, предоставленное для параметров пути или запроса в RequestPrepareOptions
PipelineOptions	Определяет параметры, используемые для настройки конвейера HTTP для клиента ПАКЕТА SDK.
PolymorphicDiscriminator	Используется для дивамбигуации дискриминированных профсоюзов типов. Например, если ответ может иметь множество фигур, но также содержит поле типа (или аналогично), это поле можно использовать для определения десериализации ответа на правильный тип.
ProxySettings	Параметры настройки прокси-сервера для исходящих запросов (Node.js только).
RedirectOptions	Параметры обработки ответов перенаправления.
RequestOptionsBase	Описывает базовую структуру объекта параметров, который будет использоваться в каждой операции.
RequestPolicy	Базовая структура политики запроса.
RequestPolicyOptionsLike	Необязательные свойства, которые можно использовать при создании RequestPolicy.
RequestPrepareOptions	Параметры подготовки исходящего HTTP-запроса.
RestResponse	Неструктурированный ответ на вызов REST. Содержит базовые HttpOperationResponse, а также объединенные свойства `parsedBody`, `parsedHeaders`и т. д.
RetryOptions	Параметры, управляющие повторными неудачными запросами.
SequenceMapper	Схема, описывающая массивы.
SequenceMapperType	Помогает создать схему, описывающую синтаксический анализ последовательности сопоставленных значений.
SerializerOptions	Параметры управления поведением средства синтаксического анализа XML и построителя.
ServiceCallback
ServiceClientCredentials	Представляет объект или класс с методом `signRequest`, который будет подписывать исходящие запросы (например, задав заголовок `Authorization`).
ServiceClientOptions	Параметры, предоставляемые при создании клиента.
SimpleMapperType	Тип простого сопоставителя.
TokenCredential	Представляет учетные данные, способные предоставлять маркер проверки подлинности.
TracingPolicyOptions	Параметры настройки политики трассировки.
UrlParameterValue	Интерфейс, представляющий значение параметра URL-адреса.
UserAgentOptions	Параметры добавления сведений об агенте пользователя в исходящие запросы.
WebResourceLike	Описание HTTP-запроса, который необходимо выполнить на удаленном сервере.

Псевдонимы типа

Authenticator	Функция, получающая вызов и разрешающая обещание с помощью строкового токена.
CommonRequestInfo	Строковые URL-адреса, используемые при вызове `fetch()`.
CommonRequestInit	Объект, содержащий сведения об исходящем HTTP-запросе.
CommonResponse	Объект, содержащий сведения о входящем HTTP-ответе.
HttpMethods	Список поддерживаемых методов HTTP.
HttpRequestBody	Возможные типы текста HTTP-запроса
Mapper	Mappers — это определения моделей данных, используемых в библиотеке. Эти модели данных являются частью определений операции или клиента в ответах или параметрах.
MapperType	Тип сопоставителя. Включает известные карты.
ParameterPath	Путь, описывающий, как получить доступ к определенному свойству в заданном источнике данных объекта. Может быть одним именем свойства, массивом, обозначающим вложенные имена свойств, или набор нескольких именованных свойств с путями в случае сложных значений объектов.
ProxyOptions	Псевдоним ProxySettings для дальнейшего использования.
RawHttpHeaders	Коллекция HttpHeaders, представленная как простой объект JSON.
RequestPolicyFactory	Создает новый запрос RequestPolicy для каждого запроса, использующего предоставленный nextPolicy.
TelemetryInfo	Сведения телеметрии. Пары "ключ-значение", которые включаются в строку User-Agent.
TransferProgressEvent	Активируется в ответ на ход отправки или скачивания.

Перечисления

HttpPipelineLogLevel	Различные уровни журналов, которые можно использовать с httpPipelineLogger.
QueryCollectionFormat	Формат, который будет использоваться для объединения массива значений для значения параметра запроса.
RetryMode	Описывает тип режима повтора. В настоящее время поддерживается только экспоненциальная.

Функции

applyMixins(unknown, any[])	Применяет свойства к прототипу sourceCtors к прототипу targetCtor
bearerTokenAuthenticationPolicy(TokenCredential, string \| string[])	Создает новую фабрику для RequestPolicy, которая применяет маркер носителя к заголовкам `Authorization` запросов.
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	Создает конвейер HTTP на основе заданных параметров.
delay(number, DelayOptions)	Оболочка для setTimeout, которая разрешает обещание после миллисекундах timeInMs.
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	Создайте новую сериализацию RequestPolicyCreator, которая сериализует тела HTTP-запросов по мере передачи через конвейер HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	Учитывая определенный набор типов контента для анализа как JSON или XML, использует HTTP-ответ для создания объекта результата, определенного OperationSpec запроса.
disableResponseDecompressionPolicy()	Возвращает фабрику политик запроса, которую можно использовать для создания экземпляра <xref:DisableResponseDecompressionPolicy>.
encodeUri(string)	Кодирует универсальный код ресурса (URI).
executePromisesSequentially(any[], unknown)	Выполняет массив обещаний последовательно. Вдохновение этого метода здесь: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Удивительный блог о обещаниях!
exponentialRetryPolicy(number, number, number)	Политика, которая повторяет запрос столько раз, сколько настроено до указанного максимального интервала времени повтора, каждая повторная попытка, ожидающая больше времени начала, чем в последний раз.
flattenResponse(HttpOperationResponse, undefined \| OperationResponse)	Анализирует httpOperationResponse в нормализованный объект ответа HTTP (RestResponse).
generateClientRequestIdPolicy(string)	Создает политику, которая назначает уникальный идентификатор запроса исходящим запросам.
generateUuid()	Созданный UUID
getDefaultProxySettings(string)	Преобразует заданный URL-адрес прокси-сервера в `ProxySettings` или пытается получить `ProxySettings` из текущей среды, если он не передан.
getDefaultUserAgentValue()	Подход по умолчанию для создания агентов пользователей. Использует статические сведения из этого пакета, а также системные сведения, доступные в среде выполнения.
isDuration(string)	Указывает, находится ли указанная строка в формате ISO 8601.
isTokenCredential(unknown)	Проверяет объект, чтобы определить, реализуется ли он TokenCredential.
isValidUuid(string)	Проверяет заданный uuid как строку
keepAlivePolicy(KeepAliveOptions)	Создает политику, которая определяет, поддерживаются ли HTTP-подключения в будущих запросах.
logPolicy(LogPolicyOptions)	Создает политику, которая регистрирует сведения об исходящем запросе и входящих ответах.
operationOptionsToRequestOptionsBase<T>(T)	Преобразует OperationOptions в RequestOptionsBase
parseXML(string, SerializerOptions)	Преобразует указанную строку XML в JSON
promiseToCallback(Promise<any>)	Преобразует обещание в обратный вызов.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Преобразует обещание в обратный вызов службы.
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	Политика, которая позволяет применять параметры прокси-сервера ко всем запросам. Если не переданы статические параметры, они будут получены из переменных среды HTTPS_PROXY или HTTP_PROXY среды.
redirectPolicy(number)	Создает политику перенаправления, которая отправляет запрос в новое место назначения, если ответ поступает с заголовком location и кодом состояния от 300 до 307.
serializeObject(unknown)	Служебная функция, которая сериализует объект, который может содержать двоичные данные в обычный объект, массив или строку.
signingPolicy(ServiceClientCredentials)	Создает политику, которая подписывает исходящие запросы путем вызова предоставленного метода `authenticationProvidersignRequest`.
stringifyXML(unknown, SerializerOptions)	Преобразует заданный объект JSON в XML-строку
stripRequest(WebResourceLike)	Возвращает отрезаную версию http-запроса, которая не содержит заголовок авторизации.
stripResponse(HttpOperationResponse)	Возвращает отрезаную версию http-ответа, которая содержит только текст, заголовки и состояние.
systemErrorRetryPolicy(number, number, number, number)	Политика, которая повторяется при возникновении системной ошибки, определяемой кодами ETIMEDOUT, ESOCKETTIMEDOUT, ECONNREFUSED, ECONNRESET или ENOENT.
throttlingRetryPolicy()	Создает политику, которая повторно отправляет запрос, если ответ указывает на сбой запроса из-за регулирования. Например, если ответ содержит заголовок `Retry-After`, он повторит отправку запроса на основе значения этого заголовка. Дополнительные сведения см. в https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits и https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
tracingPolicy(TracingPolicyOptions)	Создает политику, которая упаковывает исходящие запросы с диапазоном трассировки.
userAgentPolicy(TelemetryInfo)	Возвращает политику, которая добавляет заголовок агента пользователя в исходящие запросы на основе заданной TelemetryInfo.

Сведения о функции

applyMixins(unknown, any[])

Применяет свойства к прототипу sourceCtors к прототипу targetCtor

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

Параметры

targetCtorParam: unknown

sourceCtors: any[]

Массив исходных объектов, из которых необходимо принять свойства.

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Создает новую фабрику для RequestPolicy, которая применяет маркер носителя к заголовкам Authorization запросов.

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

Параметры

credential: TokenCredential

Реализация TokenCredential, которая может предоставить маркер носителя.

scopes: string | string[]

Области, для которых применяется маркер носителя.

Возвращаемое значение

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Создает конвейер HTTP на основе заданных параметров.

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

Параметры

pipelineOptions: InternalPipelineOptions

Определяет параметры, используемые для настройки политик в конвейере HTTP для клиента ПАКЕТА SDK.

authPolicyFactory: RequestPolicyFactory

Необязательная фабрика политик проверки подлинности, используемая для подписывания запросов.

Возвращаемое значение

ServiceClientOptions

Набор параметров, которые можно передать для создания нового ServiceClient.

delay(number, DelayOptions)

Оболочка для setTimeout, которая разрешает обещание после миллисекундах timeInMs.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Параметры

timeInMs: number

Число отложенных миллисекундах.

options: DelayOptions

Параметры задержки — в настоящее время параметры прерывания

Возвращаемое значение

Promise<void>

Обещание, которое разрешается после времениInMs

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Создайте новую сериализацию RequestPolicyCreator, которая сериализует тела HTTP-запросов по мере передачи через конвейер HTTP.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Параметры

deserializationContentTypes: DeserializationContentTypes

parsingOptions: SerializerOptions

Возвращаемое значение

RequestPolicyFactory

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Учитывая определенный набор типов контента для анализа как JSON или XML, использует HTTP-ответ для создания объекта результата, определенного OperationSpec запроса.

function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>

Параметры

jsonContentTypes: string[]

Типы контента ответа для анализа текста как JSON.

xmlContentTypes: string[]

Типы контента ответа для синтаксического анализа текста как XML.

response: HttpOperationResponse

HTTP-ответ из конвейера.

options: SerializerOptions

Параметры сериализатора, в основном для настройки средства синтаксического анализа XML при необходимости.

Возвращаемое значение

Promise<HttpOperationResponse>

Проанализированный объект HttpOperationResponse, который может быть возвращен ServiceClient.

disableResponseDecompressionPolicy()

Возвращает фабрику политик запроса, которую можно использовать для создания экземпляра <xref:DisableResponseDecompressionPolicy>.

function disableResponseDecompressionPolicy(): RequestPolicyFactory

Возвращаемое значение

RequestPolicyFactory

encodeUri(string)

Кодирует универсальный код ресурса (URI).

function encodeUri(uri: string): string

Параметры

uri: string

Кодируемый универсальный код ресурса (URI).

Возвращаемое значение

string

Кодированный универсальный код ресурса (URI).

executePromisesSequentially(any[], unknown)

Выполняет массив обещаний последовательно. Вдохновение этого метода здесь: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Удивительный блог о обещаниях!

function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>

Параметры

promiseFactories: any[]

Массив фабрик обещаний (функция, возвращающая обещание)

kickstart: unknown

Ввод в первое обещание, которое используется для запуска цепочки обещаний. Если это не указано, цепочка обещаний начинается с неопределенного значения.

Возвращаемое значение

Promise<any>

Цепочка разрешенных или отклоненных обещаний

exponentialRetryPolicy(number, number, number)

Политика, которая повторяет запрос столько раз, сколько настроено до указанного максимального интервала времени повтора, каждая повторная попытка, ожидающая больше времени начала, чем в последний раз.

function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Параметры

retryCount: number

Максимальное количество повторных попыток.

retryInterval: number

Базовое время между повторными попытками.

maxRetryInterval: number

Максимальное время ожидания между повторными попытками.

Возвращаемое значение

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Анализирует httpOperationResponse в нормализованный объект ответа HTTP (RestResponse).

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

Параметры

_response: HttpOperationResponse

Объект-оболочка для http-ответа.

responseSpec: undefined | OperationResponse

Схемы для анализа свойств ответа.

Возвращаемое значение

RestResponse

Нормализованный объект ответа.

generateClientRequestIdPolicy(string)

Создает политику, которая назначает уникальный идентификатор запроса исходящим запросам.

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

Параметры

requestIdHeaderName: string

Имя заголовка, используемого при назначении уникального идентификатора запросу.

Возвращаемое значение

RequestPolicyFactory

generateUuid()

Созданный UUID

function generateUuid(): string

Возвращаемое значение

string

RFC4122 UUID версии 4.

getDefaultProxySettings(string)

Преобразует заданный URL-адрес прокси-сервера в ProxySettings или пытается получить ProxySettings из текущей среды, если он не передан.

function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined

Параметры

proxyUrl: string

URL-адрес прокси-сервера

Возвращаемое значение

ProxySettings | undefined

Параметры прокси-сервера по умолчанию или неопределенные.

getDefaultUserAgentValue()

Подход по умолчанию для создания агентов пользователей. Использует статические сведения из этого пакета, а также системные сведения, доступные в среде выполнения.

function getDefaultUserAgentValue(): string

Возвращаемое значение

string

isDuration(string)

Указывает, находится ли указанная строка в формате ISO 8601.

function isDuration(value: string): boolean

Параметры

value: string

Значение, которое необходимо проверить для формата длительности ISO 8601.

Возвращаемое значение

boolean

true, если допустимый, false в противном случае.

isTokenCredential(unknown)

Проверяет объект, чтобы определить, реализуется ли он TokenCredential.

function isTokenCredential(credential: unknown): credential

Параметры

credential: unknown

Предполагаемая проверка tokenCredential.

Возвращаемое значение

credential

isValidUuid(string)

Проверяет заданный uuid как строку

function isValidUuid(uuid: string): boolean

Параметры

uuid: string

uuid в виде строки, которая должна быть проверена

Возвращаемое значение

boolean

Значение True, если uuid является допустимым; False в противном случае.

keepAlivePolicy(KeepAliveOptions)

Создает политику, которая определяет, поддерживаются ли HTTP-подключения в будущих запросах.

function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory

Параметры

keepAliveOptions: KeepAliveOptions

Сохранение живых параметров. По умолчанию HTTP-подключения сохраняются для будущих запросов.

Возвращаемое значение

RequestPolicyFactory

Экземпляр <xref:KeepAlivePolicy>

logPolicy(LogPolicyOptions)

Создает политику, которая регистрирует сведения об исходящем запросе и входящих ответах.

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

Параметры

loggingOptions: LogPolicyOptions

Параметры ведения журнала.

Возвращаемое значение

RequestPolicyFactory

Экземпляр <xref:LogPolicy>

operationOptionsToRequestOptionsBase<T>(T)

Преобразует OperationOptions в RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

Параметры

opts: T

Объект OperationOptions для преобразования в RequestOptionsBase

Возвращаемое значение

RequestOptionsBase

parseXML(string, SerializerOptions)

Преобразует указанную строку XML в JSON

function parseXML(str: string, opts?: SerializerOptions): Promise<any>

Параметры

str: string

Строка, содержащая XML-содержимое для анализа в ФОРМАТЕ JSON

opts: SerializerOptions

Параметры, управляющие синтаксический анализ заданной xml-строки

Возвращаемое значение

Promise<any>

promiseToCallback(Promise<any>)

Предупреждение

Теперь этот API является нерекомендуемым.

generated code should instead depend on responseToBody

Преобразует обещание в обратный вызов.

function promiseToCallback(promise: Promise<any>): (cb: Function) => void

Параметры

promise: Promise<any>

Обещание, которое необходимо преобразовать в обратный вызов

Возвращаемое значение

(cb: Function) => void

Функция, которая принимает обратный вызов (cb: Function) => void

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Преобразует обещание в обратный вызов службы.

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void

Параметры

promise: Promise<HttpOperationResponse>

Обещание httpOperationResponse, которое необходимо преобразовать в обратный вызов службы

Возвращаемое значение

(cb: ServiceCallback<T>) => void

Функция, которая принимает обратный вызов службы (cb: ServiceCallback): void

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Политика, которая позволяет применять параметры прокси-сервера ко всем запросам. Если не переданы статические параметры, они будут получены из переменных среды HTTPS_PROXY или HTTP_PROXY среды.

function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): RequestPolicyFactory

Параметры

proxySettings: ProxySettings

ProxySettings для использования для каждого запроса.

options: { customNoProxyList?: string[] }

дополнительные параметры, например пользовательские шаблоны NO_PROXY

Возвращаемое значение

RequestPolicyFactory

redirectPolicy(number)

Создает политику перенаправления, которая отправляет запрос в новое место назначения, если ответ поступает с заголовком location и кодом состояния от 300 до 307.

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Параметры

maximumRetries: number

Максимальное количество перенаправлений для выполнения.

Возвращаемое значение

RequestPolicyFactory

Экземпляр <xref:RedirectPolicy>

serializeObject(unknown)

Служебная функция, которая сериализует объект, который может содержать двоичные данные в обычный объект, массив или строку.

function serializeObject(toSerialize: unknown): any

Параметры

toSerialize: unknown

Возвращаемое значение

any

signingPolicy(ServiceClientCredentials)

Создает политику, которая подписывает исходящие запросы путем вызова предоставленного метода authenticationProvidersignRequest.

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Параметры

authenticationProvider: ServiceClientCredentials

Поставщик проверки подлинности.

Возвращаемое значение

RequestPolicyFactory

Экземпляр <xref:SigningPolicy>.

stringifyXML(unknown, SerializerOptions)

Преобразует заданный объект JSON в XML-строку

function stringifyXML(obj: unknown, opts?: SerializerOptions): string

Параметры

obj: unknown

Объект JSON для преобразования в XML-строку

opts: SerializerOptions

Параметры, управляющие анализом заданного объекта JSON

Возвращаемое значение

string

stripRequest(WebResourceLike)

Возвращает отрезаную версию http-запроса, которая не содержит заголовок авторизации.

function stripRequest(request: WebResourceLike): WebResourceLike

Параметры

request: WebResourceLike

Объект Http Request

Возвращаемое значение

WebResourceLike

Отрезаемая версия http-запроса.

stripResponse(HttpOperationResponse)

Возвращает отрезаную версию http-ответа, которая содержит только текст, заголовки и состояние.

function stripResponse(response: HttpOperationResponse): any

Параметры

response: HttpOperationResponse

Http-ответ

Возвращаемое значение

any

Отрезаная версия http-ответа.

systemErrorRetryPolicy(number, number, number, number)

Политика, которая повторяется при возникновении системной ошибки, определяемой кодами ETIMEDOUT, ESOCKETTIMEDOUT, ECONNREFUSED, ECONNRESET или ENOENT.

function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory

Параметры

retryCount: number

Максимальное количество повторных попыток.

retryInterval: number

Интервал повтора клиента в миллисекундах.

minRetryInterval: number

Минимальный интервал повтора в миллисекундах.

maxRetryInterval: number

Максимальный интервал повтора в миллисекундах.

Возвращаемое значение

RequestPolicyFactory

Экземпляр <xref:SystemErrorRetryPolicy>

throttlingRetryPolicy()

Создает политику, которая повторно отправляет запрос, если ответ указывает на сбой запроса из-за регулирования. Например, если ответ содержит заголовок Retry-After, он повторит отправку запроса на основе значения этого заголовка.

Дополнительные сведения см. в https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits, https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits и https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors

function throttlingRetryPolicy(): RequestPolicyFactory

Возвращаемое значение

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

Создает политику, которая упаковывает исходящие запросы с диапазоном трассировки.

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

Параметры

tracingOptions: TracingPolicyOptions

Параметры трассировки.

Возвращаемое значение

RequestPolicyFactory

Экземпляр класса <xref:TracingPolicy>.

userAgentPolicy(TelemetryInfo)

Возвращает политику, которая добавляет заголовок агента пользователя в исходящие запросы на основе заданной TelemetryInfo.

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Параметры

userAgentData: TelemetryInfo

Сведения телеметрии.

Возвращаемое значение

RequestPolicyFactory

Новая <xref:UserAgentPolicy>.

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

@azure/core-http package

Классы

Интерфейсы

Псевдонимы типа

Перечисления

Функции

Сведения о функции

applyMixins(unknown, any[])

Параметры

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

Параметры

Возвращаемое значение

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

Параметры

Возвращаемое значение

delay(number, DelayOptions)

Параметры

Возвращаемое значение

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Параметры

Возвращаемое значение

deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)

Параметры

Возвращаемое значение

disableResponseDecompressionPolicy()

Возвращаемое значение

encodeUri(string)

Параметры

Возвращаемое значение

executePromisesSequentially(any[], unknown)

Параметры

Возвращаемое значение

exponentialRetryPolicy(number, number, number)

Параметры

Возвращаемое значение

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

Параметры

Возвращаемое значение

generateClientRequestIdPolicy(string)

Параметры

Возвращаемое значение

generateUuid()

Возвращаемое значение

getDefaultProxySettings(string)

Параметры

Возвращаемое значение

getDefaultUserAgentValue()

Возвращаемое значение

isDuration(string)

Параметры

Возвращаемое значение

isTokenCredential(unknown)

Параметры

Возвращаемое значение

isValidUuid(string)

Параметры

Возвращаемое значение

keepAlivePolicy(KeepAliveOptions)

Параметры

Возвращаемое значение

logPolicy(LogPolicyOptions)

Параметры

Возвращаемое значение

operationOptionsToRequestOptionsBase<T>(T)

Параметры

Возвращаемое значение

parseXML(string, SerializerOptions)

Параметры

Возвращаемое значение

promiseToCallback(Promise<any>)

Параметры

Возвращаемое значение

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Параметры

Возвращаемое значение

proxyPolicy(ProxySettings, { customNoProxyList?: string[] })

Параметры

Возвращаемое значение

redirectPolicy(number)