@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 au moment de la construction. |
| BaseMapper |
Définition de base d’un mappeur. Peut être utilisé pour les objets XML et JavaScript bruts. |
| CommonClientOptions |
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 en fonction 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 d’une manière particulière. |
| DeserializationPolicyOptions |
Options permettant de configurer la désérialisation de la réponse d’API. |
| DictionaryMapper |
Mappeur décrivant des objets JavaScript bruts 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 |
| 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 valeurs 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 que tous les paramètres Operation étendent. |
| OperationQueryParameter |
Paramètre pour 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 type discriminatoires. Par exemple, si la réponse peut avoir plusieurs formes, mais qu’elle inclut également un champ « kind » (ou similaire), ce champ peut être utilisé pour déterminer comment désérialiser la réponse au type correct. |
| SequenceMapper |
Mappeur décrivant des tableaux. |
| SequenceMapperType |
Aide à créer un mappeur qui décrit comment analyser une séquence de valeurs mappées. |
| SerializationPolicyOptions |
Options permettant de configurer la sérialisation des demandes d’API. |
| Serializer |
Utilisé pour mapper des objets de réponse bruts aux formes finales. Permet d’empaquetage et de décompression de 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 permettant de configurer le comportement de sérialisation/dés 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 nouvelle étendue de suivi |
| XmlOptions |
Options pour régir le comportement de l’analyseur et du générateur xml. |
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 Opération ou Client dans les réponses ou paramètres. |
| MapperType |
Type du mappeur. Inclut les mappeurs connus. |
| OperationRequest |
Alias de type pour la vérification future. |
| ParameterPath |
Encode comment atteindre une propriété particulière sur un objet. |
| QueryCollectionFormat |
Format qui sera utilisé pour joindre un tableau de valeurs 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. |
Fonctions
| authorize |
Cette fonction peut être utilisée comme rappel pour le de , afin de Appelez le Une fois fournie, la Exemple de défi avec des 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 remise en question du porteur décrit ici : https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge La gestion a des fonctionnalités spécifiques pour le stockage qui partent des documents de défis AAD généraux. |
| create |
Crée un pipeline à utiliser avec un client de service. Ajoute dans désérializationPolicy par défaut. Ajoute également dans bearerTokenAuthenticationPolicy si un TokenCredential a été passé. |
| create |
Méthode qui crée et retourne un sérialiseur. |
| deserialization |
Cette stratégie gère l’analyse des réponses en fonction de 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’un OperationSpec et d’un OperationArguments sur la demande. |
Informations relatives à la fonction
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Cette fonction peut être utilisée comme rappel pour le de , afin de @azure/core-rest-pipelineprendre en charge les bearerTokenAuthenticationPolicy défis de l’ENVIRONNEMENT : É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 bearerTokenAuthenticationPolicy stratégie gère en interne les défis liés à l’évaluation continue de l’accès (CAE).
Lorsqu’il ne parvient pas à effectuer un défi, il retourne la réponse 401 (non autorisée) d’ARM.
Exemple de défi avec des 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 remise en question du porteur décrit ici : https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge La gestion a des fonctionnalités spécifiques pour le stockage qui partent des documents de défis AAD généraux.
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 dans désérializationPolicy par défaut. Ajoute également dans bearerTokenAuthenticationPolicy si un TokenCredential a été passé.
function createClientPipeline(options?: InternalClientPipelineOptions): PipelineParamètres
- options
- InternalClientPipelineOptions
Options permettant de 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 de 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’un OperationSpec et d’un OperationArguments sur la demande.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParamètres
- options
- SerializationPolicyOptions