@azure/core-client package
Classes
| ServiceClient |
Initialise une nouvelle instance de ServiceClient. |
Interfaces
| AdditionalPolicyConfig |
Permet de configurer des stratégies supplémentaires ajoutées au pipeline lors de la construction. |
| BaseMapper |
Définition de base d’un mappeur. Peut être utilisé pour les objets XML et JavaScript bruts. |
| CommonClientOptions |
L’ensemble commun d’options que les clients de haut niveau sont censés exposer. |
| CompositeMapper |
Mappeur composé d’autres mappeurs. |
| CompositeMapperType |
Permet de créer un mappeur qui décrit comment mapper un ensemble de propriétés d’un objet basé sur d’autres mappeurs. Une seule des propriétés suivantes doit être présente : |
| DeserializationContentTypes |
Types de contenu qui indiquent qu’une réponse d’opération doit être désérialisée de manière particulière. |
| DeserializationPolicyOptions |
Options de configuration de la désérialisation de la réponse de l’API. |
| DictionaryMapper |
Mappeur décrivant des objets JavaScript simples utilisés comme paires clé/valeur. |
| DictionaryMapperType |
Permet de créer un mappeur qui décrit comment analyser un dictionnaire de valeurs mappées. |
| EnumMapper |
Mappeur décrivant une valeur d’énumération. |
| EnumMapperType |
Permet de créer un mappeur qui décrit comment analyser une valeur d’énumération. |
| FullOperationResponse |
Objet wrapper pour la requête et la réponse http. L’objet désérialisé est stocké dans la propriété |
| InternalClientPipelineOptions |
Options de création d’un pipeline à utiliser avec ServiceClient. Principalement pour personnaliser la stratégie d’authentification (si vous utilisez l’authentification de jeton) ou les options de désérialisation lors de l’utilisation de XML. |
| MapperConstraints |
Description de diverses contraintes de valeur, telles que les plages d’entiers et les expressions régulières de chaîne. |
| OperationArguments |
Collection de propriétés qui s’appliquent à un appel unique d’une opération. |
| OperationOptions |
Type d’options de base pour toutes les opérations. |
| OperationParameter |
Interface commune étendue à tous les paramètres d’opération. |
| OperationQueryParameter |
Paramètre d’une opération qui sera ajoutée en tant que paramètre de requête à la requête HTTP de l’opération. |
| OperationRequestInfo |
Métadonnées utilisées pour analyser correctement une réponse. |
| OperationRequestOptions |
Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération. |
| OperationResponseMap |
OpérationResponse qui peut être retournée à partir d’une demande d’opération pour un code d’état unique. |
| OperationSpec |
Spécification qui définit une opération. |
| OperationURLParameter |
Paramètre d’une opération qui sera remplacée dans l’URL de requête de l’opération. |
| PolymorphicDiscriminator |
Utilisé pour lever l’ambiguïté des unions de types discriminatoires. Par exemple, si la réponse peut avoir de nombreuses formes, mais inclut également un champ « type » (ou similaire), ce champ peut être utilisé pour déterminer comment désérialiser la réponse au type correct. |
| SequenceMapper |
Mappeur décrivant les tableaux. |
| SequenceMapperType |
Permet de créer un mappeur qui décrit comment analyser une séquence de valeurs mappées. |
| SerializationPolicyOptions |
Options de configuration de la sérialisation des demandes d’API. |
| Serializer |
Permet de mapper des objets de réponse brutes aux formes finales. Permet d’empaqueter et de décompresser des dates et d’autres types encodés qui ne sont pas intrinsèques à JSON. Permet également d’extraire des valeurs à partir d’en-têtes, ainsi que d’insérer des valeurs et des constantes par défaut. |
| SerializerOptions |
Options pour configurer le comportement de sérialisation/de sérialisation. |
| ServiceClientOptions |
Options à fournir lors de la création du client. |
| SimpleMapperType |
Type d’un mappeur simple. |
| SpanConfig |
Configuration pour la création d’une étendue de suivi |
| XmlOptions |
Options pour régir le comportement de l’analyseur xml et du générateur. |
Alias de type
| Mapper |
Les mappeurs sont des définitions des modèles de données utilisés dans la bibliothèque. Ces modèles de données font partie des définitions d’opération ou de client dans les réponses ou les paramètres. |
| MapperType |
Type du mappeur. Inclut les mappeurs connus. |
| OperationRequest |
Alias de type pour la vérification ultérieure. |
| ParameterPath |
Encode comment atteindre une propriété particulière sur un objet. |
| QueryCollectionFormat |
Format qui sera utilisé pour joindre un tableau de valeurs ensemble pour une valeur de paramètre de requête. |
| RawResponseCallback |
Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois. |
Functions
| authorize |
Cette fonction peut être utilisée comme rappel pour la Appelez le Une fois fournie, la stratégie Exemple de défi avec les revendications : |
| authorize |
Définit un rappel pour gérer le défi d’authentification pour les API de stockage. Cela implémente le processus de défi du porteur décrit ici : https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling a des fonctionnalités spécifiques pour le stockage qui part de la documentation générale du défi AAD. |
| create |
Crée un pipeline à utiliser avec un client de service. Ajoute par défaut dans désérializationPolicy. Ajoute également dans bearerTokenAuthenticationPolicy s’il a passé un TokenCredential. |
| create |
Méthode qui crée et retourne un sérialiseur. |
| deserialization |
Cette stratégie gère l’analyse des réponses en fonction d’OperationSpecs sur la demande. |
| serialization |
Cette stratégie gère l’assemblage du corps et des en-têtes de la requête à l’aide d’une opérationSpec et operationArguments sur la requête. |
Informations relatives à la fonction
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Cette fonction peut être utilisée comme rappel pour la bearerTokenAuthenticationPolicy de @azure/core-rest-pipeline, pour prendre en charge les défis de l’AUTORITÉ de certification : évaluation continue de l’accès.
Appelez le bearerTokenAuthenticationPolicy avec les options suivantes :
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
Une fois fournie, la stratégie bearerTokenAuthenticationPolicy gère en interne les défis liés à l’évaluation de l’accès continu (CAE).
Lorsqu’il ne peut pas effectuer de défi, il retourne la réponse 401 (non autorisée) d’ARM.
Exemple de défi avec les revendications :
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>Paramètres
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
Retours
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
Définit un rappel pour gérer le défi d’authentification pour les API de stockage. Cela implémente le processus de défi du porteur décrit ici : https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling a des fonctionnalités spécifiques pour le stockage qui part de la documentation générale du défi AAD.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>Paramètres
- challengeOptions
- AuthorizeRequestOnChallengeOptions
Retours
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
Crée un pipeline à utiliser avec un client de service. Ajoute par défaut dans désérializationPolicy. Ajoute également dans bearerTokenAuthenticationPolicy s’il a passé un TokenCredential.
function createClientPipeline(options?: InternalClientPipelineOptions): PipelineParamètres
- options
- InternalClientPipelineOptions
Options pour personnaliser le pipeline créé.
Retours
createSerializer({[key: string]: any}, boolean)
Méthode qui crée et retourne un sérialiseur.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): SerializerParamètres
- modelMappers
-
{[key: string]: any}
Modèles connus à mapper
- isXML
-
boolean
Si XML doit être pris en charge
Retours
deserializationPolicy(DeserializationPolicyOptions)
Cette stratégie gère l’analyse des réponses en fonction d’OperationSpecs sur la demande.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicyParamètres
- options
- DeserializationPolicyOptions
Retours
serializationPolicy(SerializationPolicyOptions)
Cette stratégie gère l’assemblage du corps et des en-têtes de la requête à l’aide d’une opérationSpec et operationArguments sur la requête.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParamètres
- options
- SerializationPolicyOptions