Sdílet prostřednictvím


@azure-rest/core-client package

Rozhraní

AddCredentialPipelinePolicyOptions

Volitelné parametry pro přidání zásady přihlašovacích údajů do kanálu

AdditionalPolicyConfig

Slouží ke konfiguraci dalších zásad přidaných do kanálu při vytváření.

Client

Tvar klienta úrovně rest

ErrorModel

Objekt chyby.

ErrorResponse

Odpověď obsahující podrobnosti o chybě.

FullOperationResponse

Objekt obálky pro požadavek HTTP a odpověď. Deserializovaný objekt je uložen v parsedBody vlastnost při přijetí textu odpovědi ve formátu JSON.

InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

OperationOptions

Základní typ možností pro všechny operace.

OperationRequestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

PathParameterWithOptions

Objekt, který lze předat jako parametr cesty, což umožňuje nastavit další možnosti týkající se kódování parametru.

ResourceMethods

Definuje metody, které lze volat u prostředku.

Aliasy typu

ClientOptions

Obecné možnosti, které může klient na úrovni rest převzít

HttpBrowserStreamResponse

Odpověď HTTP, což je tělo objektu streamu NodeJS

HttpNodeStreamResponse

Odpověď HTTP, což je tělo objektu streamu NodeJS

HttpResponse

Představuje tvar httpResponse.

PathParameters

Pomocný typ použitý k detekci parametrů v textu šablony cesty obklopený {} bude považován za parametr cesty.

PathUnchecked

Definuje podpis pro cestuUnchecked.

PathUncheckedResponse

Typ, který se má použít s cestouUnchecked, přepíše typ těla na libovolný, aby byla flexibilita

RawResponseCallback

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.

Tento zpětné volání bude volán se dvěma parametry: nezpracovaná odpověď, včetně hlaviček a textu odpovědi; a objekt chyby, který se zobrazí v případě, že při zpracování požadavku došlo k chybě. Třetí __legacyError parametr je k dispozici pouze pro zpětné kompatibility a bude mít stejnou hodnotu jako parametr error.

RequestParameters

Tvar výchozích parametrů požadavku, které mohou být přepsány konkrétními typy požadavků, aby poskytovaly silné typy

StreamableMethod

Definuje typ metody, která podporuje získání textu odpovědi jako nezpracovaného datového proudu.

Funkce

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Přidá do kanálu zásadu přihlašovacích údajů, pokud jsou zadané přihlašovací údaje. Pokud žádný není zadaný, nepřidá se žádná zásada.

createRestError(PathUncheckedResponse)

Vytvoří chybu rest z odpovědi PathUnchecked.

createRestError(string, PathUncheckedResponse)

Vytvoří chybu rest z chybové zprávy a odpovědi PathUnchecked.

getClient(string, ClientOptions)

Vytvoří klienta s výchozím kanálem.

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Vytvoří klienta s výchozím kanálem.

operationOptionsToRequestParameters(OperationOptions)

Pomocná funkce pro převod OperationOptions na RequestParameters

Podrobnosti funkce

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Přidá do kanálu zásadu přihlašovacích údajů, pokud jsou zadané přihlašovací údaje. Pokud žádný není zadaný, nepřidá se žádná zásada.

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

Parametry

pipeline
Pipeline
endpoint

string

createRestError(PathUncheckedResponse)

Vytvoří chybu rest z odpovědi PathUnchecked.

function createRestError(response: PathUncheckedResponse): RestError

Parametry

Návraty

createRestError(string, PathUncheckedResponse)

Vytvoří chybu rest z chybové zprávy a odpovědi PathUnchecked.

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

Parametry

message

string

Návraty

getClient(string, ClientOptions)

Vytvoří klienta s výchozím kanálem.

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

Parametry

endpoint

string

Základní koncový bod pro klienta

options
ClientOptions

Možnosti klienta

Návraty

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Vytvoří klienta s výchozím kanálem.

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

Parametry

endpoint

string

Základní koncový bod pro klienta

credentials

TokenCredential | KeyCredential

Přihlašovací údaje pro ověření požadavků

options
ClientOptions

Možnosti klienta

Návraty

operationOptionsToRequestParameters(OperationOptions)

Pomocná funkce pro převod OperationOptions na RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parametry

options
OperationOptions

možnosti, které modulární vrstva používá k odeslání požadavku

Návraty

výsledek převodu ve vrstvě RLC RequestParameters