@azure/core-client package

Klasser

ServiceClient

Initierar en ny instans av ServiceClient.

Gränssnitt

AdditionalPolicyConfig	Används för att konfigurera ytterligare principer som läggs till i pipelinen vid konstruktion.
BaseMapper	Basdefinitionen för en mappare. Kan användas för XML-objekt och vanliga JavaScript-objekt.
CommonClientOptions	Den vanliga uppsättningen alternativ som högnivåklienter förväntas exponera.
CompositeMapper	En mappare som består av andra mappare.
CompositeMapperType	Hjälper till att skapa en mappare som beskriver hur du mappar en uppsättning egenskaper för ett objekt baserat på andra mappare. Endast en av följande egenskaper ska finnas: className, modelProperties och additionalProperties.
DeserializationContentTypes	De innehållstyper som anger att ett åtgärdssvar ska deserialiseras på ett visst sätt.
DeserializationPolicyOptions	Alternativ för att konfigurera API-svarsdeserialisering.
DictionaryMapper	En mappare som beskriver vanliga JavaScript-objekt som används som nyckel/värde-par.
DictionaryMapperType	Hjälper dig att skapa en mappning som beskriver hur du parsar en ordlista med mappade värden.
EnumMapper	En mappare som beskriver ett uppräkningsvärde.
EnumMapperType	Hjälper till att skapa en mappning som beskriver hur du parsar ett uppräkningsvärde.
FullOperationResponse	Omslutningsobjekt för http-begäran och -svar. Deserialiserat objekt lagras i parsedBody egenskapen när svarstexten tas emot i JSON eller XML.
InternalClientPipelineOptions	Alternativ för att skapa en pipeline som ska användas med ServiceClient. Främst för att anpassa autentiseringsprincipen (om du använder tokenautentisering) eller deserialiseringsalternativen när du använder XML.
MapperConstraints	Beskrivning av olika värdebegränsningar, till exempel heltalsintervall och regex för strängar.
OperationArguments	En samling egenskaper som gäller för ett enda anrop av en åtgärd.
OperationOptions	Basalternativtypen för alla åtgärder.
OperationParameter	Ett gemensamt gränssnitt som alla åtgärdsparametrar utökar.
OperationQueryParameter	En parameter för en åtgärd som läggs till som en frågeparameter i åtgärdens HTTP-begäran.
OperationRequestInfo	Metadata som används för att parsa ett svar korrekt.
OperationRequestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
OperationResponseMap	Ett OperationResponse som kan returneras från en åtgärdsbegäran för en enda statuskod.
OperationSpec	En specifikation som definierar en åtgärd.
OperationURLParameter	En parameter för en åtgärd som ska ersättas med åtgärdens begärande-URL.
PolymorphicDiscriminator	Används för att skingra diskriminerade typföreningar. Om svaret till exempel kan ha många former men även innehåller ett "typfält" (eller liknande), kan det fältet användas för att avgöra hur svaret ska deserialiseras till rätt typ.
SequenceMapper	En mappare som beskriver matriser.
SequenceMapperType	Hjälper till att skapa en mappning som beskriver hur du parsar en sekvens med mappade värden.
SerializationPolicyOptions	Alternativ för att konfigurera serialisering av API-begäranden.
Serializer	Används för att mappa råa svarsobjekt till slutliga former. Hjälper till att packa upp och packa upp datum och andra kodade typer som inte är inbyggda i JSON. Du kan också hämta värden från rubriker, samt infoga standardvärden och konstanter.
SerializerOptions	Alternativ för att konfigurera serialiserings-/avserialiseringsbeteende.
ServiceClientOptions	Alternativ som ska anges när klienten skapas.
SimpleMapperType	Typen av enkel mappning.
SpanConfig	Konfiguration för att skapa ett nytt spårningsintervall
XmlOptions	Alternativ för att styra beteendet för XML-parser och byggare.

Typalias

