@azure/core-client package

Osztályok

Inicializálja a ServiceClient új példányát.

Interfészek

AdditionalPolicyConfig	A folyamathoz építéskor hozzáadott további szabályzatok konfigurálására szolgál.
BaseMapper	A leképező alapdefiníciója. XML- és egyszerű JavaScript-objektumokhoz használható.
CommonClientOptions	A magas szintű ügyfelektől elvárt gyakori lehetőségek.
CompositeMapper	Más térképezőkből álló térképelő.
CompositeMapperType	Segít létrehozni egy leképezőt, amely leírja, hogyan képezhet le egy objektum tulajdonságainak készletét más leképezők alapján. Csak az alábbi tulajdonságok egyikének kell szerepelnie: `className`, `modelProperties` és `additionalProperties`.
DeserializationContentTypes	Azok a tartalomtípusok, amelyek azt jelzik, hogy a műveleti válaszokat bizonyos módon deszerializálni kell.
DeserializationPolicyOptions	Az API-válasz deszerializálásának konfigurálásának lehetőségei.
DictionaryMapper	Kulcs/érték párként használt egyszerű JavaScript-objektumokat leíró leképező.
DictionaryMapperType	Segít létrehozni egy térképelőt, amely leírja, hogyan elemezhet egy megfeleltetett értékeket tartalmazó szótárat.
EnumMapper	Egy enumerálási értéket leíró leképező.
EnumMapperType	Segít összeállítani egy olyan leképezőt, amely leírja, hogyan elemezhet egy enumerálási értéket.
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 vagy XML-ben érkezik.
InternalClientPipelineOptions	A ServiceClienttel használható folyamat létrehozásának lehetőségei. Leginkább a hitelesítési szabályzat testreszabására (jogkivonat hitelesítése esetén) vagy az XML használatakor a deszerializálási beállításokra.
MapperConstraints	A különböző értékkorlátozások, például az egész számtartományok és a sztringregex leírása.
OperationArguments	Olyan tulajdonságok gyűjteménye, amelyek egy művelet egyetlen meghívására vonatkoznak.
OperationOptions	Az alapbeállítások típusa az összes művelethez.
OperationParameter	Egy közös felület, amelyet az összes műveleti paraméter kiterjeszt.
OperationQueryParameter	Egy művelet paramétere, amely lekérdezési paraméterként lesz hozzáadva a művelet HTTP-kéréséhez.
OperationRequestInfo	A válasz megfelelő elemzéséhez használt metaadatok.
OperationRequestOptions	A művelethez tartozó HTTP-kérések létrehozásakor és küldésekor használt beállítások.
OperationResponseMap	OperationResponse, amely egyetlen állapotkód műveleti kéréséből adható vissza.
OperationSpec	Egy műveletet meghatározó specifikáció.
OperationURLParameter	Egy művelet paramétere, amely a művelet kérési URL-címére lesz helyettesítve.
PolymorphicDiscriminator	A diszkriminált típusú szakszervezetek egyértelműsítésére szolgál. Ha például a válasz számos alakzatot tartalmazhat, de tartalmaz egy "kind" mezőt (vagy hasonlót), akkor ez a mező határozza meg, hogyan lehet deszerializálni a választ a megfelelő típusra.
SequenceMapper	Tömböket leíró térkép.
SequenceMapperType	Segít létrehozni egy térképelőt, amely leírja, hogyan elemezhet egy leképezett értékek sorozatát.
SerializationPolicyOptions	Az API-kérések szerializálásának konfigurálásának lehetőségei.
Serializer	Nyers válaszobjektumok végleges alakzatokra való leképezésére szolgál. Segít a dátumok és más kódolt típusok csomagolásában és kicsomagolásában, amelyek nem kapcsolódnak a JSON-hoz. Emellett lehetővé teszi az értékek lekérését a fejlécekből, valamint az alapértelmezett értékek és állandók beszúrását.
SerializerOptions	A szerializálás/szerializálási viselkedés konfigurálásának lehetőségei.
ServiceClientOptions	Az ügyfél létrehozásakor meg kell adni a beállításokat.
SimpleMapperType	Az egyszerű leképező típusa.
SpanConfig	Konfigurálás új nyomkövetési időtartam létrehozásához
XmlOptions	Az xml-elemző és -szerkesztő viselkedésének szabályozására vonatkozó beállítások.

Típusaliasok

Mapper	A leképezők a kódtárban használt adatmodellek definíciói. Ezek az adatmodellek a válaszokban vagy paraméterekben szereplő művelet- vagy ügyféldefiníciók részét képezik.
MapperType	A leképező típusa. Ismert térképezőket tartalmaz.
OperationRequest	Típus alias a jövőbeli ellenőrzéshez.
ParameterPath	Kódolja, hogyan érhet el egy adott tulajdonságot egy objektumon.
QueryCollectionFormat	Az a formátum, amely egy értéktömb összeillesztéséhez használható egy lekérdezési paraméter értékéhez.
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ó.

