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


@azure/core-client package

Osztályok

ServiceClient

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ű ügyfelek által várhatóan elérhető gyakori lehetőségek.

CompositeMapper

Más leképezőkből álló térképező.

CompositeMapperType

Segít létrehozni egy leképezőt, amely leírja, hogyan képezhet le egy objektum tulajdonságait 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álaszt egy adott módon kell deszerializálni.

DeserializationPolicyOptions

Az API-válasz deszerializálásának konfigurálásának lehetőségei.

DictionaryMapper

A kulcs/érték párként használt egyszerű JavaScript-objektumokat leíró leképező.

DictionaryMapperType

Segít létrehozni egy leképezőt, amely leírja, hogyan elemezhet egy leképezett értékek szótárát.

EnumMapper

Egy enumerálási értéket leíró leképező.

EnumMapperType

Segít létrehozni egy 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 tulajdonságban parsedBody lesz tárolva, amikor a válasz törzse JSON-ban vagy XML-ben érkezik.

InternalClientPipelineOptions

A ServiceClient használatával használható folyamat létrehozásának lehetőségei. Többnyire a hitelesítési szabályzat testreszabásához (jogkivonat-hitelesítés használata esetén) vagy a deszerializálási beállításokhoz xml használata esetén.

MapperConstraints

A különböző értékkényszereket, például az egész számtartományokat és a sztring regexét ismerteti.

OperationArguments

Egy művelet egyetlen meghívására vonatkozó tulajdonságok gyűjteménye.

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

A 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 elkü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ébe lesz behelyettesülve.

PolymorphicDiscriminator

A diszkriminált típusú uniók egyértelműsítésére szolgál. Ha például a válasz sok 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ó leképező.

SequenceMapperType

Segít létrehozni egy leképező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 alakzatokhoz 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 fejlécekből való lekérését, valamint az alapértelmezett értékek és állandók beszúrását.

SerializerOptions

A szerializálási/szerializálási viselkedés konfigurálásának beállításai.

ServiceClientOptions

Az ügyfél létrehozásakor meg kell adni a beállításokat.

SimpleMapperType

Egy egyszerű leképező típusa.

SpanConfig

Új nyomkövetési span létrehozásának konfigurációja

XmlOptions

Az xml-elemző és a 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 található művelet- vagy ügyféldefiníciók részét képezik.

MapperType

A leképező típusa. Ismert leképezőket tartalmaz.

OperationRequest

Típusalias a későbbi 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

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.

Függvények

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Ez a függvény visszahívásként használható a(z) esetében, hogy támogassa a bearerTokenAuthenticationPolicy@azure/core-rest-pipelineCAE-kihívásokat: folyamatos hozzáférés-kiértékelés.

Hívja meg a bearerTokenAuthenticationPolicy következő lehetőségeket:

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

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

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

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

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 feladatának kezeléséhez. Ez megvalósítja az itt ismertetett tulajdonosi feladatfolyamatot: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge A kezelésnek olyan speciális funkciói vannak a tároláshoz, amelyek az általános AAD-feladatokkal kapcsolatos dokumentációktól indulnak el.

createClientPipeline(InternalClientPipelineOptions)

Létrehoz egy új folyamatot egy szolgáltatásügyféllel való használatra. Alapértelmezés szerint hozzáadja a deszerializationPolicy elemhez. Emellett hozzáadja a bearerTokenAuthenticationPolicy függvényt is, ha tokenCredential értéket adott á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 paranccsal a kérelemben.

Függvény adatai

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Ez a függvény visszahívásként használható a(z) esetében, hogy támogassa a bearerTokenAuthenticationPolicy@azure/core-rest-pipelineCAE-kihívásokat: folyamatos hozzáférés-kiértékelés.

Hívja meg a bearerTokenAuthenticationPolicy következő lehetőségeket:

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

const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

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

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

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

Válaszok

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Visszahívást határoz meg a Storage API-k hitelesítési feladatának kezeléséhez. Ez megvalósítja az itt ismertetett tulajdonosi feladatfolyamatot: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge A kezelésnek olyan speciális funkciói vannak a tároláshoz, amelyek az általános AAD-feladatokkal kapcsolatos dokumentációktól indulnak el.

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

Paraméterek

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 elemhez. Emellett hozzáadja a bearerTokenAuthenticationPolicy függvényt is, ha tokenCredential értéket adott át.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Paraméterek

options
InternalClientPipelineOptions

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

Válaszok

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

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

Válaszok

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 paranccsal a kérelemben.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Paraméterek

Válaszok