@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	Позволяет прервать запрос при срабатывании события abort. Совместима со встроенным браузером AbortSignal и распространенными полизаполнениями.
AccessToken	Представляет маркер доступа со временем окончания срока действия.
AccessTokenCache	Предоставляет кэш для AccessToken, который был возвращен из TokenCredential.
ApiKeyCredentialOptions	Описание параметров, предоставляемых при создании экземпляра ApiKeyCredentials.
BaseMapper	Базовое определение модуля сопоставления. Может использоваться для xml-объектов и простых объектов JavaScript.
CompositeMapper	Сопоставителя, состоящий из других модулей сопоставления.
CompositeMapperType	Помогает создать сопоставителя, который описывает, как сопоставить набор свойств объекта на основе других модулей сопоставления. Должно присутствовать только одно из следующих свойств: `className`, `modelProperties` и `additionalProperties`.
DeserializationContentTypes	Типы содержимого, которые указывают на то, что ответ операции должен быть десериализован определенным образом.
DeserializationOptions	Параметры для настройки десериализации ответа API.
DictionaryMapper	Метод сопоставления, описывающий обычные объекты JavaScript, используемые в качестве пар "ключ-значение".
DictionaryMapperType	Помогает создать средство сопоставления, описывающее, как анализировать словарь сопоставленных значений.
EnumMapper	Сопоставительная схема, описывающая значение перечисления.
EnumMapperType	Помогает создать средство сопоставления, описывающее, как анализировать значение перечисления.
GetTokenOptions	Определяет параметры для TokenCredential.getToken.
HttpClient	Интерфейс, который может отправлять запросы HttpRequest и получать обещанные httpResponses.
HttpHeader	Отдельный заголовок в коллекции HttpHeaders.
HttpHeadersLike	Коллекция пар "ключ-значение" заголовка HTTP.
HttpOperationResponse	Объект-оболочка для HTTP-запроса и ответа. Десериализованный объект хранится в свойстве `parsedBody` при получении текста ответа в ФОРМАТЕ JSON или XML.
HttpPipelineLogger	Средство ведения журнала, которое можно добавить в HttpPipeline. Это позволяет каждому объекту RequestPolicy регистрировать сообщения, которые можно использовать для отладки.
HttpResponse	Свойства в HTTP-ответе, который будет присутствовать всегда.
InternalPipelineOptions	Определяет параметры, используемые для настройки внутренних параметров конвейера HTTP для клиента пакета SDK.
KeepAliveOptions	Параметры поддержки HTTP-подключений для будущих запросов.
LogPolicyOptions	Параметры для передачи в logPolicy. По умолчанию регистрируются только наборы заголовков, хотя это можно настроить. Тексты запросов и ответов никогда не регистрируются.
MapperConstraints	Описание различных ограничений значений, таких как диапазоны целых чисел и строковое регулярное выражение.
OperationArguments	Коллекция свойств, которые применяются к одному вызову операции.
OperationOptions	Базовый тип параметров для всех операций.
OperationParameter	Общий интерфейс, который расширяет все параметры Operation.
OperationQueryParameter	Параметр для операции, которая будет добавлена в HTTP-запрос операции в качестве параметра запроса.
OperationRequestOptions	Параметры, позволяющие настроить обработку HTTP-запросов, выполняемых операцией пакета SDK.
OperationResponse	OperationResponse, который может быть возвращен из запроса операции для одного кода состояния.
OperationSpec	Спецификация, которая определяет, как выполнять определенную операцию службы по протоколу HTTP, в том числе как правильно сериализовать сведения о запросе в и десериализовать данные ответа в полезные данные объекта, возвращаемые ServiceClient.
OperationURLParameter	Параметр для операции, который будет заменен в URL-адрес запроса операции.
ParameterValue	Значение параметра, указанное для параметров пути или запроса в RequestPrepareOptions
PipelineOptions	Определяет параметры, используемые для настройки конвейера HTTP для клиента ПАКЕТА SDK.
PolymorphicDiscriminator	Используется для устранения неоднозначности дискриминированных типов союзов. Например, если ответ может содержать много фигур, но также содержит поле kind (или аналогичное), это поле можно использовать для определения способа десериализации ответа на правильный тип.
ProxySettings	Параметры настройки прокси-сервера для исходящих запросов (только Node.js).
RedirectOptions	Параметры обработки ответов перенаправления.
RequestOptionsBase	Описывает базовую структуру объекта options, который будет использоваться в каждой операции.
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	Модули сопоставления — это определения моделей данных, используемых в библиотеке. Эти модели данных являются частью определений операции или клиента в ответах или параметрах.
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, разрешающая обещание по истечении миллисекунда.
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>)	Преобразует объект Promise в обратный вызов.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	Преобразует объект Promise в обратный вызов службы.
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-запроса, которая не содержит заголовок Authorization.
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, разрешающая обещание по истечении миллисекунда.

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

UUID RFC4122 версии 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

Преобразует объект Promise в обратный вызов.

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

Параметры

promise: Promise<any>

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

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

(cb: Function) => void

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Преобразует объект Promise в обратный вызов службы.

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-запроса, которая не содержит заголовок Authorization.

function stripRequest(request: WebResourceLike): WebResourceLike

Параметры

request: WebResourceLike

Объект HTTP-запроса

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

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)