@azure-rest/core-client package

Interfészek

AddCredentialPipelinePolicyOptions	A hitelesítőadat-szabályzatnak a folyamathoz való hozzáadásához választható paraméterek.
AdditionalPolicyConfig	A folyamathoz építéskor hozzáadott további szabályzatok konfigurálására szolgál.
Client	Rest Level Client alakzata
ErrorModel	A hibaobjektum.
ErrorResponse	Hibaadatokat tartalmazó válasz.
FullOperationResponse	Burkolóobjektum http-kéréshez és válaszhoz. A deszerializált objektum a parsedBody tulajdonságban lesz tárolva, amikor a válasz törzse JSON-ban érkezik.
InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
NodeJSReadableStream	Egy Node.js olvasható stream, amely szintén rendelkezik metódussal destroy .
OperationOptions	Az alapbeállítások típusa az összes művelethez.
OperationRequestOptions	A művelethez tartozó HTTP-kérések létrehozásakor és küldésekor használt beállítások.
PathParameterWithOptions	Útvonalparaméterként átadható objektum, amely lehetővé teszi a paraméter kódolásával kapcsolatos további beállítások megadását.
ResourceMethods	Meghatározza az erőforráson meghívható metódusokat

Típusaliasok

ClientOptions	A rest level client által használható általános beállítások
HttpBrowserStreamResponse	Http-válasz, amely a NodeJS streamobjektum törzse
HttpNodeStreamResponse	Http-válasz, amely a NodeJS streamobjektum törzse
HttpResponse	HttpResponse alakját jelöli
PathParameters	A {} által körülvett elérésiút-sablonszöveg paramétereinek észlelésére használt segédtípus elérésiút-paraméternek minősül
PathUnchecked	Meghatározza a pathUnchecked aláírását.
PathUncheckedResponse	A pathUnchecked beállítással használandó típus felülbírálja a törzstípust bármelyikre a rugalmasság érdekében
RawResponseCallback	Minden alkalommal meghívandó függvény, amikor választ kap a kiszolgálótól a kért művelet végrehajtása közben. Többször is meghívható. Ez a visszahívás két paraméterrel lesz meghívva: a nyers válasz, beleértve az élőfejeket és a válasz törzsét; és egy hibaobjektumot, amely akkor jelenik meg, ha hiba történt a kérés feldolgozása során. A harmadik __legacyError paraméter csak a visszamenőleges kompatibilitáshoz van megadva, és a error paraméterrel azonos értékkel rendelkezik.
RequestParameters	Az alapértelmezett kérelemparaméterek alakzata, ezt felülírhatják az adott kéréstípusok, hogy erős típusok legyenek
StreamableMethod	Meghatározza a válasz törzsének nyers streamként való lekérését támogató metódus típusát

Függvények

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	Hitelesítőadat-szabályzatot ad hozzá a folyamathoz, ha meg van adva hitelesítő adat. Ha nincs megadva, a rendszer nem ad hozzá házirendet.
createRestError(PathUncheckedResponse)	Rest error from a PathUnchecked response
createRestError(string, PathUncheckedResponse)	Rest hibaüzenetet és PathUnchecked-választ hoz létre
getClient(string, ClientOptions)	Alapértelmezett folyamattal rendelkező ügyfél létrehozása
getClient(string, TokenCredential | KeyCredential, ClientOptions)	Alapértelmezett folyamattal rendelkező ügyfél létrehozása
operationOptionsToRequestParameters(OperationOptions)	Az OperationOptions RequestParameterssé alakításához szükséges segédfüggvény

Függvény adatai

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Hitelesítőadat-szabályzatot ad hozzá a folyamathoz, ha meg van adva hitelesítő adat. Ha nincs megadva, a rendszer nem ad hozzá házirendet.

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

Paraméterek

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Rest error from a PathUnchecked response

function createRestError(response: PathUncheckedResponse): RestError

Paraméterek

response

PathUncheckedResponse

Válaszok

RestError

createRestError(string, PathUncheckedResponse)

Rest hibaüzenetet és PathUnchecked-választ hoz létre

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

Paraméterek

message

string

response

PathUncheckedResponse

Válaszok

RestError

getClient(string, ClientOptions)

Alapértelmezett folyamattal rendelkező ügyfél létrehozása

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

Paraméterek

endpoint

string

Az ügyfél alapvégpontja

options

ClientOptions

Ügyfélbeállítások

Válaszok

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Alapértelmezett folyamattal rendelkező ügyfél létrehozása

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

Paraméterek

endpoint

string

Az ügyfél alapvégpontja

credentials

TokenCredential | KeyCredential

Hitelesítő adatok a kérések hitelesítéséhez

options

ClientOptions

Ügyfélbeállítások

Válaszok

Client

operationOptionsToRequestParameters(OperationOptions)

Az OperationOptions RequestParameterssé alakításához szükséges segédfüggvény

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Paraméterek

options

OperationOptions

a modular layer által a kérés elküldéséhez használt beállítások

Válaszok

RequestParameters

az RLC-réteg RequestParametersben történő konvertálásának eredménye