<!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/sas_url/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>SAS URL - 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 = "SAS URL";
var mkdocs_page_input_path = "sas_url.md";
var mkdocs_page_url = "/AzureStorage/sas_url/";
</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 class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">SAS URL</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="#azuresas-container">AzureSAS 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="#azuresas-file">AzureSAS 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="#azuresas-folder">AzureSAS 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="../move/">Move</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../download/">Download</a>
</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> »</li>
<li>SAS URL</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/sas_url.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h2 id="azuresas">AzureSAS</h2>
<p>Create shared access signatures (SAS) URLs for containers, files, folders in your Azure storage account.</p>
<p>Note that each file in a container/folder has to be downloaded separately, so if there are 1000 files in the container, 1000 SAS URLs will be provided</p>
<p>Choose either the <a href="#azuresas-container"><code>container</code></a>, <a href="#azuresas-file"><code>file</code></a>, or <a href="#azuresas-folder"><code>folder</code></a> functionality</p>
<h4 id="general-usage">General usage</h4>
<pre><code>usage: AzureSAS [-h] {container,file,folder} ...
Create shared access signatures (SAS) for containers/files/folders from Azure storage.
Note that each file in the container/folder has to be downloaded separately, so if
there are 1000 files in the container, 1000 SAS will be provided
optional arguments:
-h, --help show this help message and exit
Available functionality:
{container,file,folder}
container Create SAS for all files in a container in Azure storage
file Create a SAS for a file in Azure storage
folder Create SAS for all files in a folder in Azure storage
</code></pre>
<h3 id="azuresas-container">AzureSAS container</h3>
<p>Create SAS URLs for all files in a container in 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 file: file in which the SAS URLs are to be written. Default is <code>sas.txt</code> in your current working directory</li>
<li>expiry: the number of days the SAS URL with be valid. Minimum is 1, maximum is 365. Default is 10</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 create SAS URLs with default settings:</p>
<p><code>AzureSAS container -a account_name -c container-name</code></p>
<p>To create SAS URLs with an expiry of 15 days:</p>
<p><code>AzureSAS container -a account_name -c container-name -e 15</code></p>
<p>To create SAS URLs, and save them to the file <code>sas_urls.txt</code> in your current working directory:</p>
<p><code>AzureSAS container -a account_name -c container-name -o sas_urls.txt</code></p>
<p>To create SAS URLs, and save them to the file <code>sas_urls.txt</code> nested in folder <code>outputs</code> in your current working directory:</p>
<p><code>AzureSAS container -a account_name -c container-name -o outputs/sas_urls.txt</code></p>
<h4 id="usage">Usage</h4>
<pre><code>usage: AzureSAS container [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] [-e EXPIRY] [-o OUTPUT_FILE]
Create SAS URLs for all files in a container in 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 "AzureStorage".
-v VERBOSITY, --verbosity VERBOSITY
Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
-e EXPIRY, --expiry EXPIRY
The number of days that the SAS URL will be valid. The minimum is 1, and the maximum is 365. The default is 10.
-o OUTPUT_FILE, --output_file OUTPUT_FILE
Name and path of file in which the SAS URLs are to be saved. Default is $CWD/sas.txt
</code></pre>
<h3 id="azuresas-file">AzureSAS file</h3>
<p>Create a SAS URL for a file in a container in 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 file: file in which the SAS URLs are to be written. Default is <code>sas.txt</code> in your current working directory</li>
<li>expiry: the number of days the SAS URL with be valid. Minimum is 1, maximum is 365. Default is 10</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 create a SAS URL for file <code>file_name.gz</code> with default settings:</p>
<p><code>AzureSAS file -a account_name -c container-name -f file_name.gz</code></p>
<p>To create a SAS URL for file <code>file_name.gz</code> nested in folder <code>outputs</code> with default settings:</p>
<p><code>AzureSAS file -a account_name -c container-name -f outputs/file_name.gz</code></p>
<p>To create a SAS URL for file <code>file_name.gz</code> with an expiry of 15 days:</p>
<p><code>AzureSAS file -a account_name -c container-name f file_name.gz -e 15</code></p>
<p>To create a SAS URL for file <code>file_name.gz</code>, and save it to the file <code>sas_urls.txt</code> in your current working directory:</p>
<p><code>AzureSAS file -a account_name -c container-name -f file_name.gz -o sas_urls.txt</code></p>
<p>To create a SAS URL for file <code>file_name.gz</code>, and save it to the file <code>sas_urls.txt</code> nested in folder <code>outputs</code> in your current working directory:</p>
<p><code>AzureSAS file -a account_name -c container-name -f file_name.gz -o outputs/sas_urls.txt</code></p>
<h4 id="usage_1">Usage</h4>
<pre><code>usage: AzureSAS file [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] [-e EXPIRY] [-o OUTPUT_FILE] -f FILE
Create a SAS URL for a file in 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 "AzureStorage".
-v VERBOSITY, --verbosity VERBOSITY
Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
-e EXPIRY, --expiry EXPIRY
The number of days that the SAS URL will be valid. The minimum is 1, and the maximum is 365. The default is 10.
-o OUTPUT_FILE, --output_file OUTPUT_FILE
Name and path of file in which the SAS URLs are to be saved. Default is $CWD/sas.txt
-f FILE, --file FILE Path of file in Azure storage from which a SAS URL is to be created. e.g. 2022-SEQ-0001_S1_L001_R1_001.fastq.gz
</code></pre>
<h3 id="azuresas-folder">AzureSAS folder</h3>
<p>Create SAS URLs for all files in a folder in 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 file: file in which the SAS URLs are to be written. Default is <code>sas.txt</code> in your current working directory</li>
<li>expiry: the number of days the SAS URL with be valid. Minimum is 1, maximum is 365. Default is 10</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 create SAS URLs for all files in folder <code>folder_name</code> with default settings:</p>
<p><code>AzureSAS folder -a account_name -c container-name -f folder_name</code></p>
<p>To create SAS URLs for all files in folder <code>folder_name</code> nested in folder <code>outputs</code> with default settings:</p>
<p><code>AzureSAS folder -a account_name -c container-name -f outputs/folder_name</code></p>
<p>To create SAS URLs for all files in folder <code>folder_name</code> with an expiry of 15 days:</p>
<p><code>AzureSAS folder -a account_name -c container-name f folder_name -e 15</code></p>
<p>To create SAS URLs for all files in folder <code>folder_name</code>, and save them to the file <code>sas_urls.txt</code> in your current working directory:</p>
<p><code>AzureSAS folder -a account_name -c container-name -f folder_name -o sas_urls.txt</code></p>
<p>To create SAS URLs for all files in folder <code>folder_name</code>, and save them to the file <code>sas_urls.txt</code> nested in folder <code>outputs</code> in your current working directory:</p>
<p><code>AzureSAS folder -a account_name -c container-name -f folder_name -o outputs/sas_urls.txt</code></p>
<h4 id="usage_2">Usage</h4>
<pre><code>usage: AzureSAS folder [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] [-e EXPIRY] [-o OUTPUT_FILE] -f FOLDER
Create SAS URLs for all files in a folder in 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 "AzureStorage".
-v VERBOSITY, --verbosity VERBOSITY
Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
-e EXPIRY, --expiry EXPIRY
The number of days that the SAS URL will be valid. The minimum is 1, and the maximum is 365. The default is 10.
-o OUTPUT_FILE, --output_file OUTPUT_FILE
Name and path of file in which the SAS URLs are to be saved. Default is $CWD/sas.txt
-f FOLDER, --folder FOLDER
Name of the folder for which SAS URLs are to be created for all files. e.g. InterOp
</code></pre>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../move/" class="btn btn-neutral float-right" title="Move">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../upload/" class="btn btn-neutral" title="Upload"><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="../upload/" style="color: #fcfcfc;">« Previous</a></span>
<span style="margin-left: 15px"><a href="../move/" style="color: #fcfcfc">Next »</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>