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

@azure/core-client package

  • Ссылка

Классы

ServiceClient

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

Интерфейсы

AdditionalPolicyConfig

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

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

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

Mapper, состоящий из других карт.
CompositeMapperType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Схема, описывающая массивы.
SequenceMapperType

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

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

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

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

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

Тип простого сопоставителя.
SpanConfig

Настройка для создания нового диапазона трассировки
XmlOptions

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

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

Mapper

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

Тип сопоставителя. Включает известные карты.
OperationRequest

Псевдоним типа для дальнейшего проверки правописания.
ParameterPath

Кодирует, как достичь определенного свойства в объекте.
QueryCollectionFormat

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

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

Функции

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

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

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

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

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

После предоставления политика 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://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Обработка имеет определенные функции для хранения, которое отправляется в общие документы по задачам AAD.
createClientPipeline(InternalClientPipelineOptions)

Создает новый конвейер для использования с клиентом службы. Добавляется в десериализациюPolicy по умолчанию. Также добавляется в bearerTokenAuthenticationPolicy, если передан токенCredential.
createSerializer({[key: string]: any}, boolean)

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

Эта политика обрабатывает анализ ответов в соответствии с OperationSpecs в запросе.
serializationPolicy(SerializationPolicyOptions)

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

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

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

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

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

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

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

После предоставления политика 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>

Параметры

onChallengeOptions
AuthorizeRequestOnChallengeOptions

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

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

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

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

Параметры

challengeOptions
AuthorizeRequestOnChallengeOptions

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

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

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

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Параметры

options
InternalClientPipelineOptions

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

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

Pipeline

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

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

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

Параметры

modelMappers

{[key: string]: any}

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

isXML

boolean

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

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

Serializer

deserializationPolicy(DeserializationPolicyOptions)

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

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Параметры

options
DeserializationPolicyOptions

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

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

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

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Параметры

options
SerializationPolicyOptions

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

PipelinePolicy