LiuFan
/
PrivacyScanData


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
							<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  
  <link rel="canonical" href="https://OLC-LOC-Bioinformatics.github.io/AzureStorage/download/">
  <link rel="shortcut icon" href="../img/favicon.ico">
  <title>Download - OLC Bioinformatics Azure Storage</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />

  <link rel="stylesheet" href="../css/theme.css" />
  <link rel="stylesheet" href="../css/theme_extra.css" />
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" />
  
  <script>
    // Current page data
    var mkdocs_page_name = "Download";
    var mkdocs_page_input_path = "download.md";
    var mkdocs_page_url = "/AzureStorage/download/";
  </script>
  
  <script src="../js/jquery-2.1.1.min.js" defer></script>
  <script src="../js/modernizr-2.8.3.min.js" defer></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
  <script>hljs.initHighlightingOnLoad();</script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
    <div class="wy-side-scroll">
      <div class="wy-side-nav-search">
        <a href=".." class="icon icon-home"> OLC Bioinformatics Azure Storage</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../install/">Installation</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../credentials/">Credentials</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../upload/">Upload</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../sas_url/">SAS URL</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../move/">Move</a>
                    </li>
                </ul>
                <ul class="current">
                    <li class="toctree-l1 current"><a class="reference internal current" href="./">Download</a>
    <ul class="current">
    <li class="toctree-l2"><a class="reference internal" href="#general-usage">General usage</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#azuredownload-container">AzureDownload container</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#required-arguments">Required arguments:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#optional-arguments">Optional arguments:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#example-commands">Example commands:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#azuredownload-file">AzureDownload file</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#required-arguments_1">Required arguments:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_1">Optional arguments:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#example-commands_1">Example commands:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#usage_1">Usage</a>
    </li>
        </ul>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="#azuredownload-folder">AzureDownload folder</a>
        <ul>
    <li class="toctree-l3"><a class="reference internal" href="#required-arguments_2">Required arguments:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_2">Optional arguments:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#example-commands_2">Example commands:</a>
    </li>
    <li class="toctree-l3"><a class="reference internal" href="#usage_2">Usage</a>
    </li>
        </ul>
    </li>
    </ul>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../set_tier/">Set Tier</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../delete/">Delete</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../automate/">Automate</a>
                    </li>
                </ul>
                <ul>
                    <li class="toctree-l1"><a class="reference internal" href="../list/">List</a>
                    </li>
                </ul>
      </div>
    </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="..">OLC Bioinformatics Azure Storage</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="..">Docs</a> &raquo;</li>
    
      
    
    <li>Download</li>
    <li class="wy-breadcrumbs-aside">
      
        <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/download.md"
          class="icon icon-github"> Edit on GitHub</a>
      
    </li>
  </ul>
  
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <h2 id="azuredownload">AzureDownload</h2>
<p>Download containers, files, or folders from your Azure storage account</p>
<p>Choose either the <a href="#azuredownload-container"><code>container</code></a>, <a href="#azuredownload-file"><code>file</code></a>, or  <a href="#azuredownload-folder"><code>folder</code></a> functionality</p>
<h4 id="general-usage">General usage</h4>
<pre><code>usage: AzureDownload [-h] {container,file,folder} ...

Download containers/files/folders from Azure storage

optional arguments:
  -h, --help            show this help message and exit

Available functionality:
  {container,file,folder}
    container           Download a container from Azure storage
    file                Download a file from Azure storage
    folder              Download a folder from Azure storage
</code></pre>

<h3 id="azuredownload-container">AzureDownload container</h3>
<p>Download a container from your Azure storage account</p>
<h4 id="required-arguments">Required arguments:</h4>
<ul>
<li>container name</li>
<li>account name</li>
</ul>
<h4 id="optional-arguments">Optional arguments:</h4>
<ul>
<li>output path: local path where container is to be saved. Default is your current working directory</li>
<li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
<li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
</ul>
<h4 id="example-commands">Example commands:</h4>
<p>These commands will use <code>container-name</code> as the name of the container and <code>account_name</code> as the name of the storage account</p>
<p>To perform a basic container download (download to your current working directory)</p>
<p><code>AzureDownload container -a account name -c container-name</code></p>
<p>To download a container to the folder <code>outputs</code> in your current working directory</p>
<p><code>AzureDownload container -a account name -c container-name -o outputs</code></p>
<p>To download a container to the folder <code>/home/users/outputs</code> </p>
<p><code>AzureDownload container -a account name -c container-name -o /home/users/outputs</code></p>
<h4 id="usage">Usage</h4>
<pre><code>usage: AzureDownload container [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] [-o OUTPUT_PATH]

Download a container from Azure storage

optional arguments:
  -h, --help            show this help message and exit
  -c CONTAINER_NAME, --container_name CONTAINER_NAME
                        Name of the Azure storage container. Note that container names must be lowercase, between 3 and 63 characters, start with a letter or number, and can contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted.
  -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
                        Name of the Azure storage account
  -p PASSPHRASE, --passphrase PASSPHRASE
                        The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  -v VERBOSITY, --verbosity VERBOSITY
                        Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  -o OUTPUT_PATH, --output_path OUTPUT_PATH
                        Name and path of directory in which the outputs are to be saved. Default is your $CWD
</code></pre>

