AadHttpClient class
AadHttpClient wird verwendet, um REST-Aufrufe für eine Azure AD-Anwendung auszuführen.
Hinweise
Diese Klasse ist als @sealedgekennzeichnet. Unterklassen sollten sie nicht erweitern.
Verwenden Sie für die Kommunikation mit SharePoint stattdessen die SPHttpClient-Klasse . Verwenden Sie für die Kommunikation mit Microsoft Graph die MSGraphClient-Klasse .
Konstruktoren
| (constructor)(service |
Erstellt eine neue instance der |
Eigenschaften
| configurations | Die standardmäßigen vordefinierten AadHttpClientConfiguration-Objekte für die Verwendung mit der AadHttpClient-Klasse. |
Methoden
| fetch(url, configuration, options) | Führt einen REST-Dienstanruf aus. |
| get(url, configuration, options) | Ruft fetch() auf, legt die Methode jedoch auf "GET" fest. |
| post(url, configuration, options) | Ruft fetch() auf, legt aber die Methode auf "POST" fest. |
Details zum Konstruktor
(constructor)(serviceScope, resourceEndpoint, options)
Erstellt eine neue instance der AadHttpClient -Klasse
constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);Parameter
- serviceScope
- ServiceScope
Der Dienstbereich ist erforderlich, um einige der internen Komponenten der Klasse abzurufen.
- resourceEndpoint
-
string
Die Ressource, für die das Token abgerufen werden soll.
- options
- IAadHttpClientOptions
Konfigurationsoptionen für die Anforderung zum Abrufen eines Zugriffstokens.
Details zur Eigenschaft
configurations
Die standardmäßigen vordefinierten AadHttpClientConfiguration-Objekte für die Verwendung mit der AadHttpClient-Klasse.
static readonly configurations: IAadHttpClientConfigurations;Eigenschaftswert
Details zur Methode
fetch(url, configuration, options)
Führt einen REST-Dienstanruf aus.
fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Parameter
- url
-
string
Die Endpunkt-URL, für die abgerufen wird.
- configuration
- AadHttpClientConfiguration
Bestimmt das Standardverhalten von HttpClient; Normalerweise sollte dies die neueste Versionsnummer von HttpClientConfigurations sein.
- options
- IHttpClientOptions
Zusätzliche Optionen, die sich auf die Anforderung auswirken.
Gibt zurück
Promise<HttpClientResponse>
Eine Zusage, die das Ergebnis zurückgibt.
Hinweise
Obwohl die AadHttpClient-Unterklasse zusätzliche Verbesserungen hinzufügt, sind die Parameter und die Semantik für HttpClient.fetch() im Wesentlichen identisch mit dem WHATWG-API-Standard, der hier dokumentiert ist: https://fetch.spec.whatwg.org/
get(url, configuration, options)
Ruft fetch() auf, legt die Methode jedoch auf "GET" fest.
get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;Parameter
- url
-
string
Die Endpunkt-URL, für die abgerufen wird.
- configuration
- AadHttpClientConfiguration
Bestimmt das Standardverhalten von HttpClient; Normalerweise sollte dies die neueste Versionsnummer von HttpClientConfigurations sein.
- options
- IHttpClientOptions
Zusätzliche Optionen, die sich auf die Anforderung auswirken.
Gibt zurück
Promise<HttpClientResponse>
Eine Zusage, die das Ergebnis zurückgibt.
post(url, configuration, options)
Ruft fetch() auf, legt aber die Methode auf "POST" fest.
post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Parameter
- url
-
string
Die Endpunkt-URL, für die abgerufen wird.
- configuration
- AadHttpClientConfiguration
Bestimmt das Standardverhalten von HttpClient; Normalerweise sollte dies die neueste Versionsnummer von HttpClientConfigurations sein.
- options
- IHttpClientOptions
Zusätzliche Optionen, die sich auf die Anforderung auswirken.
Gibt zurück
Promise<HttpClientResponse>
Eine Zusage, die das Ergebnis zurückgibt.