AadHttpClient class
AadHttpClient se usa para realizar llamadas REST a una aplicación de Azure AD.
Comentarios
Esta clase se marca como @sealed. Las subclases no deben ampliarla.
Para comunicarse con SharePoint, use la clase SPHttpClient en su lugar. Para comunicarse con Microsoft Graph, use la clase MSGraphClient .
Constructores
| (constructor)(service |
Construye una nueva instancia de la |
Propiedades
| configurations | Objetos AadHttpClientConfiguration predefinidos estándar para su uso con la clase AadHttpClient. |
Métodos
| fetch(url, configuration, options) | Realiza una llamada de servicio REST. |
| get(url, configuration, options) | Llama a fetch(), pero establece el método en "GET". |
| post(url, configuration, options) | Llama a fetch(), pero establece el método en "POST". |
Detalles del constructor
(constructor)(serviceScope, resourceEndpoint, options)
Construye una nueva instancia de la AadHttpClient clase
constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);Parámetros
- serviceScope
- ServiceScope
El ámbito de servicio es necesario para recuperar algunos de los componentes internos de la clase.
- resourceEndpoint
-
string
Recurso para el que se debe obtener el token.
- options
- IAadHttpClientOptions
Opciones de configuración para que la solicitud obtenga un token de acceso.
Detalles de las propiedades
configurations
Objetos AadHttpClientConfiguration predefinidos estándar para su uso con la clase AadHttpClient.
static readonly configurations: IAadHttpClientConfigurations;Valor de propiedad
Detalles del método
fetch(url, configuration, options)
Realiza una llamada de servicio REST.
fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Parámetros
- url
-
string
Se llamará a la dirección URL del punto de conexión en la que se capturará.
- configuration
- AadHttpClientConfiguration
Determina el comportamiento predeterminado de HttpClient; normalmente debe ser el número de versión más reciente de HttpClientConfigurations.
- options
- IHttpClientOptions
Opciones adicionales que afectan a la solicitud.
Devoluciones
Promise<HttpClientResponse>
Una promesa que devolverá el resultado.
Comentarios
Aunque la subclase AadHttpClient agrega mejoras adicionales, los parámetros y la semántica de HttpClient.fetch() son básicamente los mismos que el estándar de LA API DE WHATWG que se documenta aquí: https://fetch.spec.whatwg.org/
get(url, configuration, options)
Llama a fetch(), pero establece el método en "GET".
get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;Parámetros
- url
-
string
Se llamará a la dirección URL del punto de conexión en la que se capturará.
- configuration
- AadHttpClientConfiguration
Determina el comportamiento predeterminado de HttpClient; normalmente debe ser el número de versión más reciente de HttpClientConfigurations.
- options
- IHttpClientOptions
Opciones adicionales que afectan a la solicitud.
Devoluciones
Promise<HttpClientResponse>
Una promesa que devolverá el resultado.
post(url, configuration, options)
Llama a fetch(), pero establece el método en "POST".
post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Parámetros
- url
-
string
Se llamará a la dirección URL del punto de conexión en la que se capturará.
- configuration
- AadHttpClientConfiguration
Determina el comportamiento predeterminado de HttpClient; normalmente debe ser el número de versión más reciente de HttpClientConfigurations.
- options
- IHttpClientOptions
Opciones adicionales que afectan a la solicitud.
Devoluciones
Promise<HttpClientResponse>
Una promesa que devolverá el resultado.