@azure/core-client package

Классы

ServiceClient

Инициализирует новый экземпляр ServiceClient.

Интерфейсы

AdditionalPolicyConfig

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

BaseMapper

Базовое определение модуля сопоставления. Может использоваться для xml-объектов и простых объектов JavaScript.

CommonClientOptions

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

CompositeMapper

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

CompositeMapperType

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

Должно присутствовать только одно из следующих свойств: className, modelProperties и additionalProperties.

DeserializationContentTypes

Типы содержимого, которые указывают на то, что ответ операции должен быть десериализован определенным образом.

DeserializationPolicyOptions

Параметры для настройки десериализации ответа API.

DictionaryMapper

Метод сопоставления, описывающий обычные объекты JavaScript, используемые в качестве пар "ключ-значение".

DictionaryMapperType

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

EnumMapper

Сопоставительная схема, описывающая значение перечисления.

EnumMapperType

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

FullOperationResponse

Объект-оболочка для HTTP-запроса и ответа. Десериализованный объект хранится в свойстве parsedBody при получении текста ответа в ФОРМАТЕ JSON или XML.

InternalClientPipelineOptions

Параметры создания конвейера для использования с ServiceClient. В основном для настройки политики проверки подлинности (при использовании проверки подлинности маркера) или параметров десериализации при использовании XML.

MapperConstraints

Описание различных ограничений значений, таких как диапазоны целых чисел и строковое регулярное выражение.

OperationArguments

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

OperationOptions

Базовый тип параметров для всех операций.

OperationParameter

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

OperationQueryParameter

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

OperationRequestInfo

Метаданные, используемые для правильного анализа ответа.

OperationRequestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

OperationResponseMap

OperationResponse, который может быть возвращен из запроса операции для одного кода состояния.

OperationSpec

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

OperationURLParameter

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

PolymorphicDiscriminator

Используется для устранения неоднозначности дискриминированных союзов типов. Например, если ответ может содержать много фигур, но также содержит поле kind (или аналогичное), это поле можно использовать для определения способа десериализации ответа до правильного типа.

SequenceMapper

Сопоставителя, описывающий массивы.

SequenceMapperType

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

SerializationPolicyOptions

Параметры для настройки сериализации запросов API.

Serializer

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

SerializerOptions

Параметры для настройки поведения сериализации и десериализации.

ServiceClientOptions

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

SimpleMapperType

Тип простого модуля сопоставления.

SpanConfig

Конфигурация для создания нового диапазона трассировки

XmlOptions

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

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

Mapper

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

MapperType

Тип модуля сопоставления. Включает известные модули сопоставления.

OperationRequest

Псевдоним типа для будущей проверки правописания.

ParameterPath

Кодирует способ достижения определенного свойства в объекте .

QueryCollectionFormat

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

RawResponseCallback

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

Функции

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Эту функцию можно использовать в качестве обратного @azure/core-rest-pipelineвызова для bearerTokenAuthenticationPolicy , для поддержки задач CAE: Непрерывная оценка доступа.

Вызовите с bearerTokenAuthenticationPolicy помощью следующих параметров:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

После предоставления bearerTokenAuthenticationPolicy политики будут обрабатываться внутренние запросы непрерывной оценки доступа (CAE). Если не удается выполнить запрос, он вернет ответ 401 (несанкционированный) от ARM.

Пример запроса с утверждениями:

Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Определяет обратный вызов для обработки запроса проверки подлинности для API службы хранилища. При этом реализуется процесс запроса носителя, описанный здесь: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Обработка имеет специальные функции для хранилища, которые относятся к общей документации по задачам AAD.

createClientPipeline(InternalClientPipelineOptions)

Создает новый конвейер для использования с клиентом службы. Добавляет десериализациюPolicy по умолчанию. Также добавляет в bearerTokenAuthenticationPolicy, если передано tokenCredential.

createSerializer({[key: string]: any}, boolean)

Метод, который создает и возвращает сериализатор.

deserializationPolicy(DeserializationPolicyOptions)

Эта политика обрабатывает синтаксический анализ ответов в соответствии с OperationSpecs в запросе.

serializationPolicy(SerializationPolicyOptions)

Эта политика обрабатывает сборку текста запроса и заголовков с помощью OperationSpec и OperationArguments в запросе.

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

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Эту функцию можно использовать в качестве обратного @azure/core-rest-pipelineвызова для bearerTokenAuthenticationPolicy , для поддержки задач CAE: Непрерывная оценка доступа.

Вызовите с bearerTokenAuthenticationPolicy помощью следующих параметров:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

После предоставления bearerTokenAuthenticationPolicy политики будут обрабатываться внутренние запросы непрерывной оценки доступа (CAE). Если не удается выполнить запрос, он вернет ответ 401 (несанкционированный) от ARM.

Пример запроса с утверждениями:

Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Параметры

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

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Определяет обратный вызов для обработки запроса проверки подлинности для API службы хранилища. При этом реализуется процесс запроса носителя, описанный здесь: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Обработка имеет специальные функции для хранилища, которые относятся к общей документации по задачам AAD.

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Параметры

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

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Создает новый конвейер для использования с клиентом службы. Добавляет десериализациюPolicy по умолчанию. Также добавляет в bearerTokenAuthenticationPolicy, если передано tokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Параметры

options
InternalClientPipelineOptions

Параметры для настройки созданного конвейера.

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

createSerializer({[key: string]: any}, boolean)

Метод, который создает и возвращает сериализатор.

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

Параметры

modelMappers

{[key: string]: any}

Известные модели для сопоставления

isXML

boolean

Если xml-код должен поддерживаться

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

deserializationPolicy(DeserializationPolicyOptions)

Эта политика обрабатывает синтаксический анализ ответов в соответствии с OperationSpecs в запросе.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Параметры

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

serializationPolicy(SerializationPolicyOptions)

Эта политика обрабатывает сборку текста запроса и заголовков с помощью OperationSpec и OperationArguments в запросе.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Параметры

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