index.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <meta name="description" content="Tools for manipulating files in Azure storage, including upload, download, SAS URL creation, move, delete">
  9. <link rel="canonical" href="https://OLC-LOC-Bioinformatics.github.io/AzureStorage/">
  10. <link rel="shortcut icon" href="img/favicon.ico">
  11. <title>OLC Bioinformatics Azure Storage</title>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
  13. <link rel="stylesheet" href="css/theme.css" />
  14. <link rel="stylesheet" href="css/theme_extra.css" />
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" />
  16. <script>
  17. // Current page data
  18. var mkdocs_page_name = "Home";
  19. var mkdocs_page_input_path = "index.md";
  20. var mkdocs_page_url = "/AzureStorage/";
  21. </script>
  22. <script src="js/jquery-2.1.1.min.js" defer></script>
  23. <script src="js/modernizr-2.8.3.min.js" defer></script>
  24. <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
  25. <script>hljs.initHighlightingOnLoad();</script>
  26. </head>
  27. <body class="wy-body-for-nav" role="document">
  28. <div class="wy-grid-for-nav">
  29. <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  30. <div class="wy-side-scroll">
  31. <div class="wy-side-nav-search">
  32. <a href="." class="icon icon-home"> OLC Bioinformatics Azure Storage</a>
  33. <div role="search">
  34. <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
  35. <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  36. </form>
  37. </div>
  38. </div>
  39. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  40. <ul class="current">
  41. <li class="toctree-l1 current"><a class="reference internal current" href=".">Home</a>
  42. <ul class="current">
  43. <li class="toctree-l2"><a class="reference internal" href="#feedback">Feedback</a>
  44. </li>
  45. </ul>
  46. </li>
  47. </ul>
  48. <ul>
  49. <li class="toctree-l1"><a class="reference internal" href="install/">Installation</a>
  50. </li>
  51. </ul>
  52. <ul>
  53. <li class="toctree-l1"><a class="reference internal" href="credentials/">Credentials</a>
  54. </li>
  55. </ul>
  56. <ul>
  57. <li class="toctree-l1"><a class="reference internal" href="upload/">Upload</a>
  58. </li>
  59. </ul>
  60. <ul>
  61. <li class="toctree-l1"><a class="reference internal" href="sas_url/">SAS URL</a>
  62. </li>
  63. </ul>
  64. <ul>
  65. <li class="toctree-l1"><a class="reference internal" href="move/">Move</a>
  66. </li>
  67. </ul>
  68. <ul>
  69. <li class="toctree-l1"><a class="reference internal" href="download/">Download</a>
  70. </li>
  71. </ul>
  72. <ul>
  73. <li class="toctree-l1"><a class="reference internal" href="set_tier/">Set Tier</a>
  74. </li>
  75. </ul>
  76. <ul>
  77. <li class="toctree-l1"><a class="reference internal" href="delete/">Delete</a>
  78. </li>
  79. </ul>
  80. <ul>
  81. <li class="toctree-l1"><a class="reference internal" href="automate/">Automate</a>
  82. </li>
  83. </ul>
  84. <ul>
  85. <li class="toctree-l1"><a class="reference internal" href="list/">List</a>
  86. </li>
  87. </ul>
  88. </div>
  89. </div>
  90. </nav>
  91. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  92. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  93. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  94. <a href=".">OLC Bioinformatics Azure Storage</a>
  95. </nav>
  96. <div class="wy-nav-content">
  97. <div class="rst-content">
  98. <div role="navigation" aria-label="breadcrumbs navigation">
  99. <ul class="wy-breadcrumbs">
  100. <li><a href=".">Docs</a> &raquo;</li>
  101. <li>Home</li>
  102. <li class="wy-breadcrumbs-aside">
  103. <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/index.md"
  104. class="icon icon-github"> Edit on GitHub</a>
  105. </li>
  106. </ul>
  107. <hr/>
  108. </div>
  109. <div role="main">
  110. <div class="section">
  111. <h2 id="olc-bioinformatics-azurestorage-tools">OLC Bioinformatics AzureStorage tools</h2>
  112. <p>This suite of tools (written in Python) allows you to manipulate containers/files/folders in your Azure storage account.</p>
  113. <p>There are nine scripts in this package:</p>
  114. <ol>
  115. <li><a href="credentials/"><code>AzureCredentials</code></a>: enter, modify, or delete your Azure connection string and account name into your system keyring, avoiding storing plain text passwords, environmental variables, and entering the connection string every time you run one of the scripts in the package</li>
  116. <li><a href="upload/"><code>AzureUpload</code></a>: upload a file or folder to a container in your Azure storage account</li>
  117. <li><a href="sas_url/"><code>AzureSAS</code></a>: create SAS (shared access signature) URLs for a file, a folder, or an entire container in your Azure storage account.</li>
  118. <li><a href="move/"><code>AzureMove</code></a>: move a file, folder, or an entire container within your Azure storage account</li>
  119. <li><a href="download/"><code>AzureDownload</code></a>: download a file, folder, or an entire container from your Azure storage account</li>
  120. <li><a href="set_tier/"><code>AzureTier</code></a>: set the storage tier of a file, folder, or an entire container from your Azure storage account</li>
  121. <li><a href="delete/"><code>AzureDelete</code></a>: delete a file, folder, or an entire container from your Azure storage account</li>
  122. <li><a href="automate/"><code>AzureAutomate</code></a>: run upload, sas, move, download, set_tier, and/or delete in batch</li>
  123. <li><a href="list/"><code>AzureList</code></a>: List and optionally filter containers and/or files in your Azure storage account</li>
  124. </ol>
  125. <h3 id="feedback">Feedback</h3>
  126. <p>If you encounter any issues installing or running AzureStorage, have feature requests, or need assistance, please <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/issues/new/choose">open an issue on GitHub</a>, or email me at <code>adam.koziol@inspection.gc.ca</code> </p>
  127. </div>
  128. </div>
  129. <footer>
  130. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  131. <a href="install/" class="btn btn-neutral float-right" title="Installation">Next <span class="icon icon-circle-arrow-right"></span></a>
  132. </div>
  133. <hr/>
  134. <div role="contentinfo">
  135. <!-- Copyright etc -->
  136. </div>
  137. 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>.
  138. </footer>
  139. </div>
  140. </div>
  141. </section>
  142. </div>
  143. <div class="rst-versions" role="note" aria-label="versions">
  144. <span class="rst-current-version" data-toggle="rst-current-version">
  145. <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
  146. <span style="margin-left: 15px"><a href="install/" style="color: #fcfcfc">Next &raquo;</a></span>
  147. </span>
  148. </div>
  149. <script>var base_url = '.';</script>
  150. <script src="js/theme.js" defer></script>
  151. <script src="search/main.js" defer></script>
  152. <script defer>
  153. window.onload = function () {
  154. SphinxRtdTheme.Navigation.enable(true);
  155. };
  156. </script>
  157. </body>
  158. </html>
  159. <!--
  160. MkDocs version : 1.1.2
  161. Build Date UTC : 2022-05-06 13:41:25.340439+00:00
  162. -->