Lenguaje

DownstreamApiOptionsReadOnlyHttpMethod Clase

Definición

Espacio de nombres:
Microsoft.Identity.Abstractions
Ensamblado:
Microsoft.Identity.Abstractions.dll
Paquete:
Microsoft.Identity.Abstractions v12.7.0

Especialización de donde DownstreamApiOptionsHttpMethod no se puede establecer más allá de su construcción.

public class DownstreamApiOptionsReadOnlyHttpMethod : Microsoft.Identity.Abstractions.DownstreamApiOptions
type DownstreamApiOptionsReadOnlyHttpMethod = class
    inherit DownstreamApiOptions
Public Class DownstreamApiOptionsReadOnlyHttpMethod
Inherits DownstreamApiOptions
Herencia
Object
AuthorizationHeaderProviderOptions
DownstreamApiOptions
DownstreamApiOptionsReadOnlyHttpMethod

Comentarios

Esta clase es útil para proporcionar una mejor experiencia de desarrollador en los métodos especializados de IDownstreamApi donde el método HTTP ya se proporciona por el nombre del método y no debe invalidarse por las opciones. No es necesario usarlo directamente.

Constructores

Nombre Description
DownstreamApiOptionsReadOnlyHttpMethod(DownstreamApiOptions, String)

Constructor fro a DownstreamApiOptions y un método HTTP.

Propiedades

Nombre Description
AcceptHeader

El encabezado HTTP Accept se usa para informar al servidor sobre el tipo de contenido que el cliente espera en la respuesta.

(Heredado de DownstreamApiOptions)
AcquireTokenOptions

Opciones relacionadas con la adquisición de tokens.

(Heredado de AuthorizationHeaderProviderOptions)
BaseUrl

Dirección URL base de la API web de bajada llamada. Por ejemplo "https://graph.microsoft.com/beta/", .

(Heredado de AuthorizationHeaderProviderOptions)
ContentType

Tipo de contenido del cuerpo de la solicitud.

(Heredado de DownstreamApiOptions)
CustomizeHttpRequestMessage

Proporciona una oportunidad para que la aplicación de llamador personalice HttpRequestMessage. Por ejemplo, para personalizar los encabezados. Esto se llama después de que se haya formado el mensaje, incluido el encabezado Authorization, y justo antes de que se envíe el mensaje.

(Heredado de AuthorizationHeaderProviderOptions)
Deserializer

Des serializador opcional. Des serializará la salida de la API web (si existe). Cuando no se proporciona, se devuelve lo siguiente: JsonSerializer.Deserialize<TOutput>(content, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });

(Heredado de DownstreamApiOptions)
ExtraHeaderParameters

Establece encabezados adicionales en la solicitud HTTP en la API web de bajada. Esto no debe confundirse con otra opción para establecer los encabezados de la solicitud en el proveedor de identidades. Consulte ExtraHeadersParameters para ese escenario.

(Heredado de DownstreamApiOptions)
ExtraQueryParameters

Establece los parámetros de consulta de la cadena de consulta de la solicitud HTTP en la API web de nivel inferior. Esto no debe confundirse con otra opción para establecer los parámetros de consulta en la solicitud en el proveedor de identidades. Consulte ExtraQueryParameters para ese escenario.

(Heredado de DownstreamApiOptions)
HttpMethod

Método HTTP que solo se puede leer públicamente.
OnAfterAuthHeaderCreation

Proporciona una oportunidad para que la aplicación de llamador personalice HttpRequestMessagedespués de que se haya establecido el encabezado de autorización (incluido el Authorization encabezado) y justo antes de que se envíe el mensaje, el punto en el que se puede leer o ajustar la solicitud finalizada. Se proporciona para la simetría de nomenclatura con OnBeforeAuthHeaderCreation; comparte este tiempo con el CustomizeHttpRequestMessageexistente , que sigue siendo invocado para la compatibilidad con versiones anteriores. Cuando ambos se establecen, se ejecutan en el mismo punto, por lo que los llamadores no deben depender de su orden relativo. No modifique el material enlazado por un protocolo de enlace de solicitud (SHRq//hb) aquí, ya que se ejecuta después de la firma; use OnBeforeAuthHeaderCreation para ello.

(Heredado de AuthorizationHeaderProviderOptions)
OnBeforeAuthHeaderCreation

Proporciona una oportunidad para que la aplicación de llamador personalice HttpRequestMessageantes de crear el encabezado de autorización. En este punto, el Authorization encabezado aún no está presente. Úselo para dar forma a la solicitud que firma un protocolo de enlace de solicitudes (por ejemplo, signedHttpRequest (SHR) que enlaza la consulta, los encabezados o el cuerpo (las q//hb notificaciones) al token, por lo que la firma cubre la solicitud finalizada. Para observar o ajustar la solicitud después de crear el encabezado, use OnAfterAuthHeaderCreation (o CustomizeHttpRequestMessage).

(Heredado de AuthorizationHeaderProviderOptions)
ProtocolScheme

Nombre del esquema de protocolo usado para crear el encabezado de autorización. De forma predeterminada: "Portador".

(Heredado de AuthorizationHeaderProviderOptions)
RelativePath

Ruta de acceso relativa a BaseUrl (por ejemplo, "me").

(Heredado de AuthorizationHeaderProviderOptions)
RequestAppToken

Describe si se llama a la API de bajada en nombre del propio servicio de llamada (token de aplicación) o en nombre de un usuario procesado por el servicio (token de usuario). Si truees , el token se solicita en nombre de la aplicación. De lo contrario, es en nombre del usuario.

(Heredado de AuthorizationHeaderProviderOptions)
Scopes

Ámbitos necesarios para llamar a la API web de bajada. Por ejemplo, "user.read mail.read". Para Microsoft identidad, en el caso de los tokens de aplicación (token solicitado por la aplicación en nombre propio), solo debe haber un ámbito y debería terminar en "./default")

(Heredado de DownstreamApiOptions)
Serializer

Serializador opcional. Serializará la entrada en la API web (si existe). De forma predeterminada, cuando no se proporciona:

  • Si la entrada se deriva de HttpInput, se usa tal como está.
  • Si la entrada es una cadena que se usa como se considera un json de tipo multimedia.
  • De lo contrario, el objeto se serializa en JSON, con una codificación UTF8 y un tipo multimedia de application/json: 
    new StringContent(JsonSerializer.Serialize(input), Encoding.UTF8, "application/json")
(Heredado de DownstreamApiOptions)

Métodos

Nombre Description
Clone()

Clonación de las opciones
CloneInternal()

Clone las opciones (para poder invalidarlas).
GetApiUrl()

Devuelve la dirección URL de la API web de bajada.

(Heredado de AuthorizationHeaderProviderOptions)

Se aplica a