@azure/core-client package

Reference

Třídy

Inicializuje novou instanci ServiceClient.

Rozhraní

AdditionalPolicyConfig	Slouží ke konfiguraci dalších zásad přidaných do kanálu při vytváření.
BaseMapper	Základní definice mapperu. Lze použít pro xml a prosté javascriptové objekty.
CommonClientOptions	Očekává se, že klienti vysoké úrovně budou vystavit společnou sadu možností.
CompositeMapper	Mapovač složený z jiných mapperů.
CompositeMapperType	Pomáhá vytvořit mapovač, který popisuje, jak mapovat sadu vlastností objektu na základě jiných mapperů. Měla by existovat pouze jedna z následujících vlastností: `className`, `modelProperties` a `additionalProperties`.
DeserializationContentTypes	Typy obsahu, které budou indikovat, že odpověď operace by měla být deserializována určitým způsobem.
DeserializationPolicyOptions	Možnosti konfigurace deserializace odpovědí rozhraní API
DictionaryMapper	Mapper popisující prosté javascriptové objekty používané jako páry klíč/hodnota.
DictionaryMapperType	Pomáhá vytvořit mapovač, který popisuje, jak analyzovat slovník mapovaných hodnot.
EnumMapper	Mapper popisující hodnotu výčtu
EnumMapperType	Pomáhá vytvořit mapovač, který popisuje, jak parsovat hodnotu výčtu.
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 nebo XML.
InternalClientPipelineOptions	Možnosti pro vytvoření kanálu, který se má použít se ServiceClient. Většinou pro přizpůsobení zásad ověřování (pokud používáte ověřování tokenů) nebo možnosti deserializace při použití XML.
MapperConstraints	Popis různých omezení hodnot, jako jsou rozsahy celých čísel a řetězcové regulární výrazy.
OperationArguments	Kolekce vlastností, které se vztahují na jedno vyvolání operace.
OperationOptions	Základní typ možností pro všechny operace.
OperationParameter	Společné rozhraní, které rozšiřuje všechny parametry operace.
OperationQueryParameter	Parametr pro operaci, která se přidá jako parametr dotazu do požadavku HTTP operace.
OperationRequestInfo	Metadata, která se používají k správné analýze odpovědi.
OperationRequestOptions	Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
OperationResponseMap	OperationResponse, která se dá vrátit z žádosti o operaci pro jeden stavový kód.
OperationSpec	Specifikace, která definuje operaci.
OperationURLParameter	Parametr operace, která bude nahrazena adresou URL požadavku operace.
PolymorphicDiscriminator	Používá se k nejednoznačnosti diskriminovaných sjednocení typů. Pokud odpověď může mít například mnoho obrazců, ale obsahuje také pole typu (nebo podobné), lze toto pole použít k určení způsobu deserializace odpovědi na správný typ.
SequenceMapper	Mapovač popisující pole
SequenceMapperType	Pomáhá vytvořit mapovač, který popisuje, jak parsovat posloupnost mapovaných hodnot.
SerializationPolicyOptions	Možnosti konfigurace serializace požadavků rozhraní API
Serializer	Slouží k mapování nezpracovaných objektů odpovědi na konečné obrazce. Pomáhá balit a rozbalovat kalendářní data a další kódované typy, které nejsou vnitřní pro JSON. Umožňuje také načítání hodnot ze záhlaví a vkládání výchozích hodnot a konstant.
SerializerOptions	Možnosti konfigurace chování serializace/de-serializace
ServiceClientOptions	Možnosti, které se mají poskytnout při vytváření klienta.
SimpleMapperType	Typ jednoduchého mapovače.
SpanConfig	Konfigurace pro vytvoření nového rozsahu trasování
XmlOptions	Možnosti řízení chování analyzátoru XML a tvůrce

Aliasy typu

Mapper	Mapovači jsou definice datových modelů používaných v knihovně. Tyto datové modely jsou součástí definice operace nebo klienta v odpovědích nebo parametrech.
MapperType	Typ mapperu Obsahuje známé mapovače.
OperationRequest	Alias typu pro budoucí kontrolu pravopisu.
ParameterPath	Kóduje, jak dosáhnout konkrétní vlastnosti objektu.
QueryCollectionFormat	Formát, který se použije ke spojení pole hodnot pro hodnotu parametru dotazu.
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.