Mapper	Mappare är definitioner av de datamodeller som används i biblioteket. Dessa datamodeller är en del av åtgärds- eller klientdefinitionerna i svaren eller parametrarna.
MapperType	Typ av mappning. Innehåller kända mappningsmappare.
OperationRequest	Ett typalias för framtida språkkontroll.
ParameterPath	Kodar hur du når en viss egenskap för ett objekt.
QueryCollectionFormat	Det format som ska användas för att koppla samman en matris med värden för ett frågeparametervärde.
RawResponseCallback	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

Funktioner

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Den här funktionen kan användas som motringning för för , för bearerTokenAuthenticationPolicy@azure/core-rest-pipelineatt stödja CAE-utmaningar: Kontinuerlig åtkomstutvärdering. bearerTokenAuthenticationPolicy Anropa med följande alternativ: import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({ authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge }); När principen väl har angetts hanterar den bearerTokenAuthenticationPolicy utmaningar som rör kontinuerlig åtkomstutvärdering (CAE). När den inte kan slutföra en utmaning returnerar den 401-svaret (obehörig) från ARM. Exempel på utmaning med anspråk: Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Definierar ett återanrop för att hantera en autentiseringsuppgift för Storage-API:er. Detta implementerar utmaningsprocessen för ägaren som beskrivs här: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Hantering har specifika funktioner för lagring som avgår till de allmänna AAD-utmaningsdokumenten.
createClientPipeline(InternalClientPipelineOptions)	Skapar en ny pipeline för användning med en tjänstklient. Lägger till i deserializationPolicy som standard. Lägger också till i bearerTokenAuthenticationPolicy om det skickas en TokenCredential.
createSerializer({[key: string]: any}, boolean)	Metod som skapar och returnerar en serialiserare.
deserializationPolicy(DeserializationPolicyOptions)	Den här principen hanterar parsning av svar enligt OperationSpecs på begäran.
serializationPolicy(SerializationPolicyOptions)	Den här principen hanterar montering av begärandetexten och huvudena med hjälp av en OperationSpec och OperationArguments på begäran.

Funktionsinformation

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Den här funktionen kan användas som motringning för för , för bearerTokenAuthenticationPolicy@azure/core-rest-pipelineatt stödja CAE-utmaningar: Kontinuerlig åtkomstutvärdering.

bearerTokenAuthenticationPolicy Anropa med följande alternativ:

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

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

När principen väl har angetts hanterar den bearerTokenAuthenticationPolicy utmaningar som rör kontinuerlig åtkomstutvärdering (CAE). När den inte kan slutföra en utmaning returnerar den 401-svaret (obehörig) från ARM.

Exempel på utmaning med anspråk:

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>

Parametrar

onChallengeOptions

AuthorizeRequestOnChallengeOptions

Returer

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Definierar ett återanrop för att hantera en autentiseringsuppgift för Storage-API:er. Detta implementerar utmaningsprocessen för ägaren som beskrivs här: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Hantering har specifika funktioner för lagring som avgår till de allmänna AAD-utmaningsdokumenten.

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

Parametrar

challengeOptions

AuthorizeRequestOnChallengeOptions

Returer

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Skapar en ny pipeline för användning med en tjänstklient. Lägger till i deserializationPolicy som standard. Lägger också till i bearerTokenAuthenticationPolicy om det skickas en TokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parametrar

options

InternalClientPipelineOptions

Alternativ för att anpassa den skapade pipelinen.

Returer

Pipeline

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

Metod som skapar och returnerar en serialiserare.

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

Parametrar

modelMappers

{[key: string]: any}

Kända modeller att mappa

isXML

boolean

Om XML ska stödjas

Returer

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Den här principen hanterar parsning av svar enligt OperationSpecs på begäran.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parametrar

options

DeserializationPolicyOptions

Returer

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Den här principen hanterar montering av begärandetexten och huvudena med hjälp av en OperationSpec och OperationArguments på begäran.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parametrar

options

SerializationPolicyOptions

Returer

PipelinePolicy