IHashGenerator.xml

<Type Name="IHashGenerator" FullName="Microsoft.Azure.Documents.Partitioning.IHashGenerator">
  <TypeSignature Language="C#" Value="public interface IHashGenerator" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IHashGenerator" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Partitioning.IHashGenerator" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
    <AssemblyVersion>1.14.0.0</AssemblyVersion>
    <AssemblyVersion>1.16.0.0</AssemblyVersion>
    <AssemblyVersion>1.17.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.Obsolete("Support for interfaces used with IPartitionResolver is now obsolete. It's recommended that you use partitioned collections for higher storage and throughput.")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            An interface used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.HashPartitionResolver" /> to partition data using consistent hashing in the Azure DocumentDB database service.
            </summary>
    <remarks>
      <para>
            Support for interfaces used with IPartitionResolver is now obsolete. It's recommended that you use 
            <a href="https://azure.microsoft.com/documentation/articles/documentdb-partition-data">Partitioned Collections</a> for higher storage and throughput.
            </para>
    </remarks>
    <altmember cref="T:Microsoft.Azure.Documents.Partitioning.HashPartitionResolver" />
  </Docs>
  <Members>
    <Member MemberName="ComputeHash">
      <MemberSignature Language="C#" Value="public byte[] ComputeHash (byte[] key);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance unsigned int8[] ComputeHash(unsigned int8[] key) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.IHashGenerator.ComputeHash(System.Byte[])" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
        <AssemblyVersion>1.16.0.0</AssemblyVersion>
        <AssemblyVersion>1.17.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Byte[]</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="System.Byte[]" />
      </Parameters>
      <Docs>
        <param name="key">A key represented by an array of bytes</param>
        <summary>
            Hashes an array of bytes into a new array of bytes that represents the output hash in the Azure DocumentDB database service.
            </summary>
        <returns>An array of bytes that represents the output hash.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>