Freigeben über

@azure/core-client package

  • Referenz

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

Die allgemeinen Optionen, die Clients auf hoher Ebene verfügbar machen 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 Mappern zugeordnet wird.

Es sollte nur eine der folgenden Eigenschaften vorhanden sein: className, modelProperties und additionalProperties.
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 eigenschaft parsedBody gespeichert, wenn der Antworttext in JSON oder XML empfangen wird.
InternalClientPipelineOptions

Optionen zum Erstellen einer Pipeline zur Verwendung mit ServiceClient. Hauptsächlich zum Anpassen der Authentifizierungsrichtlinie (bei Verwendung der Tokenauthentifizierung) oder der Deserialisierungsoptionen bei Verwendung von XML.
MapperConstraints

Beschreibung verschiedener Werteinschränkungen wie ganzzahlige Bereiche und Zeichenfolgen-Regex.
OperationArguments

Eine Auflistung von Eigenschaften, die auf einen einzelnen Aufruf eines Vorgangs angewendet werden.
OperationOptions

Der Basisoptionentyp für alle Vorgänge.
OperationParameter

Eine allgemeine Schnittstelle, die alle Operation-Parameter erweitern.
OperationQueryParameter

Ein Parameter für einen Vorgang, der als Abfrageparameter zur HTTP-Anforderung des Vorgangs hinzugefügt wird.
OperationRequestInfo

Metadaten, die zum ordnungsgemäßen Analysieren einer Antwort verwendet werden.
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 in die Anforderungs-URL des Vorgangs ersetzt wird.
PolymorphicDiscriminator

Wird verwendet, um mehrdeutige Diskriminierte Vereinigungen zu unterscheiden. Wenn die Antwort beispielsweise viele Shapes enthalten kann, aber auch ein "Art"-Feld (oder ähnliches) enthält, kann dieses Feld verwendet werden, um zu bestimmen, wie die Antwort auf den richtigen Typ deserialisiert wird.
SequenceMapper

Ein Mapper, der Arrays beschreibt.
SequenceMapperType

Hilft beim Erstellen eines Mappers, der beschreibt, wie eine Sequenz von zugeordneten Werten analysiert wird.
SerializationPolicyOptions

Optionen zum Konfigurieren der API-Anforderungs serialisierung.
Serializer

Wird verwendet, um unformatierte Antwortobjekte endgültigen Shapes zuzuordnen. Hilft beim Packen und Entpacken von Datumsangaben und anderen codierten Typen, die nicht in JSON systemintern sind. Ermöglicht außerdem das Abrufen von Werten aus Kopfzeilen 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 Mappers.
SpanConfig

Konfiguration zum Erstellen einer neuen Ablaufverfolgungsspanne
XmlOptions

Optionen zum Steuern des Verhaltens des XML-Parsers und des Generators.

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 Korrekturhilfen.
ParameterPath

Codiert, wie eine bestimmte Eigenschaft für ein Objekt erreicht wird.
QueryCollectionFormat

Das Format, das verwendet wird, um ein Array von Werten für einen Abfrageparameterwert zu verbinden.
RawResponseCallback

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

Functions

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Diese Funktion kann als Rückruf für die bearerTokenAuthenticationPolicy von @azure/core-rest-pipelineverwendet werden, um CAE-Herausforderungen zu unterstützen: Kontinuierliche Zugriffsauswertung.

Rufen Sie die bearerTokenAuthenticationPolicy mit den folgenden Optionen auf:

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

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

Nach der Bereitstellung übernimmt die bearerTokenAuthenticationPolicy-Richtlinie intern herausforderungen bei der Kontinuierlichen Zugriffsauswertung (Continuous Access Evaluation, CAE). Wenn sie keine Herausforderung abschließen kann, wird die Antwort 401 (nicht autorisiert) von ARM zurückgegeben.

Beispielabfrage mit Ansprüchen:

Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Definiert einen Rückruf zur Behandlung von Authentifizierungsabfragen für Speicher-APIs. Dadurch wird der hier beschriebene Bearer-Abfrageprozess implementiert: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Behandlung verfügt über spezifische Features für den Speicher, der zu den allgemeinen AAD-Abfragedokumenten wechselt.
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.
createSerializer({[key: string]: any}, boolean)

Methode, die einen Serialisierer erstellt und zurückgibt.
deserializationPolicy(DeserializationPolicyOptions)

Diese Richtlinie behandelt die Analyse von Antworten gemäß OperationSpecs für die Anforderung.
serializationPolicy(SerializationPolicyOptions)

Diese Richtlinie verarbeitet das Zusammenstellen des Anforderungstexts und der Header mithilfe einer OperationSpec und OperationArguments für die Anforderung.

Details zur Funktion

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Diese Funktion kann als Rückruf für die bearerTokenAuthenticationPolicy von @azure/core-rest-pipelineverwendet werden, um CAE-Herausforderungen zu unterstützen: Kontinuierliche Zugriffsauswertung.

Rufen Sie die bearerTokenAuthenticationPolicy mit den folgenden Optionen auf:

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

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

Nach der Bereitstellung übernimmt die bearerTokenAuthenticationPolicy-Richtlinie intern herausforderungen bei der Kontinuierlichen Zugriffsauswertung (Continuous Access Evaluation, CAE). Wenn sie keine Herausforderung abschließen kann, wird die Antwort 401 (nicht autorisiert) von ARM zurückgegeben.

Beispielabfrage 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 zur Behandlung von Authentifizierungsabfragen für Speicher-APIs. Dadurch wird der hier beschriebene Bearer-Abfrageprozess implementiert: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Behandlung verfügt über spezifische Features für den Speicher, der zu den allgemeinen AAD-Abfragedokumenten wechselt.

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): Pipeline

Parameter

options
InternalClientPipelineOptions

Optionen zum Anpassen der erstellten Pipeline.

Gibt zurück

Pipeline

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

Methode, die einen Serialisierer erstellt und zurückgibt.

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

Parameter

modelMappers

{[key: string]: any}

Bekannte Modelle, die zugeordnet werden sollen

isXML

boolean

Wenn XML unterstützt werden soll

Gibt zurück

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Diese Richtlinie behandelt die Analyse von Antworten gemäß OperationSpecs für die Anforderung.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parameter

options
DeserializationPolicyOptions

Gibt zurück

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Diese Richtlinie verarbeitet das Zusammenstellen des Anforderungstexts und der Header mithilfe einer OperationSpec und OperationArguments für die Anforderung.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parameter

options
SerializationPolicyOptions

Gibt zurück

PipelinePolicy