@azure/core-client package

Třídy

ServiceClient

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 mapovače. Lze použít pro xml a prosté javascriptové objekty.

CommonClientOptions

Běžná sada možností, u které se očekává zveřejnění klientů vysoké úrovně.

CompositeMapper

Mapovač složený z jiných mapovačů.

CompositeMapperType

Pomáhá vytvořit mapovač, který popisuje, jak mapovat sadu vlastností objektu na základě jiných mapovačů.

Měla by být přítomna pouze jedna z následujících vlastností: className, modelProperties a additionalProperties.

DeserializationContentTypes

Typy obsahu, které budou indikovat, že odpověď na operaci by měla být deserializována určitým způsobem.

DeserializationPolicyOptions

Možnosti konfigurace deserializace odpovědí rozhraní API

DictionaryMapper

Mapovač popisující prosté javascriptové objekty používané jako páry klíč/hodnota

DictionaryMapperType

Pomáhá vytvořit mapovač, který popisuje, jak parsovat slovník mapovaných hodnot.

EnumMapper

Mapovač popisující hodnotu výčtu.

EnumMapperType

Pomáhá vytvořit mapovač, který popisuje, jak parsovat hodnotu výčtu.

FullOperationResponse

Objekt Wrapper pro požadavek HTTP a odpověď. Deserializovaný objekt je uložen ve parsedBody vlastnosti při přijetí textu odpovědi ve formátu JSON nebo XML.

InternalClientPipelineOptions

Možnosti pro vytvoření kanálu pro použití s Klientem služby 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 například celočíselné rozsahy a řetězec regex.

OperationArguments

Kolekce vlastností, které platí pro jedno vyvolání operace.

OperationOptions

Typ základních 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í ke 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

OperaceResponse, která může být vrácena z požadavku operace pro jeden stavový kód.

OperationSpec

Specifikace, která definuje operaci.

OperationURLParameter

Parametr pro operaci, který bude nahrazen adresou URL požadavku operace.

PolymorphicDiscriminator

Používá se k nejednoznačnosti diskriminovaných sjednocení typů. Pokud například odpověď může mít mnoho obrazců, ale obsahuje také pole typu (nebo podobné), lze toto pole použít k určení, jak deserializovat odpověď 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í objektů nezpracovaných odpovědí na konečné obrazce. Pomáhá balit a rozbalovat data a další zakódované typy, které nejsou ve formátu JSON vnitřní. 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 nebo 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 pro řízení chování analyzátoru xml a tvůrce

Aliasy typu

Mapper

Mapovače jsou definice datových modelů používaných v knihovně. Tyto datové modely jsou součástí definic operace nebo klienta v odpovědích nebo parametrech.

MapperType

Typ mapovače. Zahrnuje známé mapovače.

OperationRequest

Alias typu pro budoucí kontrolu pravopisu.

ParameterPath

Kóduje, jak získat přístup ke 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 být volána vícekrát.

Funkce

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

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

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

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

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

Po poskytnutí bearerTokenAuthenticationPolicy budou zásady interně řešit problémy s průběžným vyhodnocováním přístupu (CAE). Když nebude moct 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 služby Storage. Tím se implementuje proces nosné výzvy popsaný tady: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Zpracování má specifické funkce pro úložiště, které se odchylují od obecných dokumentů k výzvám AAD.

createClientPipeline(InternalClientPipelineOptions)

Vytvoří nový kanál pro použití s klientem služby. Ve výchozím nastavení přidá do deserializationPolicy. Přidá také v bearerTokenAuthenticationPolicy, pokud předá 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í operací OperationSpec a OperationArguments v požadavku.

Podrobnosti funkce

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

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

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

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

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

Po poskytnutí bearerTokenAuthenticationPolicy budou zásady interně řešit problémy s průběžným vyhodnocováním přístupu (CAE). Když nebude moct 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

Návraty

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

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

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

Parametry

Návraty

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

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

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parametry

options
InternalClientPipelineOptions

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

Návraty

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

Jestli se má podporovat XML

Návraty

deserializationPolicy(DeserializationPolicyOptions)

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

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parametry

Návraty

serializationPolicy(SerializationPolicyOptions)

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

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parametry

Návraty