AzureFunctionsAuthenticationHttpContextExtension.xml

<Type Name="AzureFunctionsAuthenticationHttpContextExtension" FullName="Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension">
  <TypeSignature Language="C#" Value="public static class AzureFunctionsAuthenticationHttpContextExtension" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit AzureFunctionsAuthenticationHttpContextExtension extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension" />
  <TypeSignature Language="VB.NET" Value="Public Module AzureFunctionsAuthenticationHttpContextExtension" />
  <TypeSignature Language="F#" Value="type AzureFunctionsAuthenticationHttpContextExtension = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Identity.Web</AssemblyName>
    <AssemblyVersion>2.11.0.0</AssemblyVersion>
    <AssemblyVersion>2.11.1.0</AssemblyVersion>
    <AssemblyVersion>2.12.4.0</AssemblyVersion>
    <AssemblyVersion>2.13.0.0</AssemblyVersion>
    <AssemblyVersion>2.13.1.0</AssemblyVersion>
    <AssemblyVersion>2.13.2.0</AssemblyVersion>
    <AssemblyVersion>2.13.3.0</AssemblyVersion>
    <AssemblyVersion>2.13.4.0</AssemblyVersion>
    <AssemblyVersion>2.14.0.0</AssemblyVersion>
    <AssemblyVersion>2.15.1.0</AssemblyVersion>
    <AssemblyVersion>2.15.2.0</AssemblyVersion>
    <AssemblyVersion>2.15.3.0</AssemblyVersion>
    <AssemblyVersion>2.15.5.0</AssemblyVersion>
    <AssemblyVersion>2.16.0.0</AssemblyVersion>
    <AssemblyVersion>2.16.1.0</AssemblyVersion>
    <AssemblyVersion>2.17.0.0</AssemblyVersion>
    <AssemblyVersion>2.17.1.0</AssemblyVersion>
    <AssemblyVersion>2.17.2.0</AssemblyVersion>
    <AssemblyVersion>2.17.3.0</AssemblyVersion>
    <AssemblyVersion>2.17.4.0</AssemblyVersion>
    <AssemblyVersion>2.17.5.0</AssemblyVersion>
    <AssemblyVersion>2.18.1.0</AssemblyVersion>
    <AssemblyVersion>2.18.2.0</AssemblyVersion>
    <AssemblyVersion>2.19.0.0</AssemblyVersion>
    <AssemblyVersion>2.19.1.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Extensions for <see cref="T:Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="AuthenticateAzureFunctionAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;(bool, Microsoft.AspNetCore.Mvc.IActionResult?)&gt; AuthenticateAzureFunctionAsync (this Microsoft.AspNetCore.Http.HttpContext httpContext);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;valuetype System.ValueTuple`2&lt;bool, class Microsoft.AspNetCore.Mvc.IActionResult&gt;&gt; AuthenticateAzureFunctionAsync(class Microsoft.AspNetCore.Http.HttpContext httpContext) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension.AuthenticateAzureFunctionAsync(Microsoft.AspNetCore.Http.HttpContext)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function AuthenticateAzureFunctionAsync (httpContext As HttpContext) As Task(Of ValueTuple(Of Boolean, IActionResult))" />
      <MemberSignature Language="F#" Value="static member AuthenticateAzureFunctionAsync : Microsoft.AspNetCore.Http.HttpContext -&gt; System.Threading.Tasks.Task&lt;ValueTuple&lt;bool, Microsoft.AspNetCore.Mvc.IActionResult&gt;&gt;" Usage="Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension.AuthenticateAzureFunctionAsync httpContext" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Web</AssemblyName>
        <AssemblyVersion>2.19.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;System.ValueTuple&lt;System.Boolean,Microsoft.AspNetCore.Mvc.IActionResult&gt;&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="httpContext" Type="Microsoft.AspNetCore.Http.HttpContext" RefType="this" />
      </Parameters>
      <Docs>
        <param name="httpContext">The current HTTP Context, such as req.HttpContext.</param>
        <summary>
            Enables an Azure Function to act as/expose a protected web API, enabling bearer token authentication.
            Calling this method from your Azure function validates the token and exposes the identity of the user or app on behalf of which your function is called,
            in the HttpContext.User member, where your function can make use of it.
            </summary>
        <returns>A task indicating success or failure. In case of failure <see cref="T:Microsoft.AspNetCore.Mvc.UnauthorizedObjectResult" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>