<h3 id="azuredownload-file">AzureDownload file</h3>
<p>Download a file from your Azure storage account</p>
<h4 id="required-arguments_1">Required arguments:</h4>
<ul>
<li>container name</li>
<li>account name</li>
<li>file name</li>
</ul>
<h4 id="optional-arguments_1">Optional arguments:</h4>
<ul>
<li>output path: local path where container is to be saved. Default is your current working directory</li>
<li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
<li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
</ul>
<h4 id="example-commands_1">Example commands:</h4>
<p>These commands will use <code>container-name</code> as the name of the container and <code>account_name</code> as the name of the storage account</p>
<p>To download the file <code>file_name.gz</code> to your current working directory</p>
<p><code>AzureDownload file -a account name -c container-name -f file_name.gz</code></p>
<p>To download the file <code>file_name.gz</code> nested in the <code>outputs</code> folder to your current working directory</p>
<p><code>AzureDownload file -a account name -c container-name -f outputs/file_name.gz</code></p>
<p>To download the file <code>file_name.gz</code> nested in the <code>outputs</code> folder to the folder <code>files</code> in your current working directory</p>
<p><code>AzureDownload file -a account name -c container-name -f outputs/file_name.gz -o files</code></p>
<p>To download the file <code>file_name.gz</code> to the folder <code>/home/users/outputs</code> </p>
<p><code>AzureDownload file -a account name -c container-name -f file_name.gz -o /home/users/outputs</code></p>
<h4 id="usage_1">Usage</h4>
<pre><code>usage: AzureDownload file [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] [-o OUTPUT_PATH] -f FILE

Download a file from Azure storage

optional arguments:
  -h, --help            show this help message and exit
  -c CONTAINER_NAME, --container_name CONTAINER_NAME
                        Name of the Azure storage container. Note that container names must be lowercase, between 3 and 63 characters, start with a letter or number, and can contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted.
  -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
                        Name of the Azure storage account
  -p PASSPHRASE, --passphrase PASSPHRASE
                        The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  -v VERBOSITY, --verbosity VERBOSITY
                        Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  -o OUTPUT_PATH, --output_path OUTPUT_PATH
                        Name and path of directory in which the outputs are to be saved. Default is your $CWD
  -f FILE, --file FILE  Name of file to download from Azure storage.e.g. 2022-SEQ-0001_S1_L001_R1_001.fastq.gz
</code></pre>

<h3 id="azuredownload-folder">AzureDownload folder</h3>
<p>Download a folder from your Azure storage account</p>
<h4 id="required-arguments_2">Required arguments:</h4>
<ul>
<li>container name</li>
<li>account name</li>
<li>folder name</li>
</ul>
<h4 id="optional-arguments_2">Optional arguments:</h4>
<ul>
<li>output path: local path where container is to be saved. Default is your current working directory</li>
<li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
<li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
</ul>
<h4 id="example-commands_2">Example commands:</h4>
<p>These commands will use <code>container-name</code> as the name of the container and <code>account_name</code> as the name of the storage account</p>
<p>To download the folder <code>folder_name</code> to your current working directory</p>
<p><code>AzureDownload folder -a account name -c container-name -f folder_name</code></p>
<p>To download the folder <code>folder_name</code> nested in the <code>outputs</code> folder to your current working directory</p>
<p><code>AzureDownload folder -a account name -c container-name -f outputs/folder_name</code></p>
<p>To download the folder <code>folder_name</code> nested in the <code>outputs</code> folder to the folder <code>folders</code> in your current working directory</p>
<p><code>AzureDownload folder -a account name -c container-name -f outputs/folder_name -o folders</code></p>
<p>To download the folder <code>folder_name</code> to the folder <code>/home/users/outputs</code> </p>
<p><code>AzureDownload folder -a account name -c container-name -f folder_name -o /home/users/outputs</code></p>
<h4 id="usage_2">Usage</h4>
<pre><code>usage: AzureDownload folder [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] [-o OUTPUT_PATH] -f FOLDER

Download a folder from Azure storage

optional arguments:
  -h, --help            show this help message and exit
  -c CONTAINER_NAME, --container_name CONTAINER_NAME
                        Name of the Azure storage container. Note that container names must be lowercase, between 3 and 63 characters, start with a letter or number, and can contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted.
  -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
                        Name of the Azure storage account
  -p PASSPHRASE, --passphrase PASSPHRASE
                        The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  -v VERBOSITY, --verbosity VERBOSITY
                        Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  -o OUTPUT_PATH, --output_path OUTPUT_PATH
                        Name and path of directory in which the outputs are to be saved. Default is your $CWD
  -f FOLDER, --folder FOLDER
                        Name of the folder to download from Azure storage e.g. InterOp
</code></pre>
              
            </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../set_tier/" class="btn btn-neutral float-right" title="Set Tier">Next <span class="icon icon-circle-arrow-right"></span></a>
      
      
        <a href="../move/" class="btn btn-neutral" title="Move"><span class="icon icon-circle-arrow-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
  </div>

  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
      
        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" aria-label="versions">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
      
      
        <span><a href="../move/" style="color: #fcfcfc;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../set_tier/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script>var base_url = '..';</script>
    <script src="../js/theme.js" defer></script>
      <script src="../search/main.js" defer></script>
    <script defer>
        window.onload = function () {
            SphinxRtdTheme.Navigation.enable(true);
        };
    </script>

</body>
</html>