Funkce

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Tuto funkci lze použít jako zpětné volání pro `bearerTokenAuthenticationPolicy@azure/core-rest-pipeline`, která podporuje výzvy CAE: průběžné vyhodnocování přístupu. Volejte `bearerTokenAuthenticationPolicy` s následujícími možnostmi: `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const policy = bearerTokenAuthenticationPolicy({ challengeCallbacks: { authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge, }, scopes: ["https://service/.default"], });` Po poskytnutí budou zásady `bearerTokenAuthenticationPolicy` interně zpracovávat výzvy caE (Continuous Access Evaluation). Když nemůže dokončit výzvu, vrátí odpověď 401 (neautorizováno) z ARM. Příklad výzvy s deklaracemi identity: `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Definuje zpětné volání pro zpracování výzvy ověřování pro rozhraní API úložiště. Tím se implementuje proces nosné výzvy popsané tady: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Zpracování má specifické funkce pro úložiště, které odchází do obecné dokumentace k výzvě AAD.
createClientPipeline(InternalClientPipelineOptions)	Vytvoří nový kanál pro použití s klientem služby. Ve výchozím nastavení se přidá do deserializationPolicy. Přidá se také v bearerTokenAuthenticationPolicy, pokud bylo předáno TokenCredential.
createSerializer({[key: string]: any}, boolean)	Metoda, která vytvoří a vrátí serializátor.
deserializationPolicy(DeserializationPolicyOptions)	Tato zásada zpracovává parsování odpovědí podle operationSpecs na požadavku.
serializationPolicy(SerializationPolicyOptions)	Tato zásada zpracovává sestavení textu požadavku a hlaviček pomocí OperationSpec a OperationArguments v požadavku.

Podrobnosti funkce

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Tuto funkci lze použít jako zpětné volání pro bearerTokenAuthenticationPolicy@azure/core-rest-pipeline, která podporuje výzvy CAE: průběžné vyhodnocování přístupu.

Volejte bearerTokenAuthenticationPolicy s následujícími možnostmi:

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

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

Po poskytnutí budou zásady bearerTokenAuthenticationPolicy interně zpracovávat výzvy caE (Continuous Access Evaluation). Když nemůže dokončit výzvu, vrátí odpověď 401 (neautorizováno) z ARM.

Příklad výzvy s deklaracemi identity:

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>

Parametry

onChallengeOptions: AuthorizeRequestOnChallengeOptions

Návraty

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Definuje zpětné volání pro zpracování výzvy ověřování pro rozhraní API úložiště. Tím se implementuje proces nosné výzvy popsané tady: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Zpracování má specifické funkce pro úložiště, které odchází do obecné dokumentace k výzvě AAD.

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

Parametry

challengeOptions: AuthorizeRequestOnChallengeOptions

Návraty

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Vytvoří nový kanál pro použití s klientem služby. Ve výchozím nastavení se přidá do deserializationPolicy. Přidá se také v bearerTokenAuthenticationPolicy, pokud bylo předáno TokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parametry

options: InternalClientPipelineOptions

Možnosti přizpůsobení vytvořeného kanálu

Návraty

Pipeline

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

Metoda, která vytvoří a vrátí serializátor.

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

Parametry

modelMappers: {[key: string]: any}

Známé modely, které se mají mapovat

isXML: boolean

Pokud by se měl xml podporovat

Návraty

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Tato zásada zpracovává parsování odpovědí podle operationSpecs na požadavku.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parametry

options: DeserializationPolicyOptions

Návraty

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Tato zásada zpracovává sestavení textu požadavku a hlaviček pomocí OperationSpec a OperationArguments v požadavku.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parametry

options: SerializationPolicyOptions

Návraty

PipelinePolicy

Sdílet prostřednictvím

@azure/core-client package

Třídy

Rozhraní

Aliasy typu

Funkce

Podrobnosti funkce

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Parametry

Návraty

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Parametry

Návraty

createClientPipeline(InternalClientPipelineOptions)

Parametry

Návraty

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

Parametry

Návraty

deserializationPolicy(DeserializationPolicyOptions)

Parametry

Návraty

serializationPolicy(SerializationPolicyOptions)

Parametry

Návraty

Další materiály