@azure/core-client package
Klassen
| ServiceClient |
Hiermee initialiseert u een nieuw exemplaar van de ServiceClient. |
Interfaces
| AdditionalPolicyConfig |
Wordt gebruikt voor het configureren van extra beleidsregels die tijdens de bouw aan de pijplijn zijn toegevoegd. |
| BaseMapper |
De basisdefinitie van een mapper. Kan worden gebruikt voor XML- en Gewone JavaScript-objecten. |
| CommonClientOptions |
De algemene set opties die clients op hoog niveau naar verwachting beschikbaar zullen maken. |
| CompositeMapper |
Een mapper die bestaat uit andere mappers. |
| CompositeMapperType |
Helpt bij het bouwen van een mapper die beschrijft hoe u een set eigenschappen van een object kunt toewijzen op basis van andere mappers. Er mag slechts een van de volgende eigenschappen aanwezig zijn: |
| DeserializationContentTypes |
De inhoudstypen die aangeven dat een bewerkingsreactie op een bepaalde manier moet worden gedeserialiseerd. |
| DeserializationPolicyOptions |
Opties voor het configureren van de deserialisatie van API-antwoorden. |
| DictionaryMapper |
Een mapper die gewone JavaScript-objecten beschrijft die worden gebruikt als sleutel-waardeparen. |
| DictionaryMapperType |
Helpt bij het bouwen van een mapper die beschrijft hoe u een woordenlijst met toegewezen waarden parseert. |
| EnumMapper |
Een mapper die een enum-waarde beschrijft. |
| EnumMapperType |
Helpt bij het bouwen van een mapper die beschrijft hoe u een enum-waarde kunt parseren. |
| FullOperationResponse |
Wrapper-object voor HTTP-aanvraag en -antwoord. Het gedeserialiseerde object wordt opgeslagen in de |
| InternalClientPipelineOptions |
Opties voor het maken van een pijplijn voor gebruik met ServiceClient. Meestal voor het aanpassen van het verificatiebeleid (als u tokenverificatie gebruikt) of de deserialisatieopties bij het gebruik van XML. |
| MapperConstraints |
Beschrijving van verschillende waardebeperkingen, zoals bereiken voor gehele getallen en tekenreeks regex. |
| OperationArguments |
Een verzameling eigenschappen die van toepassing is op één aanroep van een bewerking. |
| OperationOptions |
Het type basisopties voor alle bewerkingen. |
| OperationParameter |
Een algemene interface die door alle Operation-parameters wordt uitgebreid. |
| OperationQueryParameter |
Een parameter voor een bewerking die als queryparameter wordt toegevoegd aan de HTTP-aanvraag van de bewerking. |
| OperationRequestInfo |
Metagegevens die worden gebruikt om een antwoord correct te parseren. |
| OperationRequestOptions |
Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking. |
| OperationResponseMap |
Een OperationResponse die kan worden geretourneerd vanuit een bewerkingsaanvraag voor één statuscode. |
| OperationSpec |
Een specificatie die een bewerking definieert. |
| OperationURLParameter |
Een parameter voor een bewerking die wordt vervangen door de aanvraag-URL van de bewerking. |
| PolymorphicDiscriminator |
Wordt gebruikt om gediscrimineerde typevakbonden ondubbelzinnig te maken. Als antwoord bijvoorbeeld veel shapes kan hebben, maar ook een veld 'soort' (of iets dergelijks) bevat, kan dat veld worden gebruikt om te bepalen hoe het antwoord moet worden gedeserialiseerd naar het juiste type. |
| SequenceMapper |
Een mapper die matrices beschrijft. |
| SequenceMapperType |
Helpt bij het bouwen van een mapper die beschrijft hoe u een reeks toegewezen waarden parseert. |
| SerializationPolicyOptions |
Opties voor het configureren van serialisatie van API-aanvragen. |
| Serializer |
Wordt gebruikt om onbewerkte antwoordobjecten toe te wijzen aan uiteindelijke shapes. Helpt bij het verpakken en uitpakken van datums en andere gecodeerde typen die niet inherent zijn aan JSON. U kunt ook waarden ophalen uit headers en standaardwaarden en constanten invoegen. |
| SerializerOptions |
Opties voor het configureren van serialisatie-/deserialisatiegedrag. |
| ServiceClientOptions |
Opties die moeten worden opgegeven tijdens het maken van de client. |
| SimpleMapperType |
Het type eenvoudige mapper. |
| SpanConfig |
Configuratie voor het maken van een nieuwe traceringsbereik |
| XmlOptions |
Opties voor het bepalen van het gedrag van xml-parser en opbouwfunctie. |
Type-aliassen
| Mapper |
Mappers zijn definities van de gegevensmodellen die in de bibliotheek worden gebruikt. Deze gegevensmodellen maken deel uit van de bewerkings- of clientdefinities in de antwoorden of parameters. |
| MapperType |
Type van de mapper. Bevat bekende mappers. |
| OperationRequest |
Een typealias voor toekomstige controle. |
| ParameterPath |
Codeert hoe u een bepaalde eigenschap op een object bereikt. |
| QueryCollectionFormat |
De indeling die wordt gebruikt om een matrix met waarden samen te voegen voor een queryparameterwaarde. |
| RawResponseCallback |
Een functie die telkens wordt aangeroepen wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen. |
Functies
| authorize |
Deze functie kan worden gebruikt als een callback voor de Roep de Zodra het Voorbeeld van een uitdaging met claims: |
| authorize |
Definieert een callback voor het afhandelen van verificatie-uitdagingen voor Opslag-API's. Hiermee wordt het bearer-uitdagingsproces geïmplementeerd dat hier wordt beschreven: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Afhandeling heeft specifieke functies voor opslag die vertrekken naar de algemene AAD-uitdagingsdocumenten. |
| create |
Hiermee maakt u een nieuwe pijplijn voor gebruik met een serviceclient. Voegt standaard toe in deserializationPolicy. Voegt ook toe in bearerTokenAuthenticationPolicy als een TokenCredential is doorgegeven. |
| create |
Methode die een serializer maakt en retourneert. |
| deserialization |
Dit beleid verwerkt het parseren van antwoorden op basis van OperationSpecs voor de aanvraag. |
| serialization |
Dit beleid verwerkt het samenstellen van de aanvraagbody en headers met behulp van een OperationSpec en OperationArguments voor de aanvraag. |
Functiedetails
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Deze functie kan worden gebruikt als een callback voor de bearerTokenAuthenticationPolicy van , ter ondersteuning van @azure/core-rest-pipelineCAE-uitdagingen: continue toegangsevaluatie.
Roep de bearerTokenAuthenticationPolicy aan met de volgende opties:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
Zodra het bearerTokenAuthenticationPolicy beleid is opgegeven, worden problemen met continue toegangsevaluatie (CAE) intern afgehandeld.
Wanneer een uitdaging niet kan worden voltooid, wordt het 401-antwoord (niet-geautoriseerd) van ARM geretourneerd.
Voorbeeld van een uitdaging met claims:
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>Parameters
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
Retouren
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
Definieert een callback voor het afhandelen van verificatie-uitdagingen voor Opslag-API's. Hiermee wordt het bearer-uitdagingsproces geïmplementeerd dat hier wordt beschreven: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Afhandeling heeft specifieke functies voor opslag die vertrekken naar de algemene AAD-uitdagingsdocumenten.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>Parameters
- challengeOptions
- AuthorizeRequestOnChallengeOptions
Retouren
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
Hiermee maakt u een nieuwe pijplijn voor gebruik met een serviceclient. Voegt standaard toe in deserializationPolicy. Voegt ook toe in bearerTokenAuthenticationPolicy als een TokenCredential is doorgegeven.
function createClientPipeline(options?: InternalClientPipelineOptions): PipelineParameters
- options
- InternalClientPipelineOptions
Opties voor het aanpassen van de gemaakte pijplijn.
Retouren
createSerializer({[key: string]: any}, boolean)
Methode die een serializer maakt en retourneert.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): SerializerParameters
- modelMappers
-
{[key: string]: any}
Bekende modellen die moeten worden toegewezen
- isXML
-
boolean
Als XML moet worden ondersteund
Retouren
deserializationPolicy(DeserializationPolicyOptions)
Dit beleid verwerkt het parseren van antwoorden op basis van OperationSpecs voor de aanvraag.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicyParameters
- options
- DeserializationPolicyOptions
Retouren
serializationPolicy(SerializationPolicyOptions)
Dit beleid verwerkt het samenstellen van de aanvraagbody en headers met behulp van een OperationSpec en OperationArguments voor de aanvraag.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParameters
- options
- SerializationPolicyOptions