@azure-rest/core-client package

Интерфейсы

AddCredentialPipelinePolicyOptions	Необязательные параметры для добавления политики учетных данных в конвейер.
AdditionalPolicyConfig	Используется для настройки дополнительных политик, добавленных в конвейер во время строительства.
Client	Форма клиента уровня rest
ErrorModel	Объект ошибки.
ErrorResponse	Ответ, содержащий сведения об ошибке.
FullOperationResponse	Объект-оболочка для http-запроса и ответа. Десериализированный объект хранится в свойстве parsedBody при получении текста ответа в ФОРМАТЕ JSON.
InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions	Базовый тип параметров для всех операций.
OperationRequestOptions	Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
PathParameterWithOptions	Объект, который можно передать в качестве параметра пути, что позволяет задать дополнительные параметры, связанные с кодированием параметра.
ResourceMethods	Определяет методы, которые можно вызывать в ресурсе

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

ClientOptions	Общие параметры, которые может принимать клиент уровня REST
HttpBrowserStreamResponse	Http Response, текст которого является объектом потока NodeJS
HttpNodeStreamResponse	Http Response, текст которого является объектом потока NodeJS
HttpResponse	Представляет форму HttpResponse
PathParameters	Вспомогательный тип, используемый для обнаружения параметров в тексте шаблона пути, окруженном {}, будет считаться параметром пути
PathUnchecked	Определяет подпись для pathUnchecked.
PathUncheckedResponse	Тип, используемый с pathUnchecked, переопределяет тип текста на любой, чтобы обеспечить гибкость
RawResponseCallback	Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. Этот обратный вызов будет вызываться с двумя параметрами: необработанный ответ, включая заголовки и текст ответа; и объект ошибки, который будет предоставлен, если при обработке запроса возникла ошибка. Третий параметр __legacyError предоставляется только для обратной совместимости и будет иметь идентичное значение error параметру.
RequestParameters	Форма параметров запроса по умолчанию, это может быть переопределено определенными типами запросов для предоставления надежных типов.
StreamableMethod	Определяет тип метода, поддерживающего получение текста ответа в виде необработанного потока.

Функции

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	Добавляет политику учетных данных в конвейер, если указаны учетные данные. Если параметр не указан, политика не добавляется.
createRestError(PathUncheckedResponse)	Создает ошибку rest из ответа PathUnchecked
createRestError(string, PathUncheckedResponse)	Создает ошибку rest из сообщения об ошибке и ответа PathUnchecked
getClient(string, ClientOptions)	Создает клиент с конвейером по умолчанию
getClient(string, TokenCredential | KeyCredential, ClientOptions)	Создает клиент с конвейером по умолчанию
operationOptionsToRequestParameters(OperationOptions)	Вспомогательные функции для преобразования OperationOptions в RequestParameters

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

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

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

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

Параметры

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Создает ошибку rest из ответа PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Параметры

response

PathUncheckedResponse

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

RestError

createRestError(string, PathUncheckedResponse)

Создает ошибку rest из сообщения об ошибке и ответа PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

Параметры

message

string

response

PathUncheckedResponse

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

RestError

getClient(string, ClientOptions)

Создает клиент с конвейером по умолчанию

function getClient(endpoint: string, options?: ClientOptions): Client

Параметры

endpoint

string

Базовая конечная точка для клиента

options

ClientOptions

Параметры клиента

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

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Создает клиент с конвейером по умолчанию

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

Параметры

endpoint

string

Базовая конечная точка для клиента

credentials

TokenCredential | KeyCredential

Учетные данные для проверки подлинности запросов

options

ClientOptions

Параметры клиента

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

Client

operationOptionsToRequestParameters(OperationOptions)

Вспомогательные функции для преобразования OperationOptions в RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Параметры

options

OperationOptions

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

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

RequestParameters

Результат преобразования в RequestParameters слоя RLC