AadHttpClient class
AadHttpClient est utilisé pour effectuer des appels REST sur une application Azure AD.
Remarques
Cette classe est marquée comme @sealed. Les sous-classes ne doivent pas l’étendre.
Pour communiquer avec SharePoint, utilisez plutôt la classe SPHttpClient . Pour communiquer avec Microsoft Graph, utilisez la classe MSGraphClient .
Constructeurs
| (constructor)(service |
Construit une nouvelle instance de la |
Propriétés
| configurations | Objets AadHttpClientConfiguration prédéfinis standard à utiliser avec la classe AadHttpClient. |
Méthodes
| fetch(url, configuration, options) | Effectue un appel du service Rest. |
| get(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « GET ». |
| post(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « POST ». |
Détails du constructeur
(constructor)(serviceScope, resourceEndpoint, options)
Construit une nouvelle instance de la AadHttpClient classe
constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);Paramètres
- serviceScope
- ServiceScope
L’étendue du service est nécessaire pour récupérer certains des composants internes de la classe.
- resourceEndpoint
-
string
Ressource pour laquelle le jeton doit être obtenu.
- options
- IAadHttpClientOptions
Options de configuration pour la demande d’obtention d’un jeton d’accès.
Détails de la propriété
configurations
Objets AadHttpClientConfiguration prédéfinis standard à utiliser avec la classe AadHttpClient.
static readonly configurations: IAadHttpClientConfigurations;Valeur de propriété
Détails de la méthode
fetch(url, configuration, options)
Effectue un appel du service Rest.
fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Paramètres
- url
-
string
L’URL de point de terminaison qui récupère sera appelée sur.
- configuration
- AadHttpClientConfiguration
Détermine le comportement par défaut de HttpClient ; normalement, il doit s’agir du numéro de version le plus récent de HttpClientConfigurations.
- options
- IHttpClientOptions
Options supplémentaires qui affectent la requête.
Retours
Promise<HttpClientResponse>
Promesse qui retourne le résultat.
Remarques
Bien que la sous-classe AadHttpClient ajoute des améliorations supplémentaires, les paramètres et la sémantique de HttpClient.fetch() sont essentiellement identiques à la norme d’API WHATWG documentée ici : https://fetch.spec.whatwg.org/
get(url, configuration, options)
Appelle fetch(), mais définit la méthode sur « GET ».
get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;Paramètres
- url
-
string
L’URL de point de terminaison qui récupère sera appelée sur.
- configuration
- AadHttpClientConfiguration
Détermine le comportement par défaut de HttpClient ; normalement, il doit s’agir du numéro de version le plus récent de HttpClientConfigurations.
- options
- IHttpClientOptions
Options supplémentaires qui affectent la requête.
Retours
Promise<HttpClientResponse>
Promesse qui retourne le résultat.
post(url, configuration, options)
Appelle fetch(), mais définit la méthode sur « POST ».
post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Paramètres
- url
-
string
L’URL de point de terminaison qui récupère sera appelée sur.
- configuration
- AadHttpClientConfiguration
Détermine le comportement par défaut de HttpClient ; normalement, il doit s’agir du numéro de version le plus récent de HttpClientConfigurations.
- options
- IHttpClientOptions
Options supplémentaires qui affectent la requête.
Retours
Promise<HttpClientResponse>
Promesse qui retourne le résultat.