ICanonicalizer.xml

<Type Name="ICanonicalizer" FullName="Microsoft.Azure.Storage.Core.Auth.ICanonicalizer">
  <TypeSignature Language="C#" Value="public interface ICanonicalizer" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ICanonicalizer" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Storage.Core.Auth.ICanonicalizer" />
  <TypeSignature Language="VB.NET" Value="Public Interface ICanonicalizer" />
  <TypeSignature Language="F#" Value="type ICanonicalizer = interface" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
    <AssemblyVersion>11.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <summary>
      <para>Represents a canonicalizer that converts HTTP request data into a standard form appropriate for signing.</para>
      <para>For detailed information on how to authenticate a request, 
            see <see href="http://msdn.microsoft.com/en-us/library/Azure/dd179428.aspx">Authentication for the Microsoft Azure Storage Services</see>.</para>
    </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="AuthorizationScheme">
      <MemberSignature Language="C#" Value="public string AuthorizationScheme { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string AuthorizationScheme" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Storage.Core.Auth.ICanonicalizer.AuthorizationScheme" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property AuthorizationScheme As String" />
      <MemberSignature Language="F#" Value="member this.AuthorizationScheme : string" Usage="Microsoft.Azure.Storage.Core.Auth.ICanonicalizer.AuthorizationScheme" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
        <AssemblyVersion>11.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the authorization scheme used for canonicalization.
            </summary>
        <value>The authorization scheme used for canonicalization.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CanonicalizeHttpRequest">
      <MemberSignature Language="C#" Value="public string CanonicalizeHttpRequest (System.Net.Http.HttpRequestMessage request, string accountName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string CanonicalizeHttpRequest(class System.Net.Http.HttpRequestMessage request, string accountName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Storage.Core.Auth.ICanonicalizer.CanonicalizeHttpRequest(System.Net.Http.HttpRequestMessage,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function CanonicalizeHttpRequest (request As HttpRequestMessage, accountName As String) As String" />
      <MemberSignature Language="F#" Value="abstract member CanonicalizeHttpRequest : System.Net.Http.HttpRequestMessage * string -&gt; string" Usage="iCanonicalizer.CanonicalizeHttpRequest (request, accountName)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
        <AssemblyVersion>11.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="request" Type="System.Net.Http.HttpRequestMessage" />
        <Parameter Name="accountName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="request">The HTTP request that needs to be signed.</param>
        <param name="accountName">The name of the storage account that the HTTP request will access.</param>
        <summary>
            Converts the specified HTTP request data into a standard form appropriate for signing.
            </summary>
        <returns>The canonicalized string containing the HTTP request data in a standard form appropriate for signing.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>