@azure/ms-rest-js package
Классы
| ApiKeyCredentials |
Выполняет проверку подлинности в службе с помощью ключа API. |
| AzureIdentityCredentialAdapter |
Этот класс предоставляет простое расширение для использования <xref:TokenCredential> из |
| BaseRequestPolicy | |
| BasicAuthenticationCredentials | |
| DefaultHttpClient | |
| DomainCredentials |
Выполняет проверку подлинности в службе с помощью ключа API. |
| HttpHeaders |
Коллекция пар "ключ-значение" заголовка HTTP. |
| RequestPolicyOptions |
Необязательные свойства, которые можно использовать при создании RequestPolicy. |
| RestError | |
| Serializer | |
| ServiceClient | |
| TokenCredentials |
Объект учетных данных, использующий строку маркера и схему авторизации для проверки подлинности. |
| TopicCredentials |
Выполняет проверку подлинности в службе с помощью ключа API. |
| URLBuilder |
Класс, обрабатывающий создание, изменение и анализ URL-адресов. |
| URLQuery |
Класс, обрабатывающий часть запроса URLBuilder. |
| WebResource |
Создает новый объект WebResource. Этот класс обеспечивает абстракцию по вызову REST, будучи не зависящим от библиотеки или реализации и упаковав необходимые свойства для инициации запроса. |
Интерфейсы
| AbortSignalLike |
Позволяет прервать запрос при срабатывании события abort. Совместима со встроенным браузером AbortSignal и распространенными полизаполнениями. |
| AgentSettings |
Агенты HTTP и HTTPS (только Node.js) |
| ApiKeyCredentialOptions | |
| BaseMapper | |
| CompositeMapper | |
| CompositeMapperType | |
| DeserializationContentTypes |
Типы содержимого, которые указывают на то, что ответ операции должен быть десериализован определенным образом. |
| DictionaryMapper | |
| DictionaryMapperType | |
| EnumMapper | |
| EnumMapperType | |
| HttpClient |
Интерфейс, который может отправлять запросы HttpRequest и получать обещанные httpResponses. |
| HttpHeader |
Отдельный заголовок в коллекции HttpHeaders. |
| HttpHeadersLike |
Коллекция пар "ключ-значение" заголовка HTTP. |
| HttpOperationResponse |
Объект-оболочка для HTTP-запроса и ответа. Десериализованный объект хранится в свойстве |
| HttpPipelineLogger |
Средство ведения журнала, которое можно добавить в HttpPipeline. Это позволяет каждому объекту RequestPolicy регистрировать сообщения, которые можно использовать для отладки. |
| HttpResponse |
Свойства в HTTP-ответе, который будет присутствовать всегда. |
| MapperConstraints | |
| OperationArguments |
Коллекция свойств, которые применяются к одному вызову операции. |
| OperationParameter |
Общий интерфейс, который расширяет все параметры Operation. |
| OperationQueryParameter |
Параметр для операции, которая будет добавлена в http-запрос операции в качестве параметра запроса. |
| OperationResponse |
OperationResponse, который может быть возвращен из запроса операции для одного кода состояния. |
| OperationSpec |
Спецификация, определяющая операцию. |
| OperationURLParameter |
Параметр для операции, которая будет заменена в URL-адрес запроса операции. |
| ParameterValue |
Значение параметра, указанное для параметров пути или запроса в requestPrepareOptions |
| PolymorphicDiscriminator | |
| ProxySettings |
Параметры прокси-сервера HTTP (только Node.js) |
| RedirectOptions |
Параметры обработки ответов перенаправления. |
| RequestOptionsBase |
Описывает базовую структуру объекта options, который будет использоваться в каждой операции. |
| RequestPolicy | |
| RequestPolicyOptionsLike |
Необязательные свойства, которые можно использовать при создании RequestPolicy. |
| RequestPrepareOptions | |
| RestResponse |
Плоский ответ на вызов REST. Содержит базовые свойства HttpOperationResponse, а также объединенные свойства parsedBody, parsedHeaders и т. д. |
| SequenceMapper | |
| SequenceMapperType | |
| ServiceCallback | |
| ServiceClientCredentials | |
| ServiceClientOptions |
Параметры, предоставляемые при создании клиента. |
| SimpleMapperType | |
| TokenResponse |
TokenResponse определен в |
| 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)
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactoryПараметры
- agentSettings
- AgentSettings
Возвращаемое значение
applyMixins(any, any[])
Применяет свойства прототипа sourceCtors к прототипу targetCtor
function applyMixins(targetCtor: any, sourceCtors: any[])Параметры
- targetCtor
-
any
Целевой объект, к которому необходимо применить свойства.
- sourceCtors
-
any[]
Массив исходных объектов, из которых необходимо взять свойства.
delay<T>(number, T)
Оболочка для setTimeout, которая разрешает обещание после t миллисекунда.
function delay<T>(t: number, value?: T): Promise<T>Параметры
- t
-
number
Число миллисекундах для задержки.
- value
-
T
Значение, с которым необходимо разрешить по истечении времени ожидания t миллисекунда.
Возвращаемое значение
Promise<T>
Обещание решено
deserializationPolicy(DeserializationContentTypes)
Создайте новый объект сериализации RequestPolicyCreator, который будет сериализовать тела HTTP-запросов по мере их прохождения через конвейер HTTP.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactoryПараметры
- deserializationContentTypes
- DeserializationContentTypes
Возвращаемое значение
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
Возвращаемое значение
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponseПараметры
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
Возвращаемое значение
generateClientRequestIdPolicy(string)
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactoryПараметры
- requestIdHeaderName
-
string
Возвращаемое значение
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
Возвращаемое значение
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
Возвращаемое значение
redirectPolicy(number)
function redirectPolicy(maximumRetries?: number): RequestPolicyFactoryПараметры
- maximumRetries
-
number
Возвращаемое значение
serializeObject(any)
function serializeObject(toSerialize: any): anyПараметры
- toSerialize
-
any
Возвращаемое значение
any
signingPolicy(ServiceClientCredentials)
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactoryПараметры
- authenticationProvider
- ServiceClientCredentials
Возвращаемое значение
stripRequest(WebResourceLike)
Возвращает удаленную версию HTTP-запроса, которая не содержит заголовок Authorization.
function stripRequest(request: WebResourceLike): WebResourceLikeПараметры
- request
- WebResourceLike
Объект HTTP-запроса
Возвращаемое значение
Удаленная версия 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
Возвращаемое значение
throttlingRetryPolicy(number)
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactoryПараметры
- maxRetries
-
number
Возвращаемое значение
userAgentPolicy(TelemetryInfo)
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactoryПараметры
- userAgentData
- TelemetryInfo