@azure-rest/core-client package

Interfejsy

AddCredentialPipelinePolicyOptions	Opcjonalne parametry dodawania zasad poświadczeń do potoku.
AdditionalPolicyConfig	Służy do konfigurowania dodatkowych zasad dodanych do potoku podczas budowy.
Client	Kształt klienta na poziomie rest
ErrorModel	Obiekt błędu.
ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
FullOperationResponse	Obiekt otoki dla żądania http i odpowiedzi. Deserializowany obiekt jest przechowywany we właściwości po odebraniu parsedBody treści odpowiedzi w formacie JSON.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions	Typ opcji podstawowych dla wszystkich operacji.
OperationRequestOptions	Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
ResourceMethods	Definiuje metody, które mogą być wywoływane w zasobie

Aliasy typu

ClientOptions	Opcje ogólne, które może przyjmować klient poziomu rest
HttpBrowserStreamResponse	Odpowiedź HTTP, która treść jest obiektem strumienia NodeJS
HttpNodeStreamResponse	Odpowiedź HTTP, która treść jest obiektem strumienia NodeJS
HttpResponse	Reprezentuje kształt obiektu HttpResponse
PathParameters	Typ pomocnika używany do wykrywania parametrów w tekście szablonu ścieżki otoczony {} przez element będzie traktowany jako parametr ścieżki
PathUnchecked	Definiuje podpis dla pathUnchecked.
PathUncheckedResponse	Typ, który ma być używany z parametrem pathUnchecked, zastępuje typ treści dowolną, aby umożliwić elastyczność
RawResponseCallback	Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
RequestParameters	Kształt domyślnych parametrów żądania może zostać zastąpiony przez określone typy żądań w celu zapewnienia silnych typów
StreamableMethod	Definiuje typ metody, która obsługuje pobieranie treści odpowiedzi jako nieprzetworzonego strumienia

Funkcje

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	Dodaje zasady poświadczeń do potoku, jeśli podano poświadczenia. Jeśli żadna z nich nie zostanie podana, żadne zasady nie zostaną dodane.
createRestError(PathUncheckedResponse)	Tworzy błąd rest z odpowiedzi PathUnchecked
createRestError(string, PathUncheckedResponse)	Tworzy błąd rest z komunikatu o błędzie i odpowiedzi PathUnchecked
getClient(string, ClientOptions)	Tworzy klienta z domyślnym potokiem
getClient(string, TokenCredential | KeyCredential, ClientOptions)	Tworzy klienta z domyślnym potokiem
operationOptionsToRequestParameters(OperationOptions)	Funkcja pomocnika, aby przekonwertować operacje OperationOptions na RequestParameters

Szczegóły funkcji

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Dodaje zasady poświadczeń do potoku, jeśli podano poświadczenia. Jeśli żadna z nich nie zostanie podana, żadne zasady nie zostaną dodane.

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

Parametry

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Tworzy błąd rest z odpowiedzi PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parametry

response

PathUncheckedResponse

Zwraca

RestError

createRestError(string, PathUncheckedResponse)

Tworzy błąd rest z komunikatu o błędzie i odpowiedzi PathUnchecked

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

Parametry

message

string

response

PathUncheckedResponse

Zwraca

RestError

getClient(string, ClientOptions)

Tworzy klienta z domyślnym potokiem

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

Parametry

endpoint

string

Podstawowy punkt końcowy klienta

options

ClientOptions

Opcje klienta

Zwraca

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Tworzy klienta z domyślnym potokiem

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

Parametry

endpoint

string

Podstawowy punkt końcowy klienta

credentials

TokenCredential | KeyCredential

Poświadczenia służące do uwierzytelniania żądań

options

ClientOptions

Opcje klienta

Zwraca

Client

operationOptionsToRequestParameters(OperationOptions)

Funkcja pomocnika, aby przekonwertować operacje OperationOptions na RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parametry

options

OperationOptions

opcje używane przez warstwę modułową do wysyłania żądania

Zwraca

RequestParameters

wynik konwersji w warstwie RequestParameters warstwy RLC