index.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  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. <link rel="canonical" href="https://OLC-LOC-Bioinformatics.github.io/AzureStorage/delete/">
  9. <link rel="shortcut icon" href="../img/favicon.ico">
  10. <title>Delete - OLC Bioinformatics Azure Storage</title>
  11. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
  12. <link rel="stylesheet" href="../css/theme.css" />
  13. <link rel="stylesheet" href="../css/theme_extra.css" />
  14. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" />
  15. <script>
  16. // Current page data
  17. var mkdocs_page_name = "Delete";
  18. var mkdocs_page_input_path = "delete.md";
  19. var mkdocs_page_url = "/AzureStorage/delete/";
  20. </script>
  21. <script src="../js/jquery-2.1.1.min.js" defer></script>
  22. <script src="../js/modernizr-2.8.3.min.js" defer></script>
  23. <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
  24. <script>hljs.initHighlightingOnLoad();</script>
  25. </head>
  26. <body class="wy-body-for-nav" role="document">
  27. <div class="wy-grid-for-nav">
  28. <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  29. <div class="wy-side-scroll">
  30. <div class="wy-side-nav-search">
  31. <a href=".." class="icon icon-home"> OLC Bioinformatics Azure Storage</a>
  32. <div role="search">
  33. <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  34. <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  35. </form>
  36. </div>
  37. </div>
  38. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  39. <ul>
  40. <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
  41. </li>
  42. </ul>
  43. <ul>
  44. <li class="toctree-l1"><a class="reference internal" href="../install/">Installation</a>
  45. </li>
  46. </ul>
  47. <ul>
  48. <li class="toctree-l1"><a class="reference internal" href="../credentials/">Credentials</a>
  49. </li>
  50. </ul>
  51. <ul>
  52. <li class="toctree-l1"><a class="reference internal" href="../upload/">Upload</a>
  53. </li>
  54. </ul>
  55. <ul>
  56. <li class="toctree-l1"><a class="reference internal" href="../sas_url/">SAS URL</a>
  57. </li>
  58. </ul>
  59. <ul>
  60. <li class="toctree-l1"><a class="reference internal" href="../move/">Move</a>
  61. </li>
  62. </ul>
  63. <ul>
  64. <li class="toctree-l1"><a class="reference internal" href="../download/">Download</a>
  65. </li>
  66. </ul>
  67. <ul>
  68. <li class="toctree-l1"><a class="reference internal" href="../set_tier/">Set Tier</a>
  69. </li>
  70. </ul>
  71. <ul class="current">
  72. <li class="toctree-l1 current"><a class="reference internal current" href="./">Delete</a>
  73. <ul class="current">
  74. <li class="toctree-l2"><a class="reference internal" href="#general-usage">General usage</a>
  75. </li>
  76. <li class="toctree-l2"><a class="reference internal" href="#azuredelete-container">AzureDelete container</a>
  77. <ul>
  78. <li class="toctree-l3"><a class="reference internal" href="#required-arguments">Required arguments:</a>
  79. </li>
  80. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments">Optional arguments:</a>
  81. </li>
  82. <li class="toctree-l3"><a class="reference internal" href="#example-command">Example command:</a>
  83. </li>
  84. <li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a>
  85. </li>
  86. </ul>
  87. </li>
  88. <li class="toctree-l2"><a class="reference internal" href="#azuredelete-file">AzureDelete file</a>
  89. <ul>
  90. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_1">Required arguments:</a>
  91. </li>
  92. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_1">Optional arguments:</a>
  93. </li>
  94. <li class="toctree-l3"><a class="reference internal" href="#example-commands">Example commands:</a>
  95. </li>
  96. <li class="toctree-l3"><a class="reference internal" href="#usage_1">Usage</a>
  97. </li>
  98. </ul>
  99. </li>
  100. <li class="toctree-l2"><a class="reference internal" href="#azuredelete-folder">AzureDelete folder</a>
  101. <ul>
  102. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_2">Required arguments:</a>
  103. </li>
  104. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_2">Optional arguments:</a>
  105. </li>
  106. <li class="toctree-l3"><a class="reference internal" href="#example-commands_1">Example commands:</a>
  107. </li>
  108. <li class="toctree-l3"><a class="reference internal" href="#usage_2">Usage</a>
  109. </li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. <ul>
  116. <li class="toctree-l1"><a class="reference internal" href="../automate/">Automate</a>
  117. </li>
  118. </ul>
  119. <ul>
  120. <li class="toctree-l1"><a class="reference internal" href="../list/">List</a>
  121. </li>
  122. </ul>
  123. </div>
  124. </div>
  125. </nav>
  126. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  127. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  128. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  129. <a href="..">OLC Bioinformatics Azure Storage</a>
  130. </nav>
  131. <div class="wy-nav-content">
  132. <div class="rst-content">
  133. <div role="navigation" aria-label="breadcrumbs navigation">
  134. <ul class="wy-breadcrumbs">
  135. <li><a href="..">Docs</a> &raquo;</li>
  136. <li>Delete</li>
  137. <li class="wy-breadcrumbs-aside">
  138. <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/delete.md"
  139. class="icon icon-github"> Edit on GitHub</a>
  140. </li>
  141. </ul>
  142. <hr/>
  143. </div>
  144. <div role="main">
  145. <div class="section">
  146. <h2 id="azuredelete">AzureDelete</h2>
  147. <p>Delete containers, files, or folders from your Azure storage account</p>
  148. <p>Choose either the <a href="#azuredelete-container"><code>container</code></a>, <a href="#azuredelete-file"><code>file</code></a>, or <a href="#azuredelete-folder"><code>folder</code></a> functionality</p>
  149. <h4 id="general-usage">General usage</h4>
  150. <pre><code>usage: AzureDelete [-h] {container,file,folder} ...
  151. Move and/or delete containers, files, or folders in Azure storage
  152. optional arguments:
  153. -h, --help show this help message and exit
  154. Available functionality:
  155. {container,file,folder}
  156. container Delete a container in Azure storage
  157. file Delete a file in Azure storage
  158. folder Delete a folder in Azure storage
  159. </code></pre>
  160. <h3 id="azuredelete-container">AzureDelete container</h3>
  161. <p>Delete a container from your Azure storage account</p>
  162. <h4 id="required-arguments">Required arguments:</h4>
  163. <ul>
  164. <li>container name</li>
  165. <li>account name</li>
  166. </ul>
  167. <h4 id="optional-arguments">Optional arguments:</h4>
  168. <ul>
  169. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  170. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  171. </ul>
  172. <h4 id="example-command">Example command:</h4>
  173. <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>
  174. <p>To delete a container from your Azure storage account</p>
  175. <p><code>AzureDelete container -a account_name -c container-name</code></p>
  176. <h4 id="usage">Usage</h4>
  177. <pre><code>usage: AzureDelete container [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY]
  178. Delete a container in Azure storage
  179. optional arguments:
  180. -h, --help show this help message and exit
  181. -c CONTAINER_NAME, --container_name CONTAINER_NAME
  182. 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.
  183. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  184. Name of the Azure storage account
  185. -p PASSPHRASE, --passphrase PASSPHRASE
  186. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  187. -v VERBOSITY, --verbosity VERBOSITY
  188. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  189. </code></pre>
  190. <h3 id="azuredelete-file">AzureDelete file</h3>
  191. <p>Delete a file from your Azure storage account</p>
  192. <h4 id="required-arguments_1">Required arguments:</h4>
  193. <ul>
  194. <li>container name</li>
  195. <li>account name</li>
  196. <li>file name</li>
  197. </ul>
  198. <h4 id="optional-arguments_1">Optional arguments:</h4>
  199. <ul>
  200. <li>retention time: time to retain deleted files. Default is 8 days</li>
  201. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  202. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  203. </ul>
  204. <h4 id="example-commands">Example commands:</h4>
  205. <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>
  206. <p>To delete the file <code>file_name.gz</code> from your Azure storage account</p>
  207. <p><code>AzureDelete file -a account_name -c container-name -f file_name.gz</code></p>
  208. <p>To delete the file <code>file_name.gz</code> nested in folder outputs from your Azure storage account, and retain it for 10 days</p>
  209. <p><code>AzureDelete file -a account_name -c container-name -f outputs/file_name.gz -r 10</code></p>
  210. <h4 id="usage_1">Usage</h4>
  211. <pre><code>usage: AzureDelete file [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -f FILE [-r RETENTION_TIME]
  212. Delete a file in Azure storage
  213. optional arguments:
  214. -h, --help show this help message and exit
  215. -c CONTAINER_NAME, --container_name CONTAINER_NAME
  216. 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.
  217. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  218. Name of the Azure storage account
  219. -p PASSPHRASE, --passphrase PASSPHRASE
  220. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  221. -v VERBOSITY, --verbosity VERBOSITY
  222. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  223. -f FILE, --file FILE Name of blob file to delete in Azure storage. e.g. 2022-SEQ-0001_S1_L001_R1_001.fastq.gz
  224. -r RETENTION_TIME, --retention_time RETENTION_TIME
  225. Retention time for deleted files. Default is 8 days. Must be between 1 and 365
  226. </code></pre>
  227. <h3 id="azuredelete-folder">AzureDelete folder</h3>
  228. <p>Delete a folder from your Azure storage account</p>
  229. <h4 id="required-arguments_2">Required arguments:</h4>
  230. <ul>
  231. <li>container name</li>
  232. <li>account name</li>
  233. <li>folder name</li>
  234. </ul>
  235. <h4 id="optional-arguments_2">Optional arguments:</h4>
  236. <ul>
  237. <li>retention time: time to retain deleted files in the folder. Default is 8 days</li>
  238. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  239. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  240. </ul>
  241. <h4 id="example-commands_1">Example commands:</h4>
  242. <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>
  243. <p>To delete the folder <code>folder_name</code> from your Azure storage account</p>
  244. <p><code>AzureDelete folder -a account_name -c container-name -f folder_name</code></p>
  245. <p>To delete the folder <code>folder_name</code> nested in folder outputs from your Azure storage account, and retain it for 10 days</p>
  246. <p><code>AzureDelete folder -a account_name -c container-name -f outputs/folder_name -r 10</code></p>
  247. <h4 id="usage_2">Usage</h4>
  248. <pre><code>usage: AzureDelete folder [-h] -c CONTAINER_NAME -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -f FOLDER [-r RETENTION_TIME]
  249. Delete a folder in Azure storage
  250. optional arguments:
  251. -h, --help show this help message and exit
  252. -c CONTAINER_NAME, --container_name CONTAINER_NAME
  253. 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.
  254. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  255. Name of the Azure storage account
  256. -p PASSPHRASE, --passphrase PASSPHRASE
  257. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  258. -v VERBOSITY, --verbosity VERBOSITY
  259. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  260. -f FOLDER, --folder FOLDER
  261. Name of folder to delete in Azure storage. e.g. InterOp
  262. -r RETENTION_TIME, --retention_time RETENTION_TIME
  263. Retention time for deleted files. Default is 8 days
  264. </code></pre>
  265. </div>
  266. </div>
  267. <footer>
  268. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  269. <a href="../automate/" class="btn btn-neutral float-right" title="Automate">Next <span class="icon icon-circle-arrow-right"></span></a>
  270. <a href="../set_tier/" class="btn btn-neutral" title="Set Tier"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  271. </div>
  272. <hr/>
  273. <div role="contentinfo">
  274. <!-- Copyright etc -->
  275. </div>
  276. 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>.
  277. </footer>
  278. </div>
  279. </div>
  280. </section>
  281. </div>
  282. <div class="rst-versions" role="note" aria-label="versions">
  283. <span class="rst-current-version" data-toggle="rst-current-version">
  284. <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
  285. <span><a href="../set_tier/" style="color: #fcfcfc;">&laquo; Previous</a></span>
  286. <span style="margin-left: 15px"><a href="../automate/" style="color: #fcfcfc">Next &raquo;</a></span>
  287. </span>
  288. </div>
  289. <script>var base_url = '..';</script>
  290. <script src="../js/theme.js" defer></script>
  291. <script src="../search/main.js" defer></script>
  292. <script defer>
  293. window.onload = function () {
  294. SphinxRtdTheme.Navigation.enable(true);
  295. };
  296. </script>
  297. </body>
  298. </html>