@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- och oformaterade JavaScript-objekt. |
CommonClientOptions |
Den vanliga uppsättningen alternativ som klienter på hög nivå 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: |
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 till att skapa en mappare 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 mappare som beskriver hur du parsar ett uppräkningsvärde. |
FullOperationResponse |
Wrapper-objekt för http-begäran och -svar. Deserialiserat objekt lagras i egenskapen |
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 strängredomän. |
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ärdsparametern 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 |
En 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 ersätts med åtgärdens url för begäran. |
PolymorphicDiscriminator |
Används för att tvetydiga diskrimineringsorganisationer. 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 mappare 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 datum och andra kodade typer som inte är inbyggda i JSON. Tillåter också att värden hämtas från rubriker, samt att standardvärden och konstanter infogas. |
SerializerOptions |
Alternativ för att konfigurera serialiserings-/av-serialiseringsbeteende. |
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 mappare. |
OperationRequest |
Ett typalias för framtida språk. |
ParameterPath |
Kodar hur du når en viss egenskap på 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
authorize |
Den här funktionen kan användas som återanrop för Anropa
När den har angetts hanterar Exempel på utmaning med anspråk:
|
authorize |
Definierar ett återanrop för att hantera autentiseringsutmaningen för Lagrings-API:er. Detta implementerar den utmaningsprocess som beskrivs här: https://learn.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. |
create |
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. |
create |
Metod som skapar och returnerar en Serialiserare. |
deserialization |
Den här principen hanterar parsning av svar enligt OperationSpecs på begäran. |
serialization |
Den här principen hanterar montering av begärandetexten och sidhuvudena med hjälp av en OperationSpec och OperationArguments på begäran. |
Funktionsinformation
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Den här funktionen kan användas som återanrop för bearerTokenAuthenticationPolicy
för @azure/core-rest-pipeline
, för att stödja CAE-utmaningar: kontinuerlig åtkomstutvärdering.
Anropa bearerTokenAuthenticationPolicy
med följande alternativ:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const policy = bearerTokenAuthenticationPolicy({
challengeCallbacks: {
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
},
scopes: ["https://service/.default"],
});
När den har angetts hanterar bearerTokenAuthenticationPolicy
-principen internt CAE-utmaningar (Continuous Access Evaluation).
När den inte kan slutföra en utmaning returnerar den 401-svaret (obehörigt) 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 autentiseringsutmaningen för Lagrings-API:er. Detta implementerar den utmaningsprocess som beskrivs här: https://learn.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
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
deserializationPolicy(DeserializationPolicyOptions)
Den här principen hanterar parsning av svar enligt OperationSpecs på begäran.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy
Parametrar
- options
- DeserializationPolicyOptions
Returer
serializationPolicy(SerializationPolicyOptions)
Den här principen hanterar montering av begärandetexten och sidhuvudena med hjälp av en OperationSpec och OperationArguments på begäran.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy
Parametrar
- options
- SerializationPolicyOptions