@azure/core-client package
Klassen
| ServiceClient |
Initialiseert een nieuw exemplaar van de ServiceClient. |
Interfaces
| AdditionalPolicyConfig |
Wordt gebruikt voor het configureren van extra beleidsregels die zijn toegevoegd aan de pijplijn tijdens de bouw. |
| 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 samengesteld 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 moet 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 API-antwoorddeserialisatie. |
| DictionaryMapper |
Een mapper die gewone JavaScript-objecten beschrijft die worden gebruikt als sleutel-/waardeparen. |
| DictionaryMapperType |
Hiermee kunt u een mapper maken waarin wordt beschreven hoe u een woordenlijst met toegewezen waarden kunt parseren. |
| EnumMapper |
Een mapper die een opsommingswaarde beschrijft. |
| EnumMapperType |
Helpt bij het bouwen van een mapper die beschrijft hoe u een opsommingswaarde kunt parseren. |
| FullOperationResponse |
Wrapper-object voor http-aanvraag en -antwoord. Het gedeserialiseerde object wordt opgeslagen in de eigenschap |
| 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 gehele bereiken en tekenreeks regex. |
| OperationArguments |
Een verzameling eigenschappen die van toepassing zijn op één aanroep van een bewerking. |
| OperationOptions |
Het type basisopties voor alle bewerkingen. |
| OperationParameter |
Een algemene interface die door alle bewerkingsparameters wordt uitgebreid. |
| OperationQueryParameter |
Een parameter voor een bewerking die wordt toegevoegd als een queryparameter 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 onderscheid te maken tussen gediscrimineerde type unions. Als het antwoord bijvoorbeeld veel shapes kan bevatten, maar ook een 'soort' veld (of vergelijkbaar), kan dat veld worden gebruikt om te bepalen hoe het antwoord op het juiste type moet worden gedeserialiseerd. |
| SequenceMapper |
Een mapper die matrices beschrijft. |
| SequenceMapperType |
Helpt bij het bouwen van een mapper die beschrijft hoe u een reeks toegewezen waarden kunt parseren. |
| 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 inpakken en uitpakken van datums en andere gecodeerde typen die niet intrinsiek zijn voor JSON. Hiermee kunt u 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 van een eenvoudige mapper. |
| SpanConfig |
Configuratie voor het maken van een nieuwe traceringsspanne |
| XmlOptions |
Opties voor het beheren van 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 |
Het type 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 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 callback voor de Roep de Zodra dit is opgegeven, wordt het Voorbeeld van een uitdaging met claims: |
| authorize |
Definieert een callback voor het afhandelen van verificatievraag voor Storage-API's. Hiermee wordt het bearer-uitdagingsproces geïmplementeerd dat hier wordt beschreven: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling heeft specifieke functies voor opslag die vertrekt naar de algemene AAD-uitdagingsdocumenten. |
| create |
Hiermee maakt u een nieuwe pijplijn voor gebruik met een serviceclient. Voegt standaard toe aan deserializationPolicy. Voegt ook toe aan bearerTokenAuthenticationPolicy als een TokenCredential is doorgegeven. |
| create |
Methode waarmee een Serializer wordt gemaakt en geretourneerd. |
| deserialization |
Dit beleid verwerkt het parseren van antwoorden volgens OperationSpecs op de aanvraag. |
| serialization |
Dit beleid verwerkt het samenstellen van de aanvraagbody en headers met behulp van een OperationSpec en OperationArguments op de aanvraag. |
Functiedetails
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Deze functie kan worden gebruikt als callback voor de bearerTokenAuthenticationPolicy van @azure/core-rest-pipeline, ter ondersteuning van CAE-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 policy = bearerTokenAuthenticationPolicy({
challengeCallbacks: {
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
},
scopes: ["https://service/.default"],
});
Zodra dit is opgegeven, wordt het bearerTokenAuthenticationPolicy-beleid intern omgaan met CAE-uitdagingen (Continuous Access Evaluation).
Wanneer een uitdaging niet kan worden voltooid, retourneert het 401(niet-geautoriseerde) antwoord van ARM.
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 verificatievraag voor Storage-API's. Hiermee wordt het bearer-uitdagingsproces geïmplementeerd dat hier wordt beschreven: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling heeft specifieke functies voor opslag die vertrekt 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 aan deserializationPolicy. Voegt ook toe aan 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 waarmee een Serializer wordt gemaakt en geretourneerd.
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 volgens OperationSpecs op 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 op de aanvraag.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParameters
- options
- SerializationPolicyOptions