index.html 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185
  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/automate/">
  9. <link rel="shortcut icon" href="../img/favicon.ico">
  10. <title>Automate - 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 = "Automate";
  18. var mkdocs_page_input_path = "automate.md";
  19. var mkdocs_page_url = "/AzureStorage/automate/";
  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>
  72. <li class="toctree-l1"><a class="reference internal" href="../delete/">Delete</a>
  73. </li>
  74. </ul>
  75. <ul class="current">
  76. <li class="toctree-l1 current"><a class="reference internal current" href="./">Automate</a>
  77. <ul class="current">
  78. <li class="toctree-l2"><a class="reference internal" href="#general-usage">General usage</a>
  79. </li>
  80. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-upload">AzureAutomate upload</a>
  81. <ul>
  82. <li class="toctree-l3"><a class="reference internal" href="#general-usage_1">General usage</a>
  83. </li>
  84. </ul>
  85. </li>
  86. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-upload-file">AzureAutomate upload file</a>
  87. <ul>
  88. <li class="toctree-l3"><a class="reference internal" href="#required-arguments">Required arguments:</a>
  89. </li>
  90. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments">Optional arguments:</a>
  91. </li>
  92. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format">Batch file format</a>
  93. </li>
  94. <li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a>
  95. </li>
  96. </ul>
  97. </li>
  98. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-upload-folder">AzureAutomate upload folder</a>
  99. <ul>
  100. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_1">Required arguments:</a>
  101. </li>
  102. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_1">Optional arguments:</a>
  103. </li>
  104. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_1">Batch file format</a>
  105. </li>
  106. <li class="toctree-l3"><a class="reference internal" href="#usage_1">Usage</a>
  107. </li>
  108. </ul>
  109. </li>
  110. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-sas">AzureAutomate sas</a>
  111. <ul>
  112. <li class="toctree-l3"><a class="reference internal" href="#general-usage_2">General usage</a>
  113. </li>
  114. <li class="toctree-l3"><a class="reference internal" href="#azureautomate-sas-container">AzureAutomate sas container</a>
  115. </li>
  116. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_2">Required arguments:</a>
  117. </li>
  118. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_2">Optional arguments:</a>
  119. </li>
  120. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_2">Batch file format</a>
  121. </li>
  122. <li class="toctree-l3"><a class="reference internal" href="#usage_2">Usage</a>
  123. </li>
  124. <li class="toctree-l3"><a class="reference internal" href="#azureautomate-sas-file">AzureAutomate sas file</a>
  125. </li>
  126. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_3">Required arguments:</a>
  127. </li>
  128. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_3">Optional arguments:</a>
  129. </li>
  130. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_3">Batch file format</a>
  131. </li>
  132. <li class="toctree-l3"><a class="reference internal" href="#usage_3">Usage</a>
  133. </li>
  134. <li class="toctree-l3"><a class="reference internal" href="#azureautomate-sas-folder">AzureAutomate sas folder</a>
  135. </li>
  136. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_4">Required arguments:</a>
  137. </li>
  138. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_4">Optional arguments:</a>
  139. </li>
  140. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_4">Batch file format</a>
  141. </li>
  142. <li class="toctree-l3"><a class="reference internal" href="#usage_4">Usage</a>
  143. </li>
  144. </ul>
  145. </li>
  146. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-move">AzureAutomate move</a>
  147. <ul>
  148. <li class="toctree-l3"><a class="reference internal" href="#general-usage_3">General usage</a>
  149. </li>
  150. <li class="toctree-l3"><a class="reference internal" href="#azureautomate-move-container">AzureAutomate move container</a>
  151. </li>
  152. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_5">Required arguments:</a>
  153. </li>
  154. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_5">Optional arguments:</a>
  155. </li>
  156. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_5">Batch file format</a>
  157. </li>
  158. <li class="toctree-l3"><a class="reference internal" href="#usage_5">Usage</a>
  159. </li>
  160. <li class="toctree-l3"><a class="reference internal" href="#azureautomate-move-file">AzureAutomate move file</a>
  161. </li>
  162. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_6">Required arguments:</a>
  163. </li>
  164. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_6">Optional arguments:</a>
  165. </li>
  166. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_6">Batch file format</a>
  167. </li>
  168. <li class="toctree-l3"><a class="reference internal" href="#usage_6">Usage</a>
  169. </li>
  170. <li class="toctree-l3"><a class="reference internal" href="#azureautomate-move-folder">AzureAutomate move folder</a>
  171. </li>
  172. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_7">Required arguments:</a>
  173. </li>
  174. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_7">Optional arguments:</a>
  175. </li>
  176. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_7">Batch file format</a>
  177. </li>
  178. <li class="toctree-l3"><a class="reference internal" href="#usage_7">Usage</a>
  179. </li>
  180. </ul>
  181. </li>
  182. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download">AzureAutomate download</a>
  183. <ul>
  184. <li class="toctree-l3"><a class="reference internal" href="#general-usage_4">General usage</a>
  185. </li>
  186. </ul>
  187. </li>
  188. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download-container">AzureAutomate download container</a>
  189. <ul>
  190. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_8">Required arguments:</a>
  191. </li>
  192. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_8">Optional arguments:</a>
  193. </li>
  194. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_8">Batch file format</a>
  195. </li>
  196. <li class="toctree-l3"><a class="reference internal" href="#usage_8">Usage</a>
  197. </li>
  198. </ul>
  199. </li>
  200. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download-file">AzureAutomate download file</a>
  201. <ul>
  202. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_9">Required arguments:</a>
  203. </li>
  204. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_9">Optional arguments:</a>
  205. </li>
  206. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_9">Batch file format</a>
  207. </li>
  208. <li class="toctree-l3"><a class="reference internal" href="#usage_9">Usage</a>
  209. </li>
  210. </ul>
  211. </li>
  212. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download-folder">AzureAutomate download folder</a>
  213. <ul>
  214. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_10">Required arguments:</a>
  215. </li>
  216. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_10">Optional arguments:</a>
  217. </li>
  218. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_10">Batch file format</a>
  219. </li>
  220. <li class="toctree-l3"><a class="reference internal" href="#usage_10">Usage</a>
  221. </li>
  222. </ul>
  223. </li>
  224. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier">AzureAutomate tier</a>
  225. <ul>
  226. <li class="toctree-l3"><a class="reference internal" href="#general-usage_5">General usage</a>
  227. </li>
  228. </ul>
  229. </li>
  230. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier-container">AzureAutomate tier container</a>
  231. <ul>
  232. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_11">Required arguments:</a>
  233. </li>
  234. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_11">Optional arguments:</a>
  235. </li>
  236. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_11">Batch file format</a>
  237. </li>
  238. <li class="toctree-l3"><a class="reference internal" href="#usage_11">Usage</a>
  239. </li>
  240. </ul>
  241. </li>
  242. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier-file">AzureAutomate tier file</a>
  243. <ul>
  244. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_12">Required arguments:</a>
  245. </li>
  246. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_12">Optional arguments:</a>
  247. </li>
  248. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_12">Batch file format</a>
  249. </li>
  250. <li class="toctree-l3"><a class="reference internal" href="#usage_12">Usage</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier-folder">AzureAutomate tier folder</a>
  255. <ul>
  256. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_13">Required arguments:</a>
  257. </li>
  258. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_13">Optional arguments:</a>
  259. </li>
  260. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_13">Batch file format</a>
  261. </li>
  262. <li class="toctree-l3"><a class="reference internal" href="#usage_13">Usage</a>
  263. </li>
  264. </ul>
  265. </li>
  266. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete">AzureAutomate delete</a>
  267. <ul>
  268. <li class="toctree-l3"><a class="reference internal" href="#general-usage_6">General usage</a>
  269. </li>
  270. </ul>
  271. </li>
  272. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete-container">AzureAutomate delete container</a>
  273. <ul>
  274. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_14">Required arguments:</a>
  275. </li>
  276. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_14">Optional arguments:</a>
  277. </li>
  278. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_14">Batch file format</a>
  279. </li>
  280. <li class="toctree-l3"><a class="reference internal" href="#usage_14">Usage</a>
  281. </li>
  282. </ul>
  283. </li>
  284. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete-file">AzureAutomate delete file</a>
  285. <ul>
  286. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_15">Required arguments:</a>
  287. </li>
  288. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_15">Optional arguments:</a>
  289. </li>
  290. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_15">Batch file format</a>
  291. </li>
  292. <li class="toctree-l3"><a class="reference internal" href="#usage_15">Usage</a>
  293. </li>
  294. </ul>
  295. </li>
  296. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete-folder">AzureAutomate delete folder</a>
  297. <ul>
  298. <li class="toctree-l3"><a class="reference internal" href="#required-arguments_16">Required arguments:</a>
  299. </li>
  300. <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_16">Optional arguments:</a>
  301. </li>
  302. <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_16">Batch file format</a>
  303. </li>
  304. <li class="toctree-l3"><a class="reference internal" href="#usage_16">Usage</a>
  305. </li>
  306. </ul>
  307. </li>
  308. <li class="toctree-l2"><a class="reference internal" href="#azureautomate-batch">AzureAutomate batch</a>
  309. </li>
  310. <li class="toctree-l2"><a class="reference internal" href="#batch-file-format_17">Batch file format</a>
  311. </li>
  312. <li class="toctree-l2"><a class="reference internal" href="#usage_17">Usage</a>
  313. </li>
  314. </ul>
  315. </li>
  316. </ul>
  317. <ul>
  318. <li class="toctree-l1"><a class="reference internal" href="../list/">List</a>
  319. </li>
  320. </ul>
  321. </div>
  322. </div>
  323. </nav>
  324. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  325. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  326. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  327. <a href="..">OLC Bioinformatics Azure Storage</a>
  328. </nav>
  329. <div class="wy-nav-content">
  330. <div class="rst-content">
  331. <div role="navigation" aria-label="breadcrumbs navigation">
  332. <ul class="wy-breadcrumbs">
  333. <li><a href="..">Docs</a> &raquo;</li>
  334. <li>Automate</li>
  335. <li class="wy-breadcrumbs-aside">
  336. <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/automate.md"
  337. class="icon icon-github"> Edit on GitHub</a>
  338. </li>
  339. </ul>
  340. <hr/>
  341. </div>
  342. <div role="main">
  343. <div class="section">
  344. <h2 id="azureautomate">AzureAutomate</h2>
  345. <p>Perform multiple upload, SAS URL creation, move, download, storage tier setting, or delete actions. Alternatively, perform multiple actions in a single call</p>
  346. <p>Choose either the <a href="#azureautomate-upload"><code>upload</code></a>, <a href="#azureautomate-sas"><code>sas</code></a>, <a href="#azureautomate-move"><code>move</code></a>, <a href="#azureautomate-download"><code>download</code></a>, <a href="#azureautomate-tier"><code>tier</code></a>, <a href="#azureautomate-delete"><code>delete</code></a>, or <a href="#azureautomate-batch"><code>batch</code></a> functionality</p>
  347. <h4 id="general-usage">General usage</h4>
  348. <pre><code>usage: AzureAutomate [-h] {upload,sas,move,download,tier,delete,batch} ...
  349. Automate the submission of multiple AzureStorage commands
  350. optional arguments:
  351. -h, --help show this help message and exit
  352. Available functionality:
  353. {upload,sas,move,download,tier,delete,batch}
  354. upload Upload files/folders to Azure storage
  355. sas Create SAS URLs for containers/files/folders in Azure storage
  356. move Move containers/files/folders in Azure storage
  357. download Download containers/files/folders in Azure storage
  358. tier Set the storage tier of containers/files/folders in Azure storage
  359. delete Delete containers/files/folders in Azure storage
  360. batch Perform multiple different operations in batch
  361. </code></pre>
  362. <h3 id="azureautomate-upload">AzureAutomate upload</h3>
  363. <p>Choose either the <a href="#azureautomate-upload-file"><code>file</code></a> or <a href="#azureautomate-upload-folder"><code>folder</code></a> functionality</p>
  364. <h4 id="general-usage_1">General usage</h4>
  365. <pre><code>usage: AzureAutomate upload [-h] {file,folder} ...
  366. Upload files/folders to Azure storage
  367. optional arguments:
  368. -h, --help show this help message and exit
  369. Upload functionality:
  370. {file,folder}
  371. file Upload files to Azure storage
  372. folder Upload folders to Azure storage
  373. </code></pre>
  374. <h3 id="azureautomate-upload-file">AzureAutomate upload file</h3>
  375. <p>Automate the upload of multiple files to your Azure storage account</p>
  376. <h4 id="required-arguments">Required arguments:</h4>
  377. <ul>
  378. <li>container name</li>
  379. <li>account name</li>
  380. <li>name and path of batch file</li>
  381. </ul>
  382. <h4 id="optional-arguments">Optional arguments:</h4>
  383. <ul>
  384. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  385. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  386. </ul>
  387. <h4 id="batch-file-format">Batch file format</h4>
  388. <p>Tab-separated file with the following fields:</p>
  389. <p><code>container name, file name, destination path (optional), storage tier (optional)</code></p>
  390. <p>For additional details on running file uploads, please see the <a href="../upload/#azureupload-file"><code>AzureUpload file</code></a> section</p>
  391. <h4 id="usage">Usage</h4>
  392. <pre><code>usage: AzureAutomate upload file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  393. Upload files to Azure storage
  394. optional arguments:
  395. -h, --help show this help message and exit
  396. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  397. Name of the Azure storage account
  398. -p PASSPHRASE, --passphrase PASSPHRASE
  399. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  400. -v VERBOSITY, --verbosity VERBOSITY
  401. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  402. -b BATCH_FILE, --batch_file BATCH_FILE
  403. Tab-separated file with the following fields:
  404. container name, file name, destination path (optional), storage tier (optional)
  405. </code></pre>
  406. <h3 id="azureautomate-upload-folder">AzureAutomate upload folder</h3>
  407. <p>Automate the upload of multiple folders to your Azure storage account</p>
  408. <h4 id="required-arguments_1">Required arguments:</h4>
  409. <ul>
  410. <li>container name</li>
  411. <li>account name</li>
  412. <li>name and path of batch file</li>
  413. </ul>
  414. <h4 id="optional-arguments_1">Optional arguments:</h4>
  415. <ul>
  416. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  417. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  418. </ul>
  419. <h4 id="batch-file-format_1">Batch file format</h4>
  420. <p>Tab-separated file with the following fields:</p>
  421. <p><code>container name, folder name, destination path (optional), storage tier (optional)</code></p>
  422. <p>For additional details on running folder uploads, please see the <a href="../upload/#azureupload-folder"><code>AzureUpload folder</code></a> section</p>
  423. <h4 id="usage_1">Usage</h4>
  424. <pre><code>usage: AzureAutomate upload folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  425. Upload folders to Azure storage
  426. optional arguments:
  427. -h, --help show this help message and exit
  428. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  429. Name of the Azure storage account
  430. -p PASSPHRASE, --passphrase PASSPHRASE
  431. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  432. -v VERBOSITY, --verbosity VERBOSITY
  433. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  434. -b BATCH_FILE, --batch_file BATCH_FILE
  435. Tab-separated file with the following fields (one entry per line):
  436. container name, folder name, destination path (optional), storage tier (optional)
  437. </code></pre>
  438. <h3 id="azureautomate-sas">AzureAutomate sas</h3>
  439. <p>Choose either the <a href="#azureautomate-sas-container"><code>container</code></a>, <a href="#azureautomate-sas-file"><code>file</code></a>, or <a href="#azureautomate-sas-folder"><code>folder</code></a> functionality</p>
  440. <h4 id="general-usage_2">General usage</h4>
  441. <pre><code>usage: AzureAutomate sas [-h] {container,file,folder} ...
  442. Create SAS URLs for containers/files/folders in Azure storage
  443. optional arguments:
  444. -h, --help show this help message and exit
  445. SAS URL creation functionality:
  446. {container,file,folder}
  447. container Create SAS URLs for containers in Azure storage
  448. file Create SAS URLs for files in Azure storage
  449. folder Create SAS URLs for folders in Azure storage
  450. </code></pre>
  451. <h4 id="azureautomate-sas-container">AzureAutomate sas container</h4>
  452. <p>Automate the creation of SAS URLs for multiple containers in your Azure storage account</p>
  453. <h4 id="required-arguments_2">Required arguments:</h4>
  454. <ul>
  455. <li>container name</li>
  456. <li>account name</li>
  457. <li>name and path of batch file</li>
  458. </ul>
  459. <h4 id="optional-arguments_2">Optional arguments:</h4>
  460. <ul>
  461. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  462. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  463. </ul>
  464. <h4 id="batch-file-format_2">Batch file format</h4>
  465. <p>Tab-separated file with the following fields:</p>
  466. <p><code>container name, expiry (optional), output file (optional)</code></p>
  467. <p>For additional details on creating SAS URLs for containers, please see the <a href="../sas_url/#azuresas-container"><code>AzureSAS container</code></a> section</p>
  468. <h4 id="usage_2">Usage</h4>
  469. <pre><code>usage: AzureAutomate sas container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  470. Create SAS URLs for containers in Azure storage
  471. optional arguments:
  472. -h, --help show this help message and exit
  473. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  474. Name of the Azure storage account
  475. -p PASSPHRASE, --passphrase PASSPHRASE
  476. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  477. -v VERBOSITY, --verbosity VERBOSITY
  478. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  479. -b BATCH_FILE, --batch_file BATCH_FILE
  480. Tab-separated file with the following fields:
  481. container name, expiry (optional), output file (optional)
  482. </code></pre>
  483. <h4 id="azureautomate-sas-file">AzureAutomate sas file</h4>
  484. <p>Automate the creation of SAS URLs for multiple files in your Azure storage account</p>
  485. <h4 id="required-arguments_3">Required arguments:</h4>
  486. <ul>
  487. <li>container name</li>
  488. <li>account name</li>
  489. <li>name and path of batch file</li>
  490. </ul>
  491. <h4 id="optional-arguments_3">Optional arguments:</h4>
  492. <ul>
  493. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  494. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  495. </ul>
  496. <h4 id="batch-file-format_3">Batch file format</h4>
  497. <p>Tab-separated file with the following fields:</p>
  498. <p><code>container name, file name and path, expiry (optional), output file (optional)</code></p>
  499. <p>For additional details on creating SAS URLs for files, please see the <a href="../sas_url/#azuresas-file"><code>AzureSAS file</code></a> section</p>
  500. <h4 id="usage_3">Usage</h4>
  501. <pre><code>usage: AzureAutomate sas file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  502. Create SAS URLs for files in Azure storage
  503. optional arguments:
  504. -h, --help show this help message and exit
  505. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  506. Name of the Azure storage account
  507. -p PASSPHRASE, --passphrase PASSPHRASE
  508. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  509. -v VERBOSITY, --verbosity VERBOSITY
  510. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  511. -b BATCH_FILE, --batch_file BATCH_FILE
  512. Tab-separated file with the following fields:
  513. container name, file name and path, expiry (optional), output file (optional)
  514. </code></pre>
  515. <h4 id="azureautomate-sas-folder">AzureAutomate sas folder</h4>
  516. <p>Automate the creation of SAS URLs for multiple folders in your Azure storage account</p>
  517. <h4 id="required-arguments_4">Required arguments:</h4>
  518. <ul>
  519. <li>container name</li>
  520. <li>account name</li>
  521. <li>name and path of batch file</li>
  522. </ul>
  523. <h4 id="optional-arguments_4">Optional arguments:</h4>
  524. <ul>
  525. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  526. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  527. </ul>
  528. <h4 id="batch-file-format_4">Batch file format</h4>
  529. <p>Tab-separated file with the following fields:</p>
  530. <p><code>container name, folder name and path, expiry (optional), output file (optional)</code></p>
  531. <p>For additional details on creating SAS URLs for folders, please see the <a href="../sas_url/#azuresas-folder"><code>AzureSAS folder</code></a> section</p>
  532. <h4 id="usage_4">Usage</h4>
  533. <pre><code>usage: AzureAutomate sas folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  534. Create SAS URLs for folders in Azure storage
  535. optional arguments:
  536. -h, --help show this help message and exit
  537. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  538. Name of the Azure storage account
  539. -p PASSPHRASE, --passphrase PASSPHRASE
  540. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  541. -v VERBOSITY, --verbosity VERBOSITY
  542. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  543. -b BATCH_FILE, --batch_file BATCH_FILE
  544. Tab-separated file with the following fields:
  545. container name, folder name and path, expiry (optional), output file (optional)
  546. </code></pre>
  547. <h3 id="azureautomate-move">AzureAutomate move</h3>
  548. <p>Choose either the <a href="#azureautomate-move-container"><code>container</code></a>, <a href="#azureautomate-move-file"><code>file</code></a>, or <a href="#azureautomate-move-folder"><code>folder</code></a> functionality</p>
  549. <h4 id="general-usage_3">General usage</h4>
  550. <pre><code>usage: AzureAutomate move [-h] {container,file,folder} ...
  551. Move containers/files/folders in Azure storage
  552. optional arguments:
  553. -h, --help show this help message and exit
  554. Move functionality:
  555. {container,file,folder}
  556. container Move containers in Azure storage
  557. file Move files in Azure storage
  558. folder Move folders in Azure storage
  559. </code></pre>
  560. <h4 id="azureautomate-move-container">AzureAutomate move container</h4>
  561. <p>Automate the moving of multiple containers in your Azure storage account</p>
  562. <h4 id="required-arguments_5">Required arguments:</h4>
  563. <ul>
  564. <li>container name</li>
  565. <li>account name</li>
  566. <li>name and path of batch file</li>
  567. </ul>
  568. <h4 id="optional-arguments_5">Optional arguments:</h4>
  569. <ul>
  570. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  571. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  572. </ul>
  573. <h4 id="batch-file-format_5">Batch file format</h4>
  574. <p>Tab-separated file with the following fields:</p>
  575. <p><code>container name, target container, destination path (optional), storage tier (optional)</code></p>
  576. <p>For additional details on moving containers, please see the <a href="../move/#azuremove-container"><code>AzureMove container</code></a> section</p>
  577. <h4 id="usage_5">Usage</h4>
  578. <pre><code>usage: AzureAutomate move container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  579. Move containers in Azure storage
  580. optional arguments:
  581. -h, --help show this help message and exit
  582. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  583. Name of the Azure storage account
  584. -p PASSPHRASE, --passphrase PASSPHRASE
  585. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  586. -v VERBOSITY, --verbosity VERBOSITY
  587. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  588. -b BATCH_FILE, --batch_file BATCH_FILE
  589. Tab-separated file with the following fields:
  590. container name, target container, destination path (optional), storage tier (optional)
  591. </code></pre>
  592. <h4 id="azureautomate-move-file">AzureAutomate move file</h4>
  593. <p>Automate the moving of multiple files in your Azure storage account</p>
  594. <h4 id="required-arguments_6">Required arguments:</h4>
  595. <ul>
  596. <li>container name</li>
  597. <li>account name</li>
  598. <li>name and path of batch file</li>
  599. </ul>
  600. <h4 id="optional-arguments_6">Optional arguments:</h4>
  601. <ul>
  602. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  603. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  604. </ul>
  605. <h4 id="batch-file-format_6">Batch file format</h4>
  606. <p>Tab-separated file with the following fields:</p>
  607. <p><code>container name, target container, file name, destination path (optional), storage tier (optional)</code></p>
  608. <p>For additional details on moving files, please see the <a href="../move/#azuremove-file"><code>AzureMove file</code></a> section</p>
  609. <h4 id="usage_6">Usage</h4>
  610. <pre><code>usage: AzureAutomate move file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  611. Move files in Azure storage
  612. optional arguments:
  613. -h, --help show this help message and exit
  614. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  615. Name of the Azure storage account
  616. -p PASSPHRASE, --passphrase PASSPHRASE
  617. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  618. -v VERBOSITY, --verbosity VERBOSITY
  619. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  620. -b BATCH_FILE, --batch_file BATCH_FILE
  621. Tab-separated file with the following fields:
  622. container name, target container, file name, destination path (optional), storage tier (optional)
  623. </code></pre>
  624. <h4 id="azureautomate-move-folder">AzureAutomate move folder</h4>
  625. <p>Automate the moving of multiple folders in your Azure storage account</p>
  626. <h4 id="required-arguments_7">Required arguments:</h4>
  627. <ul>
  628. <li>container name</li>
  629. <li>account name</li>
  630. <li>name and path of batch file</li>
  631. </ul>
  632. <h4 id="optional-arguments_7">Optional arguments:</h4>
  633. <ul>
  634. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  635. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  636. </ul>
  637. <h4 id="batch-file-format_7">Batch file format</h4>
  638. <p>Tab-separated file with the following fields:</p>
  639. <p><code>container name, target container, folder name, destination path (optional), storage tier (optional)</code></p>
  640. <p>For additional details on moving folders, please see the <a href="../move/#azuremove-folder"><code>AzureMove folder</code></a> section</p>
  641. <h4 id="usage_7">Usage</h4>
  642. <pre><code>usage: AzureAutomate move folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  643. Move folders in Azure storage
  644. optional arguments:
  645. -h, --help show this help message and exit
  646. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  647. Name of the Azure storage account
  648. -p PASSPHRASE, --passphrase PASSPHRASE
  649. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  650. -v VERBOSITY, --verbosity VERBOSITY
  651. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  652. -b BATCH_FILE, --batch_file BATCH_FILE
  653. Tab-separated file with the following fields:
  654. container name, target container, folder name, destination path (optional), storage tier (optional)
  655. </code></pre>
  656. <h3 id="azureautomate-download">AzureAutomate download</h3>
  657. <p>Choose either the <a href="#azureautomate-download-container"><code>container</code></a>, <a href="#azureautomate-download-file"><code>file</code></a>, or <a href="#azureautomate-download-folder"><code>folder</code></a> functionality</p>
  658. <h4 id="general-usage_4">General usage</h4>
  659. <pre><code>usage: AzureAutomate download [-h] {container,file,folder} ...
  660. Download containers/files/folders in Azure storage
  661. optional arguments:
  662. -h, --help show this help message and exit
  663. Download functionality:
  664. {container,file,folder}
  665. container Download containers from Azure storage
  666. file Download files from Azure storage
  667. folder Download folders from Azure storage
  668. </code></pre>
  669. <h3 id="azureautomate-download-container">AzureAutomate download container</h3>
  670. <p>Automate the downloading of multiple containers from your Azure storage account</p>
  671. <h4 id="required-arguments_8">Required arguments:</h4>
  672. <ul>
  673. <li>container name</li>
  674. <li>account name</li>
  675. <li>name and path of batch file</li>
  676. </ul>
  677. <h4 id="optional-arguments_8">Optional arguments:</h4>
  678. <ul>
  679. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  680. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  681. </ul>
  682. <h4 id="batch-file-format_8">Batch file format</h4>
  683. <p>Tab-separated file with the following fields:</p>
  684. <p><code>container name, output path (optional)</code></p>
  685. <p>For additional details on downloading containers, please see the <a href="../download/#azuredownload-container"><code>AzureDownload container</code></a> section</p>
  686. <h4 id="usage_8">Usage</h4>
  687. <pre><code>usage: AzureAutomate download container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  688. Download containers from Azure storage
  689. optional arguments:
  690. -h, --help show this help message and exit
  691. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  692. Name of the Azure storage account
  693. -p PASSPHRASE, --passphrase PASSPHRASE
  694. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  695. -v VERBOSITY, --verbosity VERBOSITY
  696. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  697. -b BATCH_FILE, --batch_file BATCH_FILE
  698. Tab-separated file with the following fields:
  699. container name, output path (optional)
  700. </code></pre>
  701. <h3 id="azureautomate-download-file">AzureAutomate download file</h3>
  702. <p>Automate the downloading of multiple files from your Azure storage account</p>
  703. <h4 id="required-arguments_9">Required arguments:</h4>
  704. <ul>
  705. <li>container name</li>
  706. <li>account name</li>
  707. <li>name and path of batch file</li>
  708. </ul>
  709. <h4 id="optional-arguments_9">Optional arguments:</h4>
  710. <ul>
  711. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  712. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  713. </ul>
  714. <h4 id="batch-file-format_9">Batch file format</h4>
  715. <p>Tab-separated file with the following fields:</p>
  716. <p><code>container name, file name, output path (optional)</code></p>
  717. <p>For additional details on downloading files, please see the <a href="../download/#azuredownload-file"><code>AzureDownload file</code></a> section</p>
  718. <h4 id="usage_9">Usage</h4>
  719. <pre><code>usage: AzureAutomate download file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  720. Download files from Azure storage
  721. optional arguments:
  722. -h, --help show this help message and exit
  723. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  724. Name of the Azure storage account
  725. -p PASSPHRASE, --passphrase PASSPHRASE
  726. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  727. -v VERBOSITY, --verbosity VERBOSITY
  728. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  729. -b BATCH_FILE, --batch_file BATCH_FILE
  730. Tab-separated file with the following fields:
  731. container name, file name, output path (optional)
  732. </code></pre>
  733. <h3 id="azureautomate-download-folder">AzureAutomate download folder</h3>
  734. <p>Automate the downloading of multiple folders from your Azure storage account</p>
  735. <h4 id="required-arguments_10">Required arguments:</h4>
  736. <ul>
  737. <li>container name</li>
  738. <li>account name</li>
  739. <li>name and path of batch file</li>
  740. </ul>
  741. <h4 id="optional-arguments_10">Optional arguments:</h4>
  742. <ul>
  743. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  744. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  745. </ul>
  746. <h4 id="batch-file-format_10">Batch file format</h4>
  747. <p>Tab-separated file with the following fields:</p>
  748. <p><code>container name, folder name, output path (optional)</code></p>
  749. <p>For additional details on downloading folders, please see the <a href="../download/#azuredownload-folder"><code>AzureDownload folder</code></a> section</p>
  750. <h4 id="usage_10">Usage</h4>
  751. <pre><code>usage: AzureAutomate download folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  752. Download folders from Azure storage
  753. optional arguments:
  754. -h, --help show this help message and exit
  755. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  756. Name of the Azure storage account
  757. -p PASSPHRASE, --passphrase PASSPHRASE
  758. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  759. -v VERBOSITY, --verbosity VERBOSITY
  760. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  761. -b BATCH_FILE, --batch_file BATCH_FILE
  762. Tab-separated file with the following fields:
  763. container name, folder name, output path (optional)
  764. </code></pre>
  765. <h3 id="azureautomate-tier">AzureAutomate tier</h3>
  766. <p>Choose either the <a href="#azureautomate-tier-container"><code>container</code></a>, <a href="#azureautomate-tier-file"><code>file</code></a>, or <a href="#azureautomate-tier-folder"><code>folder</code></a> functionality</p>
  767. <h4 id="general-usage_5">General usage</h4>
  768. <pre><code>usage: AzureAutomate tier [-h] {container,file,folder} ...
  769. Set the storage tier of containers/files/folders in Azure storage
  770. optional arguments:
  771. -h, --help show this help message and exit
  772. Storage tier setting functionality:
  773. {container,file,folder}
  774. container Set the storage tier of containers in Azure storage
  775. file Set the storage tier of files in Azure storage
  776. folder Set the storage tier of folders in Azure storage
  777. </code></pre>
  778. <h3 id="azureautomate-tier-container">AzureAutomate tier container</h3>
  779. <p>Automate setting the storage tier for multiple containers in your Azure storage account</p>
  780. <h4 id="required-arguments_11">Required arguments:</h4>
  781. <ul>
  782. <li>container name</li>
  783. <li>account name</li>
  784. <li>name and path of batch file</li>
  785. </ul>
  786. <h4 id="optional-arguments_11">Optional arguments:</h4>
  787. <ul>
  788. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  789. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  790. </ul>
  791. <h4 id="batch-file-format_11">Batch file format</h4>
  792. <p>Tab-separated file with the following fields:</p>
  793. <p><code>container name, storage tier</code></p>
  794. <p>For additional details on setting the storage tier of containers, please see the <a href="../set_tier/#azuretier-container"><code>AzureTier container</code></a> section</p>
  795. <h4 id="usage_11">Usage</h4>
  796. <pre><code>usage: AzureAutomate tier container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  797. Set the storage tier of containers in Azure storage
  798. optional arguments:
  799. -h, --help show this help message and exit
  800. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  801. Name of the Azure storage account
  802. -p PASSPHRASE, --passphrase PASSPHRASE
  803. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  804. -v VERBOSITY, --verbosity VERBOSITY
  805. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  806. -b BATCH_FILE, --batch_file BATCH_FILE
  807. Tab-separated file with the following fields:
  808. container name, storage tier
  809. </code></pre>
  810. <h3 id="azureautomate-tier-file">AzureAutomate tier file</h3>
  811. <p>Automate setting the storage tier for multiple files in your Azure storage account</p>
  812. <h4 id="required-arguments_12">Required arguments:</h4>
  813. <ul>
  814. <li>container name</li>
  815. <li>account name</li>
  816. <li>name and path of batch file</li>
  817. </ul>
  818. <h4 id="optional-arguments_12">Optional arguments:</h4>
  819. <ul>
  820. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  821. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  822. </ul>
  823. <h4 id="batch-file-format_12">Batch file format</h4>
  824. <p>Tab-separated file with the following fields:</p>
  825. <p><code>container name, file name, storage tier</code></p>
  826. <p>For additional details on setting the storage tier of files, please see the <a href="../set_tier/#azuretier-file"><code>AzureTier file</code></a> section</p>
  827. <h4 id="usage_12">Usage</h4>
  828. <pre><code>usage: AzureAutomate tier file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  829. Set the storage tier of files in Azure storage
  830. optional arguments:
  831. -h, --help show this help message and exit
  832. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  833. Name of the Azure storage account
  834. -p PASSPHRASE, --passphrase PASSPHRASE
  835. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  836. -v VERBOSITY, --verbosity VERBOSITY
  837. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  838. -b BATCH_FILE, --batch_file BATCH_FILE
  839. Tab-separated file with the following fields:
  840. container name, file name, storage tier
  841. </code></pre>
  842. <h3 id="azureautomate-tier-folder">AzureAutomate tier folder</h3>
  843. <p>Automate setting the storage tier for multiple folders in your Azure storage account</p>
  844. <h4 id="required-arguments_13">Required arguments:</h4>
  845. <ul>
  846. <li>container name</li>
  847. <li>account name</li>
  848. <li>name and path of batch file</li>
  849. </ul>
  850. <h4 id="optional-arguments_13">Optional arguments:</h4>
  851. <ul>
  852. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  853. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  854. </ul>
  855. <h4 id="batch-file-format_13">Batch file format</h4>
  856. <p>Tab-separated file with the following fields:</p>
  857. <p><code>container name, folder name, storage tier</code></p>
  858. <p>For additional details on setting the storage tier of folders, please see the <a href="../set_tier/#azuretier-folder"><code>AzureTier folder</code></a> section</p>
  859. <h4 id="usage_13">Usage</h4>
  860. <pre><code>usage: AzureAutomate tier folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  861. Set the storage tier of folders in Azure storage
  862. optional arguments:
  863. -h, --help show this help message and exit
  864. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  865. Name of the Azure storage account
  866. -p PASSPHRASE, --passphrase PASSPHRASE
  867. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  868. -v VERBOSITY, --verbosity VERBOSITY
  869. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  870. -b BATCH_FILE, --batch_file BATCH_FILE
  871. Tab-separated file with the following fields:
  872. container name, folder name, storage tier
  873. </code></pre>
  874. <h3 id="azureautomate-delete">AzureAutomate delete</h3>
  875. <p>Choose either the <a href="#azureautomate-delete-container"><code>container</code></a>, <a href="#azureautomate-delete-file"><code>file</code></a>, or <a href="#azureautomate-delete-folder"><code>folder</code></a> functionality</p>
  876. <h4 id="general-usage_6">General usage</h4>
  877. <pre><code>usage: AzureAutomate delete [-h] {container,file,folder} ...
  878. Delete containers/files/folders in Azure storage
  879. optional arguments:
  880. -h, --help show this help message and exit
  881. Delete functionality:
  882. {container,file,folder}
  883. container Delete containers in Azure storage
  884. file Delete files in Azure storage
  885. folder Delete folders in Azure storage
  886. </code></pre>
  887. <h3 id="azureautomate-delete-container">AzureAutomate delete container</h3>
  888. <p>Automate deleting multiple containers in your Azure storage account</p>
  889. <h4 id="required-arguments_14">Required arguments:</h4>
  890. <ul>
  891. <li>container name</li>
  892. <li>account name</li>
  893. <li>name and path of batch file</li>
  894. </ul>
  895. <h4 id="optional-arguments_14">Optional arguments:</h4>
  896. <ul>
  897. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  898. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  899. </ul>
  900. <h4 id="batch-file-format_14">Batch file format</h4>
  901. <p>File with the following field:</p>
  902. <p><code>container name</code></p>
  903. <p>For additional details on deleting containers, please see the <a href="../delete/#azuredelete-container"><code>AzureDelete container</code></a> section</p>
  904. <h4 id="usage_14">Usage</h4>
  905. <pre><code>usage: AzureAutomate delete container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  906. Delete containers in Azure storage
  907. optional arguments:
  908. -h, --help show this help message and exit
  909. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  910. Name of the Azure storage account
  911. -p PASSPHRASE, --passphrase PASSPHRASE
  912. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  913. -v VERBOSITY, --verbosity VERBOSITY
  914. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  915. -b BATCH_FILE, --batch_file BATCH_FILE
  916. File with the following field:
  917. container name
  918. </code></pre>
  919. <h3 id="azureautomate-delete-file">AzureAutomate delete file</h3>
  920. <p>Automate deleting multiple files in your Azure storage account</p>
  921. <h4 id="required-arguments_15">Required arguments:</h4>
  922. <ul>
  923. <li>container name</li>
  924. <li>account name</li>
  925. <li>name and path of batch file</li>
  926. </ul>
  927. <h4 id="optional-arguments_15">Optional arguments:</h4>
  928. <ul>
  929. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  930. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  931. </ul>
  932. <h4 id="batch-file-format_15">Batch file format</h4>
  933. <p>Tab-separated file with the following fields:</p>
  934. <p><code>container name, file name, retention time (optional)</code></p>
  935. <p>For additional details on deleting files, please see the <a href="../delete/#azuredelete-file"><code>AzureDelete file</code></a> section</p>
  936. <h4 id="usage_15">Usage</h4>
  937. <pre><code>usage: AzureAutomate delete file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  938. Delete files in Azure storage
  939. optional arguments:
  940. -h, --help show this help message and exit
  941. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  942. Name of the Azure storage account
  943. -p PASSPHRASE, --passphrase PASSPHRASE
  944. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  945. -v VERBOSITY, --verbosity VERBOSITY
  946. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  947. -b BATCH_FILE, --batch_file BATCH_FILE
  948. Tab-separated file with the following fields:
  949. container name, file name, retention time (optional)
  950. </code></pre>
  951. <h3 id="azureautomate-delete-folder">AzureAutomate delete folder</h3>
  952. <p>Automate deleting multiple folders in your Azure storage account</p>
  953. <h4 id="required-arguments_16">Required arguments:</h4>
  954. <ul>
  955. <li>container name</li>
  956. <li>account name</li>
  957. <li>name and path of batch file</li>
  958. </ul>
  959. <h4 id="optional-arguments_16">Optional arguments:</h4>
  960. <ul>
  961. <li>passphrase used to store your connection string in the system keyring (default is AzureStorage)</li>
  962. <li>verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info</li>
  963. </ul>
  964. <h4 id="batch-file-format_16">Batch file format</h4>
  965. <p>Tab-separated file with the following fields:</p>
  966. <p><code>container name, folder name, retention time (optional)</code></p>
  967. <p>For additional details on deleting folders, please see the <a href="../delete/#azuredelete-folder"><code>AzureDelete folder</code></a> section</p>
  968. <h4 id="usage_16">Usage</h4>
  969. <pre><code>usage: AzureAutomate delete folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  970. Delete folders in Azure storage
  971. optional arguments:
  972. -h, --help show this help message and exit
  973. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  974. Name of the Azure storage account
  975. -p PASSPHRASE, --passphrase PASSPHRASE
  976. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  977. -v VERBOSITY, --verbosity VERBOSITY
  978. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  979. -b BATCH_FILE, --batch_file BATCH_FILE
  980. Tab-separated file with the following fields:
  981. container name, folder name, retention time (optional)
  982. </code></pre>
  983. <h3 id="azureautomate-batch">AzureAutomate batch</h3>
  984. <p>Automate multiple operations</p>
  985. <h3 id="batch-file-format_17">Batch file format</h3>
  986. <p>Tab-separated file in the following format:</p>
  987. <p><code>command, sub-command, command:subcommand-specific arguments</code></p>
  988. <p>Please review the <a href="#azureautomate"><code>AzureAutomate</code></a> documentation for all the possible operations</p>
  989. <h3 id="usage_17">Usage</h3>
  990. <pre><code>usage: AzureAutomate batch [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
  991. Perform multiple different operations in batch
  992. optional arguments:
  993. -h, --help show this help message and exit
  994. -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
  995. Name of the Azure storage account
  996. -p PASSPHRASE, --passphrase PASSPHRASE
  997. The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is &quot;AzureStorage&quot;.
  998. -v VERBOSITY, --verbosity VERBOSITY
  999. Set the logging level. Options are debug, info, warning, error, and critical. Default is info.
  1000. -b BATCH_FILE, --batch_file BATCH_FILE
  1001. Tab-separated file in the following format:
  1002. command, sub-command, arguments
  1003. Below is the complete list of functionalities:
  1004. upload, file, container name, file name, destination path (optional), storage tier (optional)
  1005. upload, folder, container name, folder name, destination path (optional), storage tier (optional)
  1006. sas, container, container name, expiry (optional), output file (optional)
  1007. sas, file, container name, file name and path, expiry (optional), output file (optional)
  1008. sas, folder, container name, folder name and path, expiry (optional), output file (optional)
  1009. move, container, container name, target container, destination path (optional), storage tier (optional)
  1010. move, file, container name, target container, file name, destination path (optional), storage tier (optional)
  1011. move, folder, container name, target container, folder name, destination path (optional), storage tier (optional)
  1012. download, container, container name, output path (optional)
  1013. download, file, container name, file name, output path (optional)
  1014. download, folder, container name, folder name, output path (optional)
  1015. tier, container, container name, storage tier
  1016. tier, file, container name, file name, storage tier
  1017. tier, folder, container name, folder name, storage tier
  1018. delete, container, container name
  1019. delete, file, container name, file name, retention time (optional)
  1020. delete, folder, container name, folder name, retention time (optional)
  1021. </code></pre>
  1022. </div>
  1023. </div>
  1024. <footer>
  1025. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  1026. <a href="../list/" class="btn btn-neutral float-right" title="List">Next <span class="icon icon-circle-arrow-right"></span></a>
  1027. <a href="../delete/" class="btn btn-neutral" title="Delete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  1028. </div>
  1029. <hr/>
  1030. <div role="contentinfo">
  1031. <!-- Copyright etc -->
  1032. </div>
  1033. 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>.
  1034. </footer>
  1035. </div>
  1036. </div>
  1037. </section>
  1038. </div>
  1039. <div class="rst-versions" role="note" aria-label="versions">
  1040. <span class="rst-current-version" data-toggle="rst-current-version">
  1041. <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
  1042. <span><a href="../delete/" style="color: #fcfcfc;">&laquo; Previous</a></span>
  1043. <span style="margin-left: 15px"><a href="../list/" style="color: #fcfcfc">Next &raquo;</a></span>
  1044. </span>
  1045. </div>
  1046. <script>var base_url = '..';</script>
  1047. <script src="../js/theme.js" defer></script>
  1048. <script src="../search/main.js" defer></script>
  1049. <script defer>
  1050. window.onload = function () {
  1051. SphinxRtdTheme.Navigation.enable(true);
  1052. };
  1053. </script>
  1054. </body>
  1055. </html>