TokenProvider.xml

<Type Name="TokenProvider" FullName="Microsoft.Azure.Relay.TokenProvider">
  <TypeSignature Language="C#" Value="public abstract class TokenProvider" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TokenProvider extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Relay.TokenProvider" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class TokenProvider" />
  <TypeSignature Language="F#" Value="type TokenProvider = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
    <AssemblyVersion>2.0.1559.6</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            This abstract base class can be extended to implement additional token providers.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected TokenProvider ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>2.0.1559.6</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:Microsoft.Azure.Relay.TokenProvider" /> class. </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateAzureActiveDirectoryTokenProvider">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Relay.TokenProvider CreateAzureActiveDirectoryTokenProvider (Microsoft.Azure.Relay.TokenProvider.AuthenticationCallback authCallback, string authority, object state = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Relay.TokenProvider CreateAzureActiveDirectoryTokenProvider(class Microsoft.Azure.Relay.TokenProvider/AuthenticationCallback authCallback, string authority, object state) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.CreateAzureActiveDirectoryTokenProvider(Microsoft.Azure.Relay.TokenProvider.AuthenticationCallback,System.String,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateAzureActiveDirectoryTokenProvider (authCallback As TokenProvider.AuthenticationCallback, authority As String, Optional state As Object = Nothing) As TokenProvider" />
      <MemberSignature Language="F#" Value="static member CreateAzureActiveDirectoryTokenProvider : Microsoft.Azure.Relay.TokenProvider.AuthenticationCallback * string * obj -&gt; Microsoft.Azure.Relay.TokenProvider" Usage="Microsoft.Azure.Relay.TokenProvider.CreateAzureActiveDirectoryTokenProvider (authCallback, authority, state)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Relay.TokenProvider</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="authCallback" Type="Microsoft.Azure.Relay.TokenProvider+AuthenticationCallback" Index="0" FrameworkAlternate="azure-dotnet-preview" />
        <Parameter Name="authority" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
        <Parameter Name="state" Type="System.Object" Index="2" FrameworkAlternate="azure-dotnet-preview" />
      </Parameters>
      <Docs>
        <param name="authCallback">A user supplied handler that would be invoked to obtain the AAD access token string.</param>
        <param name="authority">Address of the authority to issue the AAD token. For example, https://login.microsoftonline.com/{TenantId}</param>
        <param name="state">State to be delivered to callback.</param>
        <summary>Creates an Azure Active Directory token provider.</summary>
        <returns>The <see cref="T:Microsoft.Azure.Relay.TokenProvider" /> for returning Json web token.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateManagedIdentityTokenProvider">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Relay.TokenProvider CreateManagedIdentityTokenProvider ();" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Relay.TokenProvider CreateManagedIdentityTokenProvider() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.CreateManagedIdentityTokenProvider" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateManagedIdentityTokenProvider () As TokenProvider" />
      <MemberSignature Language="F#" Value="static member CreateManagedIdentityTokenProvider : unit -&gt; Microsoft.Azure.Relay.TokenProvider" Usage="Microsoft.Azure.Relay.TokenProvider.CreateManagedIdentityTokenProvider " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Relay.TokenProvider</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Creates a TokenProvider for a Azure managed identity with a default instance of <see cref="T:Azure.Identity.ManagedIdentityCredential" />.
            </summary>
        <returns>The <see cref="T:Microsoft.Azure.Relay.TokenProvider" /> for returning Json web token.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateManagedIdentityTokenProvider">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Relay.TokenProvider CreateManagedIdentityTokenProvider (Azure.Identity.ManagedIdentityCredential managedIdentityCredential);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Relay.TokenProvider CreateManagedIdentityTokenProvider(class Azure.Identity.ManagedIdentityCredential managedIdentityCredential) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.CreateManagedIdentityTokenProvider(Azure.Identity.ManagedIdentityCredential)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateManagedIdentityTokenProvider (managedIdentityCredential As ManagedIdentityCredential) As TokenProvider" />
      <MemberSignature Language="F#" Value="static member CreateManagedIdentityTokenProvider : Azure.Identity.ManagedIdentityCredential -&gt; Microsoft.Azure.Relay.TokenProvider" Usage="Microsoft.Azure.Relay.TokenProvider.CreateManagedIdentityTokenProvider managedIdentityCredential" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Relay.TokenProvider</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="managedIdentityCredential" Type="Azure.Identity.ManagedIdentityCredential" Index="0" FrameworkAlternate="azure-dotnet-preview" />
      </Parameters>
      <Docs>
        <param name="managedIdentityCredential">To be added.</param>
        <summary>
            Creates a TokenProvider for a Azure managed or user-assigned identity with a provided instance of <see cref="T:Azure.Identity.ManagedIdentityCredential" />.
            </summary>
        <returns>The <see cref="T:Microsoft.Azure.Relay.TokenProvider" /> for returning Json web token.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateSharedAccessSignatureTokenProvider">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Relay.TokenProvider CreateSharedAccessSignatureTokenProvider (string sharedAccessSignature);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Relay.TokenProvider CreateSharedAccessSignatureTokenProvider(string sharedAccessSignature) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.CreateSharedAccessSignatureTokenProvider(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateSharedAccessSignatureTokenProvider (sharedAccessSignature As String) As TokenProvider" />
      <MemberSignature Language="F#" Value="static member CreateSharedAccessSignatureTokenProvider : string -&gt; Microsoft.Azure.Relay.TokenProvider" Usage="Microsoft.Azure.Relay.TokenProvider.CreateSharedAccessSignatureTokenProvider sharedAccessSignature" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>2.0.1559.6</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Relay.TokenProvider</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="sharedAccessSignature" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="sharedAccessSignature">The shared access signature</param>
        <summary>
            Construct a TokenProvider based on a sharedAccessSignature.
            </summary>
        <returns>A TokenProvider initialized with the shared access signature</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateSharedAccessSignatureTokenProvider">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Relay.TokenProvider CreateSharedAccessSignatureTokenProvider (string keyName, string sharedAccessKey);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Relay.TokenProvider CreateSharedAccessSignatureTokenProvider(string keyName, string sharedAccessKey) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.CreateSharedAccessSignatureTokenProvider(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function CreateSharedAccessSignatureTokenProvider (keyName As String, sharedAccessKey As String) As TokenProvider" />
      <MemberSignature Language="F#" Value="static member CreateSharedAccessSignatureTokenProvider : string * string -&gt; Microsoft.Azure.Relay.TokenProvider" Usage="Microsoft.Azure.Relay.TokenProvider.CreateSharedAccessSignatureTokenProvider (keyName, sharedAccessKey)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>2.0.1559.6</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Relay.TokenProvider</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="keyName" Type="System.String" />
        <Parameter Name="sharedAccessKey" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="keyName">The key name of the corresponding SharedAccessKeyAuthorizationRule.</param>
        <param name="sharedAccessKey">The key associated with the SharedAccessKeyAuthorizationRule</param>
        <summary>
            Construct a TokenProvider based on the provided Key Name and Shared Access Key.
            </summary>
        <returns>A TokenProvider initialized with the provided RuleId and Password</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetTokenAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task&lt;Microsoft.Azure.Relay.SecurityToken&gt; GetTokenAsync (string audience, TimeSpan validFor);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Relay.SecurityToken&gt; GetTokenAsync(string audience, valuetype System.TimeSpan validFor) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.GetTokenAsync(System.String,System.TimeSpan)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetTokenAsync (audience As String, validFor As TimeSpan) As Task(Of SecurityToken)" />
      <MemberSignature Language="F#" Value="member this.GetTokenAsync : string * TimeSpan -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Relay.SecurityToken&gt;" Usage="tokenProvider.GetTokenAsync (audience, validFor)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>2.0.1559.6</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Relay.SecurityToken&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="audience" Type="System.String" />
        <Parameter Name="validFor" Type="System.TimeSpan" />
      </Parameters>
      <Docs>
        <param name="audience">The target audience for the security token.</param>
        <param name="validFor">How long the generated token should be valid for.</param>
        <summary>
            Gets a <see cref="T:Microsoft.Azure.Relay.SecurityToken" /> for the given audience and duration.
            </summary>
        <returns>A Task returning the newly created SecurityToken.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnGetTokenAsync">
      <MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Relay.SecurityToken&gt; OnGetTokenAsync (string audience, TimeSpan validFor);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Relay.SecurityToken&gt; OnGetTokenAsync(string audience, valuetype System.TimeSpan validFor) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.TokenProvider.OnGetTokenAsync(System.String,System.TimeSpan)" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnGetTokenAsync (audience As String, validFor As TimeSpan) As Task(Of SecurityToken)" />
      <MemberSignature Language="F#" Value="abstract member OnGetTokenAsync : string * TimeSpan -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Relay.SecurityToken&gt;" Usage="tokenProvider.OnGetTokenAsync (audience, validFor)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>2.0.1559.6</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Relay.SecurityToken&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="audience" Type="System.String" />
        <Parameter Name="validFor" Type="System.TimeSpan" />
      </Parameters>
      <Docs>
        <param name="audience">The target audience for the security token.</param>
        <param name="validFor">How long the generated token should be valid for.</param>
        <summary>
            Implemented by derived TokenProvider types to generate their <see cref="T:Microsoft.Azure.Relay.SecurityToken" />.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThisLock">
      <MemberSignature Language="C#" Value="protected object ThisLock { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object ThisLock" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.TokenProvider.ThisLock" />
      <MemberSignature Language="VB.NET" Value="Protected ReadOnly Property ThisLock As Object" />
      <MemberSignature Language="F#" Value="member this.ThisLock : obj" Usage="Microsoft.Azure.Relay.TokenProvider.ThisLock" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Relay</AssemblyName>
        <AssemblyVersion>2.0.1559.6</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the synchronization object for the given instance.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>