AadHttpClient class
AadHttpClient 用于对 Azure AD 应用程序执行 REST 调用。
注解
此类标记为 @sealed
。 子类不应扩展它。
若要与 SharePoint 通信,请改用 SPHttpClient 类。 若要与 Microsoft Graph 通信,请使用 MSGraphClient 类。
构造函数
(constructor)(service |
构造 类的新实例 |
属性
configurations | 用于 AadHttpClient 类的标准预定义 AadHttpClientConfiguration 对象。 |
方法
fetch(url, configuration, options) | 执行 REST 服务调用。 |
get(url, configuration, options) | 调用 fetch () ,但将 方法设置为“GET”。 |
post(url, configuration, options) | 调用 fetch () ,但将 方法设置为“POST”。 |
构造函数详细信息
(constructor)(serviceScope, resourceEndpoint, options)
构造 类的新实例AadHttpClient
constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);
参数
- serviceScope
- ServiceScope
需要服务范围来检索类的某些内部组件。
- resourceEndpoint
-
string
应为其获取令牌的资源。
- options
- IAadHttpClientOptions
用于获取访问令牌的请求的配置选项。
属性详细信息
configurations
用于 AadHttpClient 类的标准预定义 AadHttpClientConfiguration 对象。
static readonly configurations: IAadHttpClientConfigurations;
属性值
方法详细信息
fetch(url, configuration, options)
执行 REST 服务调用。
fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;
参数
- url
-
string
将在其上调用提取的终结点 URL。
- configuration
- AadHttpClientConfiguration
确定 HttpClient 的默认行为;通常,这应该是 HttpClientConfigurations 的最新版本号。
- options
- IHttpClientOptions
影响请求的其他选项。
返回
Promise<HttpClientResponse>
将返回结果的承诺。
注解
尽管 AadHttpClient 子类添加了其他增强功能,但 HttpClient.fetch () 的参数和语义实质上与此处记录的 WHATWG API 标准相同: https://fetch.spec.whatwg.org/
get(url, configuration, options)
调用 fetch () ,但将 方法设置为“GET”。
get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;
参数
- url
-
string
将在其上调用提取的终结点 URL。
- configuration
- AadHttpClientConfiguration
确定 HttpClient 的默认行为;通常,这应该是 HttpClientConfigurations 的最新版本号。
- options
- IHttpClientOptions
影响请求的其他选项。
返回
Promise<HttpClientResponse>
将返回结果的承诺。
post(url, configuration, options)
调用 fetch () ,但将 方法设置为“POST”。
post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;
参数
- url
-
string
将在其上调用提取的终结点 URL。
- configuration
- AadHttpClientConfiguration
确定 HttpClient 的默认行为;通常,这应该是 HttpClientConfigurations 的最新版本号。
- options
- IHttpClientOptions
影响请求的其他选项。
返回
Promise<HttpClientResponse>
将返回结果的承诺。