@azure/core-client package
Klassen
| ServiceClient |
Initialisiert eine neue Instanz des ServiceClient. |
Schnittstellen
| AdditionalPolicyConfig |
Wird verwendet, um zusätzliche Richtlinien zu konfigurieren, die der Pipeline beim Bau hinzugefügt wurden. |
| BaseMapper |
Die Basisdefinition eines Mappers. Kann für XML- und einfache JavaScript-Objekte verwendet werden. |
| CommonClientOptions |
Der allgemeine Satz von Optionen, die von clients auf hoher Ebene verfügbar gemacht werden sollen. |
| CompositeMapper |
Ein Mapper, der aus anderen Mappern besteht. |
| CompositeMapperType |
Hilft beim Erstellen eines Mappers, der beschreibt, wie eine Reihe von Eigenschaften eines Objekts basierend auf anderen Zuordnungen zugeordnet wird. Es sollte nur eine der folgenden Eigenschaften vorhanden sein: |
| DeserializationContentTypes |
Die Inhaltstypen, die angeben, dass eine Vorgangsantwort auf eine bestimmte Weise deserialisiert werden soll. |
| DeserializationPolicyOptions |
Optionen zum Konfigurieren der API-Antwort-Deserialisierung. |
| DictionaryMapper |
Ein Mapper, der einfache JavaScript-Objekte beschreibt, die als Schlüssel-Wert-Paare verwendet werden. |
| DictionaryMapperType |
Hilft beim Erstellen eines Mappers, der beschreibt, wie ein Wörterbuch mit zugeordneten Werten analysiert wird. |
| EnumMapper |
Ein Mapper, der einen Enumerationswert beschreibt. |
| EnumMapperType |
Hilft beim Erstellen eines Mappers, der beschreibt, wie ein Enumerationswert analysiert wird. |
| FullOperationResponse |
Wrapperobjekt für HTTP-Anforderung und -Antwort. Das deserialisierte Objekt wird in der |
| InternalClientPipelineOptions |
Optionen zum Erstellen einer Pipeline, die mit ServiceClient verwendet werden soll. Hauptsächlich zum Anpassen der Authentifizierungsrichtlinie (bei Verwendung der Tokenauthentifizierung) oder der Deserialisierungsoptionen bei Verwendung von XML. |
| MapperConstraints |
Beschreibung verschiedener Werteinschränkungen wie Ganzzahlbereiche und Zeichenfolgenregex. |
| OperationArguments |
Eine Auflistung von Eigenschaften, die auf einen einzelnen Aufruf eines Vorgangs angewendet werden. |
| OperationOptions |
Der Basisoptionentyp für alle Vorgänge. |
| OperationParameter |
Eine gemeinsame Schnittstelle, die von allen Operation-Parametern erweitert wird. |
| OperationQueryParameter |
Ein Parameter für einen Vorgang, der der HTTP-Anforderung des Vorgangs als Abfrageparameter hinzugefügt wird. |
| OperationRequestInfo |
Metadaten, die verwendet werden, um eine Antwort ordnungsgemäß zu analysieren. |
| OperationRequestOptions |
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden. |
| OperationResponseMap |
Eine OperationResponse, die von einer Vorgangsanforderung für einen einzelnen Statuscode zurückgegeben werden kann. |
| OperationSpec |
Eine Spezifikation, die einen Vorgang definiert. |
| OperationURLParameter |
Ein Parameter für einen Vorgang, der durch die Anforderungs-URL des Vorgangs ersetzt wird. |
| PolymorphicDiscriminator |
Wird verwendet, um diskriminierte Typverflechtung zu disambiguieren. Wenn die Antwort beispielsweise viele Shapes enthalten kann, aber auch ein "Kind"-Feld (oder ähnliches) enthält, kann dieses Feld verwendet werden, um zu bestimmen, wie die Antwort auf den richtigen Typ deserialisiert werden soll. |
| SequenceMapper |
Ein Mapper, der Arrays beschreibt. |
| SequenceMapperType |
Hilft beim Erstellen eines Mappers, der beschreibt, wie eine Sequenz zugeordneter Werte analysiert wird. |
| SerializationPolicyOptions |
Optionen zum Konfigurieren der API-Anforderungsserialisierung. |
| Serializer |
Wird verwendet, um rohe Antwortobjekte endgültigen Shapes zuzuordnen. Hilft beim Packen und Entpacken von Datumsangaben und anderen codierten Typen, die nicht in JSON enthalten sind. Ermöglicht auch das Pullen von Werten aus Headern sowie das Einfügen von Standardwerten und Konstanten. |
| SerializerOptions |
Optionen zum Konfigurieren des Serialisierungs-/De serialisierungsverhaltens. |
| ServiceClientOptions |
Optionen, die beim Erstellen des Clients bereitgestellt werden sollen. |
| SimpleMapperType |
Der Typ eines einfachen Zuordnungsvorgangs. |
| SpanConfig |
Konfiguration zum Erstellen einer neuen Ablaufverfolgungsspanne |
| XmlOptions |
Optionen zum Steuern des Verhaltens von XML-Parser und -Generatoren. |
Typaliase
| Mapper |
Mapper sind Definitionen der Datenmodelle, die in der Bibliothek verwendet werden. Diese Datenmodelle sind Teil der Vorgangs- oder Clientdefinitionen in den Antworten oder Parametern. |
| MapperType |
Typ des Mappers. Enthält bekannte Mapper. |
| OperationRequest |
Ein Typalias für zukünftige Korrekturen. |
| ParameterPath |
Codiert, wie eine bestimmte Eigenschaft für ein Objekt erreicht wird. |
| QueryCollectionFormat |
Das Format, das zum Verknüpfen eines Arrays von Werten für einen Abfrageparameterwert verwendet wird. |
| RawResponseCallback |
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden. |
Functions
| authorize |
Diese Funktion kann als Rückruf für den Rufen Sie die Sobald die Richtlinie bereitgestellt wurde, werden herausforderungen bei der Beispiel-Challenge mit Ansprüchen: |
| authorize |
Definiert einen Rückruf, um die Authentifizierungsanforderung für Speicher-APIs zu behandeln. Dadurch wird der hier beschriebene Bearer Challenge-Prozess implementiert: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Die Verarbeitung verfügt über spezifische Funktionen für die Speicherung, die zur allgemeinen Dokumentation zu AAD-Herausforderungen übergibt. |
| create |
Erstellt eine neue Pipeline für die Verwendung mit einem Dienstclient. Fügt standardmäßig in deserializationPolicy hinzu. Fügt auch in bearerTokenAuthenticationPolicy hinzu, wenn ein TokenCredential übergeben wurde. |
| create |
Methode, die einen Serialisierer erstellt und zurückgibt. |
| deserialization |
Diese Richtlinie behandelt das Analysieren von Antworten gemäß OperationSpecs auf die Anforderung. |
| serialization |
Diese Richtlinie verarbeitet das Zusammensetzen des Anforderungstexts und der Header mithilfe von OperationSpec und OperationArguments für die Anforderung. |
Details zur Funktion
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Diese Funktion kann als Rückruf für den bearerTokenAuthenticationPolicy von @azure/core-rest-pipelineverwendet werden, um CAE-Herausforderungen zu unterstützen: Continuous Access Evaluation.
Rufen Sie die bearerTokenAuthenticationPolicy mit den folgenden Optionen auf:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
Sobald die Richtlinie bereitgestellt wurde, werden herausforderungen bei der bearerTokenAuthenticationPolicy kontinuierlichen Zugriffsauswertung (Continuous Access Evaluation, CAE) intern behandelt.
Wenn eine Herausforderung nicht abgeschlossen werden kann, wird die Antwort 401 (nicht autorisiert) von ARM zurückgegeben.
Beispiel-Challenge mit Ansprüchen:
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>Parameter
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
Gibt zurück
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
Definiert einen Rückruf, um die Authentifizierungsanforderung für Speicher-APIs zu behandeln. Dadurch wird der hier beschriebene Bearer Challenge-Prozess implementiert: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Die Verarbeitung verfügt über spezifische Funktionen für die Speicherung, die zur allgemeinen Dokumentation zu AAD-Herausforderungen übergibt.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>Parameter
- challengeOptions
- AuthorizeRequestOnChallengeOptions
Gibt zurück
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
Erstellt eine neue Pipeline für die Verwendung mit einem Dienstclient. Fügt standardmäßig in deserializationPolicy hinzu. Fügt auch in bearerTokenAuthenticationPolicy hinzu, wenn ein TokenCredential übergeben wurde.
function createClientPipeline(options?: InternalClientPipelineOptions): PipelineParameter
- options
- InternalClientPipelineOptions
Optionen zum Anpassen der erstellten Pipeline.
Gibt zurück
createSerializer({[key: string]: any}, boolean)
Methode, die einen Serialisierer erstellt und zurückgibt.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): SerializerParameter
- modelMappers
-
{[key: string]: any}
Bekannte Modelle, die zugeordnet werden sollen
- isXML
-
boolean
Wenn XML unterstützt werden soll
Gibt zurück
deserializationPolicy(DeserializationPolicyOptions)
Diese Richtlinie behandelt das Analysieren von Antworten gemäß OperationSpecs auf die Anforderung.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicyParameter
- options
- DeserializationPolicyOptions
Gibt zurück
serializationPolicy(SerializationPolicyOptions)
Diese Richtlinie verarbeitet das Zusammensetzen des Anforderungstexts und der Header mithilfe von OperationSpec und OperationArguments für die Anforderung.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParameter
- options
- SerializationPolicyOptions