@azure-rest/core-client package

Interfészek

AddCredentialPipelinePolicyOptions	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 tulajdonságban parsedBody lesz tárolva, amikor a választörzs 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.
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 elküldésekor használt beállítások.
ResourceMethods	Meghatározza az erőforráson meghívható metódusokat

Típusaliasok

ClientOptions	A rest level client által igénybe vehető általános lehetőségek
HttpBrowserStreamResponse	Http-válasz, amely a NodeJS streamobjektum törzse
HttpNodeStreamResponse	Http-válasz, amely a NodeJS streamobjektum törzse
HttpResponse	Egy HttpResponse alakzatát jelöli
PathParameters	Az elérésiút-sablon szövegében {} található paraméterek é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 paranccsal használandó típus felülbírálja a törzstípust bármely típusra a rugalmasság érdekében
RawResponseCallback	Egy függvényt kell meghívni minden alkalommal, amikor a rendszer választ kap a kiszolgálótól a kért művelet végrehajtása során. Lehet, hogy többször is meghívják.
RequestParameters	Az alapértelmezett kérelemparaméterek alakzata, ezt felülírhatják az adott kéréstípusok, hogy erős típusokat biztosítsanak
StreamableMethod	Meghatározza a metódus típusát, amely támogatja a választörzs nyers streamként való lekérését

Függvények

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	Hitelesítő adatok megadása esetén hitelesítőadat-szabályzatot ad hozzá a folyamathoz. Ha nincs megadva, a rendszer nem ad hozzá szabályzatot.
createRestError(PathUncheckedResponse)	Rest hibaüzenetet hoz létre a PathUnchecked válaszból
createRestError(string, PathUncheckedResponse)	Rest hibát hoz létre egy hibaüzenetből és egy PathUnchecked válaszból
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)	Segédfüggvény az OperationOptions kérésparaméterekké alakításához

Függvény adatai

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Hitelesítő adatok megadása esetén hitelesítőadat-szabályzatot ad hozzá a folyamathoz. Ha nincs megadva, a rendszer nem ad hozzá szabályzatot.

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

Paraméterek

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Rest hibaüzenetet hoz létre a PathUnchecked válaszból

function createRestError(response: PathUncheckedResponse): RestError

Paraméterek

response

PathUncheckedResponse

Válaszok

RestError

createRestError(string, PathUncheckedResponse)

Rest hibát hoz létre egy hibaüzenetből és egy PathUnchecked válaszból

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)

Segédfüggvény az OperationOptions kérésparaméterekké alakításához

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Paraméterek

options

OperationOptions

a modular layer által a kérés elküldéséhez használt lehetőségek

Válaszok

RequestParameters

az RLC-réteg RequestParametersben való konvertálásának eredménye