BlobContainerClientExtensions.xml

<Type Name="BlobContainerClientExtensions" FullName="Azure.Storage.Blobs.BlobContainerClientExtensions">
  <TypeSignature Language="C#" Value="public static class BlobContainerClientExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit BlobContainerClientExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Storage.Blobs.BlobContainerClientExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module BlobContainerClientExtensions" />
  <TypeSignature Language="F#" Value="type BlobContainerClientExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Storage.DataMovement.Blobs</AssemblyName>
    <AssemblyVersion>12.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Data movement extension methods for the <see cref="T:Azure.Storage.Blobs.BlobContainerClient" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="StartDownloadToDirectoryAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt; StartDownloadToDirectoryAsync (this Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions options);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class Azure.Storage.DataMovement.DataTransfer&gt; StartDownloadToDirectoryAsync(class Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, class Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions options) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Storage.Blobs.BlobContainerClientExtensions.StartDownloadToDirectoryAsync(Azure.Storage.Blobs.BlobContainerClient,System.String,Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function StartDownloadToDirectoryAsync (client As BlobContainerClient, localDirectoryPath As String, options As BlobContainerClientTransferOptions) As Task(Of DataTransfer)" />
      <MemberSignature Language="F#" Value="static member StartDownloadToDirectoryAsync : Azure.Storage.Blobs.BlobContainerClient * string * Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions -&gt; System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;" Usage="Azure.Storage.Blobs.BlobContainerClientExtensions.StartDownloadToDirectoryAsync (client, localDirectoryPath, options)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Storage.DataMovement.Blobs</AssemblyName>
        <AssemblyVersion>12.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="client" Type="Azure.Storage.Blobs.BlobContainerClient" RefType="this" />
        <Parameter Name="localDirectoryPath" Type="System.String" />
        <Parameter Name="options" Type="Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions" />
      </Parameters>
      <Docs>
        <param name="client">The <see cref="T:Azure.Storage.Blobs.BlobContainerClient" /> used for service operations.</param>
        <param name="localDirectoryPath">The full path to the local directory where files will be dowloaded.</param>
        <param name="options">Options which control the container download.</param>
        <summary>
            Downloads the contents of a blob container.
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StartDownloadToDirectoryAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt; StartDownloadToDirectoryAsync (this Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, string blobDirectoryPrefix = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class Azure.Storage.DataMovement.DataTransfer&gt; StartDownloadToDirectoryAsync(class Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, string blobDirectoryPrefix) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Storage.Blobs.BlobContainerClientExtensions.StartDownloadToDirectoryAsync(Azure.Storage.Blobs.BlobContainerClient,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function StartDownloadToDirectoryAsync (client As BlobContainerClient, localDirectoryPath As String, Optional blobDirectoryPrefix As String = Nothing) As Task(Of DataTransfer)" />
      <MemberSignature Language="F#" Value="static member StartDownloadToDirectoryAsync : Azure.Storage.Blobs.BlobContainerClient * string * string -&gt; System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;" Usage="Azure.Storage.Blobs.BlobContainerClientExtensions.StartDownloadToDirectoryAsync (client, localDirectoryPath, blobDirectoryPrefix)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Storage.DataMovement.Blobs</AssemblyName>
        <AssemblyVersion>12.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="client" Type="Azure.Storage.Blobs.BlobContainerClient" RefType="this" />
        <Parameter Name="localDirectoryPath" Type="System.String" />
        <Parameter Name="blobDirectoryPrefix" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="client">The <see cref="T:Azure.Storage.Blobs.BlobContainerClient" /> used for service operations.</param>
        <param name="localDirectoryPath">The full path to the local directory where files will be dowloaded.</param>
        <param name="blobDirectoryPrefix">Optionally restricts the downloaded content to blobs with the specified directory prefix.</param>
        <summary>
            Downloads the contents of a blob container.
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StartUploadDirectoryAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt; StartUploadDirectoryAsync (this Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions options);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class Azure.Storage.DataMovement.DataTransfer&gt; StartUploadDirectoryAsync(class Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, class Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions options) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Storage.Blobs.BlobContainerClientExtensions.StartUploadDirectoryAsync(Azure.Storage.Blobs.BlobContainerClient,System.String,Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function StartUploadDirectoryAsync (client As BlobContainerClient, localDirectoryPath As String, options As BlobContainerClientTransferOptions) As Task(Of DataTransfer)" />
      <MemberSignature Language="F#" Value="static member StartUploadDirectoryAsync : Azure.Storage.Blobs.BlobContainerClient * string * Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions -&gt; System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;" Usage="Azure.Storage.Blobs.BlobContainerClientExtensions.StartUploadDirectoryAsync (client, localDirectoryPath, options)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Storage.DataMovement.Blobs</AssemblyName>
        <AssemblyVersion>12.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="client" Type="Azure.Storage.Blobs.BlobContainerClient" RefType="this" />
        <Parameter Name="localDirectoryPath" Type="System.String" />
        <Parameter Name="options" Type="Azure.Storage.DataMovement.Blobs.BlobContainerClientTransferOptions" />
      </Parameters>
      <Docs>
        <param name="client">The <see cref="T:Azure.Storage.Blobs.BlobContainerClient" /> used for service operations.</param>
        <param name="localDirectoryPath">The full path to the local directory to be uploaded.</param>
        <param name="options">Options which control the directory upload.</param>
        <summary>
            Uploads the entire contents of local directory to the blob container.
            </summary>
        <returns>A <see cref="T:Azure.Storage.DataMovement.DataTransfer" /> instance which can be used track progress and wait for completion with <see cref="M:Azure.Storage.DataMovement.DataTransfer.WaitForCompletionAsync(System.Threading.CancellationToken)" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StartUploadDirectoryAsync">
      <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt; StartUploadDirectoryAsync (this Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, string blobDirectoryPrefix = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;class Azure.Storage.DataMovement.DataTransfer&gt; StartUploadDirectoryAsync(class Azure.Storage.Blobs.BlobContainerClient client, string localDirectoryPath, string blobDirectoryPrefix) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Storage.Blobs.BlobContainerClientExtensions.StartUploadDirectoryAsync(Azure.Storage.Blobs.BlobContainerClient,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function StartUploadDirectoryAsync (client As BlobContainerClient, localDirectoryPath As String, Optional blobDirectoryPrefix As String = Nothing) As Task(Of DataTransfer)" />
      <MemberSignature Language="F#" Value="static member StartUploadDirectoryAsync : Azure.Storage.Blobs.BlobContainerClient * string * string -&gt; System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;" Usage="Azure.Storage.Blobs.BlobContainerClientExtensions.StartUploadDirectoryAsync (client, localDirectoryPath, blobDirectoryPrefix)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Storage.DataMovement.Blobs</AssemblyName>
        <AssemblyVersion>12.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task&lt;Azure.Storage.DataMovement.DataTransfer&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="client" Type="Azure.Storage.Blobs.BlobContainerClient" RefType="this" />
        <Parameter Name="localDirectoryPath" Type="System.String" />
        <Parameter Name="blobDirectoryPrefix" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="client">The <see cref="T:Azure.Storage.Blobs.BlobContainerClient" /> used for service operations.</param>
        <param name="localDirectoryPath">The full path to the local directory to be uploaded.</param>
        <param name="blobDirectoryPrefix">Optionally specifies the directory prefix to be prepended to all uploaded files.</param>
        <summary>
            Uploads the entire contents of local directory to the blob container.
            </summary>
        <returns>A <see cref="T:Azure.Storage.DataMovement.DataTransfer" /> instance which can be used track progress and wait for completion with <see cref="M:Azure.Storage.DataMovement.DataTransfer.WaitForCompletionAsync(System.Threading.CancellationToken)" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>