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

@azure/ms-rest-js package

  • Ссылка

Классы

ApiKeyCredentials

Выполняет проверку подлинности в службе с помощью ключа API.
AzureIdentityCredentialAdapter

Этот класс предоставляет простое расширение для использования <xref:TokenCredential> из библиотеки @azure/identity для использования с устаревшими пакетами SDK Azure, которые принимают ServiceClientCredentials семейство учетных данных для проверки подлинности.
BaseRequestPolicy
BasicAuthenticationCredentials
DefaultHttpClient
DomainCredentials

Выполняет проверку подлинности в службе с помощью ключа API.
HttpHeaders

Коллекция пар ключей и значений заголовка HTTP.
RequestPolicyOptions

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

Объект учетных данных, использующий строку маркера и схему создания для проверки подлинности.
TopicCredentials

Выполняет проверку подлинности в службе с помощью ключа API.
URLBuilder

Класс, обрабатывающий создание, изменение и анализ URL-адресов.
URLQuery

Класс, обрабатывающий часть запроса URLBuilder.
WebResource

Создает новый объект WebResource.

Этот класс предоставляет абстракцию по вызову REST, будучи библиотекой или реализацией неактивным и упаковав необходимые свойства для запуска запроса.

Интерфейсы

AbortSignalLike

Позволяет прервать запрос при срабатывании события прерывания. Совместим с встроенным браузером AbortSignal и общими полизаполнениями.
AgentSettings

Агенты HTTP и HTTPS (толькоNode.js)
ApiKeyCredentialOptions
BaseMapper
CompositeMapper
CompositeMapperType
DeserializationContentTypes

Типы контента, указывающие, что ответ операции должен быть десериализирован определенным образом.
DictionaryMapper
DictionaryMapperType
EnumMapper
EnumMapperType
HttpClient

Интерфейс, который может отправлять httpRequests и получать обещанные httpResponses.
HttpHeader

Отдельный заголовок в коллекции HttpHeaders.
HttpHeadersLike

Коллекция пар ключей и значений заголовка HTTP.
HttpOperationResponse

Объект-оболочка для http-запроса и ответа. Десериализированный объект хранится в свойстве parsedBody при получении текста ответа в формате JSON или XML.
HttpPipelineLogger

Средство ведения журнала, которое можно добавить в httpPipeline. Это позволяет каждому requestPolicy регистрировать сообщения, которые можно использовать для отладки.
HttpResponse

Свойства http-ответа, который всегда будет присутствовать.
MapperConstraints
OperationArguments

Коллекция свойств, которые применяются к одному вызову операции.
OperationParameter

Общий интерфейс, расширяющий все параметры операции.
OperationQueryParameter

Параметр для операции, которая будет добавлена в качестве параметра запроса в HTTP-запрос операции.
OperationResponse

ОперацияResponse, которую можно вернуть из запроса операции для одного кода состояния.
OperationSpec

Спецификация, определяющая операцию.
OperationURLParameter

Параметр для операции, которая будет заменена URL-адресом запроса операции.
ParameterValue

Значение параметра, предоставленное для параметров пути или запроса в RequestPrepareOptions
PolymorphicDiscriminator
ProxySettings

Параметры прокси-сервера HTTP (толькоNode.js)
RedirectOptions

Параметры обработки ответов перенаправления.
RequestOptionsBase

Описывает базовую структуру объекта параметров, который будет использоваться в каждой операции.
RequestPolicy
RequestPolicyOptionsLike

Необязательные свойства, которые можно использовать при создании RequestPolicy.
RequestPrepareOptions
RestResponse

Неструктурированный ответ на вызов REST. Содержит базовые свойства HttpOperationResponse, а также объединенные свойства синтаксического анализаBody, синтаксического анализа и т. д.
SequenceMapper
SequenceMapperType
ServiceCallback
ServiceClientCredentials
ServiceClientOptions

Параметры, предоставляемые при создании клиента.
SimpleMapperType
TokenResponse

TokenResponse определен в @azure/ms-rest-nodeauth и копируется здесь, чтобы не добавить ненужную зависимость.
UrlParameterValue
WebResourceLike

Абстракция по вызову REST.

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

Authenticator
CommonRequestInfo
CommonRequestInit
CommonResponse
HttpMethods
HttpRequestBody
Mapper
MapperType
ParameterPath
RawHttpHeaders

Коллекция HttpHeaders, представленная как простой объект JSON.
RequestPolicyFactory

Создает новый запрос RequestPolicy для каждого запроса, использующего предоставленный nextPolicy.
TelemetryInfo
TransferProgressEvent

Активируется в ответ на ход отправки или скачивания.

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

HttpPipelineLogLevel