Függvények

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Ez a függvény a `bearerTokenAuthenticationPolicy@azure/core-rest-pipeline` visszahívásaként használható a CAE kihívásainak támogatására: folyamatos hozzáférés-kiértékelési. Hívja meg a `bearerTokenAuthenticationPolicy` a következő beállításokkal: `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const policy = bearerTokenAuthenticationPolicy({ challengeCallbacks: { authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge, }, scopes: ["https://service/.default"], });` Miután megadta, a `bearerTokenAuthenticationPolicy` szabályzat belsőleg kezeli a folyamatos hozzáférés-kiértékelési (CAE) kihívásokat. Ha nem tud teljesíteni egy feladatot, a 401-et (nem engedélyezett) választ adja vissza az ARM-től. Példa a jogcímekkel kapcsolatos kihívásokra: `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Visszahívást határoz meg a Storage API-k hitelesítési kihívásainak kezeléséhez. Ez megvalósítja az itt leírt tulajdonosi kihívást: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge A kezelés speciális funkciókkal rendelkezik a tároláshoz, amelyek az általános AAD-feladat dokumentációkba kerülnek.
createClientPipeline(InternalClientPipelineOptions)	Létrehoz egy új folyamatot egy szolgáltatásügyféllel való használatra. Alapértelmezés szerint hozzáadja a deszerializationPolicy tulajdonságot. Emellett hozzáadja a bearerTokenAuthenticationPolicy függvényt is, ha tokenCredential értéket ad át.
createSerializer({[key: string]: any}, boolean)	Szerializálót létrehozó és visszaadó metódus.
deserializationPolicy(DeserializationPolicyOptions)	Ez a szabályzat kezeli a válaszok elemzését az OperationSpecs alapján a kérelemben.
serializationPolicy(SerializationPolicyOptions)	Ez a szabályzat kezeli a kérelem törzsének és fejléceinek összeállítását egy OperationSpec és OperationArguments parancs használatával a kérelemen.

Függvény adatai

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Ez a függvény a bearerTokenAuthenticationPolicy@azure/core-rest-pipeline visszahívásaként használható a CAE kihívásainak támogatására: folyamatos hozzáférés-kiértékelési.

Hívja meg a bearerTokenAuthenticationPolicy a következő beállításokkal:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

Miután megadta, a bearerTokenAuthenticationPolicy szabályzat belsőleg kezeli a folyamatos hozzáférés-kiértékelési (CAE) kihívásokat. Ha nem tud teljesíteni egy feladatot, a 401-et (nem engedélyezett) választ adja vissza az ARM-től.

Példa a jogcímekkel kapcsolatos kihívásokra:

Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="

function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Paraméterek

onChallengeOptions: AuthorizeRequestOnChallengeOptions

Válaszok

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Visszahívást határoz meg a Storage API-k hitelesítési kihívásainak kezeléséhez. Ez megvalósítja az itt leírt tulajdonosi kihívást: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge A kezelés speciális funkciókkal rendelkezik a tároláshoz, amelyek az általános AAD-feladat dokumentációkba kerülnek.

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Paraméterek

challengeOptions: AuthorizeRequestOnChallengeOptions

Válaszok

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Létrehoz egy új folyamatot egy szolgáltatásügyféllel való használatra. Alapértelmezés szerint hozzáadja a deszerializationPolicy tulajdonságot. Emellett hozzáadja a bearerTokenAuthenticationPolicy függvényt is, ha tokenCredential értéket ad át.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Paraméterek

options: InternalClientPipelineOptions

A létrehozott folyamat testreszabásának beállításai.

Válaszok

Pipeline

createSerializer({[key: string]: any}, boolean)

Szerializálót létrehozó és visszaadó metódus.

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

Paraméterek

modelMappers: {[key: string]: any}

Ismert leképezési modellek

isXML: boolean

Ha az XML-t támogatni kell

Válaszok

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Ez a szabályzat kezeli a válaszok elemzését az OperationSpecs alapján a kérelemben.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Paraméterek

options: DeserializationPolicyOptions

Válaszok

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Ez a szabályzat kezeli a kérelem törzsének és fejléceinek összeállítását egy OperationSpec és OperationArguments parancs használatával a kérelemen.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Paraméterek

options: SerializationPolicyOptions

Válaszok

PipelinePolicy

Megosztás a következőn keresztül:

@azure/core-client package

Osztályok

Interfészek

Típusaliasok

Függvények

Függvény adatai

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Paraméterek

Válaszok

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Paraméterek

Válaszok

createClientPipeline(InternalClientPipelineOptions)

Paraméterek

Válaszok

createSerializer({[key: string]: any}, boolean)

Paraméterek

Válaszok

deserializationPolicy(DeserializationPolicyOptions)

Paraméterek

Válaszok

serializationPolicy(SerializationPolicyOptions)

Paraméterek

Válaszok