<!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/credentials/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Credentials - 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 = "Credentials";
var mkdocs_page_input_path = "credentials.md";
var mkdocs_page_url = "/AzureStorage/credentials/";
</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 class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Credentials</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="#azure-credentials-store">Azure credentials store</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="#azure-credentials-delete">Azure credentials delete</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-command">Example command:</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#usage_1">Usage</a>
</li>
</ul>
</li>
</ul>
</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>
<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>Credentials</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/credentials.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h2 id="azurecredentials">AzureCredentials</h2>
<p>AzureCredentials allows you to store, modify, or delete your Azure account name and connection string in the system keyring</p>
<p>Choose either the <a href="#azure-credentials-store"><code>store</code></a> or <a href="#azure-credentials-delete"><code>delete</code></a> functionality</p>
<p><a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#:~:text=You%20can%20find%20your%20storage,primary%20and%20secondary%20access%20keys.">Find your connection string</a></p>
<p><a href="https://www.zenko.io/blog/how-to-find-keys-and-account-info-for-aws-azure-and-google/#:~:text=Azure%20Account%20Name%C2%A0%3D%20the%20name%20of%20your%20Azure%20storage%20account%20located%20on%20the%20top%20of%20the%20Azure%20Portal%20(screenshot%20below%20%E2%80%93%20%E2%80%9Cscalitydemo%E2%80%9D%20is%20Azure%20Account%20Name).">Find your account key</a></p>
<h4 id="general-usage">General Usage</h4>
<pre><code>usage: AzureCredentials [-h] {store,delete} ...
Set, modify, or delete Azure storage credentials in the system keyring
optional arguments:
-h, --help show this help message and exit
Available functionality:
{store,delete}
store Store or update Azure storage credentials in the system keyring
delete Delete Azure storage credentials in the system keyring
</code></pre>
<h3 id="azure-credentials-store">Azure credentials store</h3>
<p>Store or modify your account name and connection string in the system keyring</p>
<h4 id="required-arguments">Required arguments:</h4>
<ul>
<li>account name</li>
</ul>
<h4 id="optional-arguments">Optional arguments:</h4>
<ul>
<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>To store the account name <code>account_name</code> and your connection string in the system keyring</p>
<p><code>AzureCredentials store -a account_name</code></p>
<p>NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.</p>
<p>To store the account name <code>account_name</code> and your connection string in the system keyring using the passphrase <code>passphrase</code></p>
<p><code>AzureCredentials store -a account_name -p passphrase</code></p>
<p>NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered. </p>
<h4 id="usage">Usage</h4>
<pre><code>usage: AzureCredentials store [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY]
Store or update Azure storage credentials in the system keyring
optional arguments:
-h, --help show this help message and exit
-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.
</code></pre>
<h3 id="azure-credentials-delete">Azure credentials delete</h3>
<p>Delete your account name and connection string from the system keyring</p>
<h4 id="required-arguments_1">Required arguments:</h4>
<ul>
<li>account name</li>
</ul>
<h4 id="optional-arguments_1">Optional arguments:</h4>
<ul>
<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-command">Example command:</h4>
<p>To delete the account name <code>account_name</code> and your connection string from the system keyring</p>
<p><code>AzureCredentials delete -a account_name</code></p>
<p>NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.</p>
<p>To delete the account name <code>account_name</code> and your connection string from the system keyring stored using the passphrase <code>passphrase</code></p>
<p><code>AzureCredentials delete -a account_name -p passphrase</code></p>
<p>NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.</p>
<h4 id="usage_1">Usage</h4>
<pre><code>usage: AzureCredentials delete [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY]
Delete Azure storage credentials in the system keyring
optional arguments:
-h, --help show this help message and exit
-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.
</code></pre>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../upload/" class="btn btn-neutral float-right" title="Upload">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../install/" class="btn btn-neutral" title="Installation"><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="../install/" style="color: #fcfcfc;">« Previous</a></span>
<span style="margin-left: 15px"><a href="../upload/" 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>