Различные уровни журналов, которые можно использовать с httpPipelineLogger.
QueryCollectionFormat

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

Функции

agentPolicy(AgentSettings)
applyMixins(any, any[])

Применяет свойства к прототипу sourceCtors к прототипу targetCtor
delay<T>(number, T)

Оболочка для setTimeout, разрешающая обещание после миллисекунда.
deserializationPolicy(DeserializationContentTypes)

Создайте новую сериализацию RequestPolicyCreator, которая сериализует тела HTTP-запросов по мере передачи через конвейер HTTP.
deserializeResponseBody(string[], string[], HttpOperationResponse)
encodeUri(string)

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

Выполняет массив обещаний последовательно. Вдохновение этого метода здесь: https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. Удивительный блог о обещаниях!
exponentialRetryPolicy(number, number, number, number)
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
generateClientRequestIdPolicy(string)
generateUuid()

Созданный UUID
getDefaultProxySettings(string)
getDefaultUserAgentValue()
isDuration(string)

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

Проверяет заданный uuid как строку
logPolicy(any)
promiseToCallback(Promise<any>)

Преобразует обещание в обратный вызов.
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

Преобразует обещание в обратный вызов службы.
proxyPolicy(ProxySettings)
redirectPolicy(number)
serializeObject(any)
signingPolicy(ServiceClientCredentials)
stripRequest(WebResourceLike)

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

Возвращает отрезаную версию http-ответа, которая содержит только текст, заголовки и состояние.
systemErrorRetryPolicy(number, number, number, number)
throttlingRetryPolicy(number)
userAgentPolicy(TelemetryInfo)

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

agentPolicy(AgentSettings) 

function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory

Параметры

agentSettings
AgentSettings

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

RequestPolicyFactory

applyMixins(any, any[])

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

function applyMixins(targetCtor: any, sourceCtors: any[])

Параметры

targetCtor

any

Целевой объект, к которому необходимо применить свойства.

sourceCtors

any[]

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

delay<T>(number, T)

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

function delay<T>(t: number, value?: T): Promise<T>

Параметры

t

number

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

value

T

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

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

Promise<T>

Разрешенное обещание

deserializationPolicy(DeserializationContentTypes)

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

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory

Параметры

deserializationContentTypes
DeserializationContentTypes

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

RequestPolicyFactory

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

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

Параметры

jsonContentTypes

string[]

xmlContentTypes

string[]

response
HttpOperationResponse

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

Promise<HttpOperationResponse>

encodeUri(string)

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

function encodeUri(uri: string): string

Параметры

uri

string

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

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

string

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

executePromisesSequentially(any[], any)

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

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

Параметры

promiseFactories

any[]

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

kickstart

any

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

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

Promise<any>

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

exponentialRetryPolicy(number, number, number, number) 

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

Параметры

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

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

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse) 

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

Параметры

_response
HttpOperationResponse
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) 

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

Параметры

proxyUrl

string

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

ProxySettings | undefined

getDefaultUserAgentValue() 

function getDefaultUserAgentValue(): string

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

string

isDuration(string)

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

function isDuration(value: string): boolean

Параметры

value

string

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

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

boolean

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

isValidUuid(string)

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

function isValidUuid(uuid: string): boolean

Параметры

uuid

string

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

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

boolean

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

logPolicy(any) 

function logPolicy(logger?: any): RequestPolicyFactory

Параметры

logger

any

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

RequestPolicyFactory

promiseToCallback(Promise<any>)

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

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

generated code should instead depend on responseToBody

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

function promiseToCallback(promise: Promise<any>): Function

Параметры

promise

Promise<any>

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

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

Function

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

promiseToServiceCallback<T>(Promise<HttpOperationResponse>)

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

function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function

Параметры

promise

Promise<HttpOperationResponse>

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

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

Function

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

proxyPolicy(ProxySettings) 

function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory

Параметры

proxySettings
ProxySettings

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

RequestPolicyFactory

redirectPolicy(number) 

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

Параметры

maximumRetries

number

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

RequestPolicyFactory

serializeObject(any) 

function serializeObject(toSerialize: any): any

Параметры

toSerialize

any

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

any

signingPolicy(ServiceClientCredentials) 

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

Параметры

authenticationProvider
ServiceClientCredentials

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

RequestPolicyFactory

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) 

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

Параметры

retryCount

number

retryInterval

number

minRetryInterval

number

maxRetryInterval

number

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

RequestPolicyFactory

throttlingRetryPolicy(number) 

function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory

Параметры

maxRetries

number

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

RequestPolicyFactory

userAgentPolicy(TelemetryInfo) 

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

Параметры

userAgentData
TelemetryInfo

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

RequestPolicyFactory