123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185 |
- <!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/automate/">
- <link rel="shortcut icon" href="../img/favicon.ico">
- <title>Automate - 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 = "Automate";
- var mkdocs_page_input_path = "automate.md";
- var mkdocs_page_url = "/AzureStorage/automate/";
- </script>
-
- <script src="../js/jquery-2.1.1.min.js" defer></script>
- <script src="../js/modernizr-2.8.3.min.js" defer></script>
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
- <script>hljs.initHighlightingOnLoad();</script>
-
- </head>
- <body class="wy-body-for-nav" role="document">
- <div class="wy-grid-for-nav">
-
- <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
- <div class="wy-side-scroll">
- <div class="wy-side-nav-search">
- <a href=".." class="icon icon-home"> OLC Bioinformatics Azure Storage</a>
- <div role="search">
- <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
- <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
- </form>
- </div>
- </div>
- <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="..">Home</a>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../install/">Installation</a>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../credentials/">Credentials</a>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../upload/">Upload</a>
- </li>
- </ul>
- <ul>
- <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 class="current">
- <li class="toctree-l1 current"><a class="reference internal current" href="./">Automate</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="#azureautomate-upload">AzureAutomate upload</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#general-usage_1">General usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-upload-file">AzureAutomate upload file</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="#batch-file-format">Batch file format</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="#azureautomate-upload-folder">AzureAutomate upload folder</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="#batch-file-format_1">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_1">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-sas">AzureAutomate sas</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#general-usage_2">General usage</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#azureautomate-sas-container">AzureAutomate sas container</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_2">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_2">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_2">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_2">Usage</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#azureautomate-sas-file">AzureAutomate sas file</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_3">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_3">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_3">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_3">Usage</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#azureautomate-sas-folder">AzureAutomate sas folder</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_4">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_4">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_4">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_4">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-move">AzureAutomate move</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#general-usage_3">General usage</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#azureautomate-move-container">AzureAutomate move container</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_5">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_5">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_5">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_5">Usage</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#azureautomate-move-file">AzureAutomate move file</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_6">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_6">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_6">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_6">Usage</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#azureautomate-move-folder">AzureAutomate move folder</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_7">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_7">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_7">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_7">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download">AzureAutomate download</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#general-usage_4">General usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download-container">AzureAutomate download container</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_8">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_8">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_8">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_8">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download-file">AzureAutomate download file</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_9">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_9">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_9">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_9">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-download-folder">AzureAutomate download folder</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_10">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_10">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_10">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_10">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier">AzureAutomate tier</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#general-usage_5">General usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier-container">AzureAutomate tier container</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_11">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_11">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_11">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_11">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier-file">AzureAutomate tier file</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_12">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_12">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_12">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_12">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-tier-folder">AzureAutomate tier folder</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_13">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_13">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_13">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_13">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete">AzureAutomate delete</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#general-usage_6">General usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete-container">AzureAutomate delete container</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_14">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_14">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_14">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_14">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete-file">AzureAutomate delete file</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_15">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_15">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_15">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_15">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-delete-folder">AzureAutomate delete folder</a>
- <ul>
- <li class="toctree-l3"><a class="reference internal" href="#required-arguments_16">Required arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#optional-arguments_16">Optional arguments:</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#batch-file-format_16">Batch file format</a>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="#usage_16">Usage</a>
- </li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#azureautomate-batch">AzureAutomate batch</a>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#batch-file-format_17">Batch file format</a>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="#usage_17">Usage</a>
- </li>
- </ul>
- </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>Automate</li>
- <li class="wy-breadcrumbs-aside">
-
- <a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/automate.md"
- class="icon icon-github"> Edit on GitHub</a>
-
- </li>
- </ul>
-
- <hr/>
- </div>
- <div role="main">
- <div class="section">
-
- <h2 id="azureautomate">AzureAutomate</h2>
- <p>Perform multiple upload, SAS URL creation, move, download, storage tier setting, or delete actions. Alternatively, perform multiple actions in a single call</p>
- <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>
- <h4 id="general-usage">General usage</h4>
- <pre><code>usage: AzureAutomate [-h] {upload,sas,move,download,tier,delete,batch} ...
- Automate the submission of multiple AzureStorage commands
- optional arguments:
- -h, --help show this help message and exit
- Available functionality:
- {upload,sas,move,download,tier,delete,batch}
- upload Upload files/folders to Azure storage
- sas Create SAS URLs for containers/files/folders in Azure storage
- move Move containers/files/folders in Azure storage
- download Download containers/files/folders in Azure storage
- tier Set the storage tier of containers/files/folders in Azure storage
- delete Delete containers/files/folders in Azure storage
- batch Perform multiple different operations in batch
- </code></pre>
- <h3 id="azureautomate-upload">AzureAutomate upload</h3>
- <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>
- <h4 id="general-usage_1">General usage</h4>
- <pre><code>usage: AzureAutomate upload [-h] {file,folder} ...
- Upload files/folders to Azure storage
- optional arguments:
- -h, --help show this help message and exit
- Upload functionality:
- {file,folder}
- file Upload files to Azure storage
- folder Upload folders to Azure storage
- </code></pre>
- <h3 id="azureautomate-upload-file">AzureAutomate upload file</h3>
- <p>Automate the upload of multiple files to your Azure storage account</p>
- <h4 id="required-arguments">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</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="batch-file-format">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, file name, destination path (optional), storage tier (optional)</code></p>
- <p>For additional details on running file uploads, please see the <a href="../upload/#azureupload-file"><code>AzureUpload file</code></a> section</p>
- <h4 id="usage">Usage</h4>
- <pre><code>usage: AzureAutomate upload file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Upload files to Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, file name, destination path (optional), storage tier (optional)
- </code></pre>
- <h3 id="azureautomate-upload-folder">AzureAutomate upload folder</h3>
- <p>Automate the upload of multiple folders to your Azure storage account</p>
- <h4 id="required-arguments_1">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</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="batch-file-format_1">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, folder name, destination path (optional), storage tier (optional)</code></p>
- <p>For additional details on running folder uploads, please see the <a href="../upload/#azureupload-folder"><code>AzureUpload folder</code></a> section</p>
- <h4 id="usage_1">Usage</h4>
- <pre><code>usage: AzureAutomate upload folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Upload folders to Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields (one entry per line):
- container name, folder name, destination path (optional), storage tier (optional)
- </code></pre>
- <h3 id="azureautomate-sas">AzureAutomate sas</h3>
- <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>
- <h4 id="general-usage_2">General usage</h4>
- <pre><code>usage: AzureAutomate sas [-h] {container,file,folder} ...
- Create SAS URLs for containers/files/folders in Azure storage
- optional arguments:
- -h, --help show this help message and exit
- SAS URL creation functionality:
- {container,file,folder}
- container Create SAS URLs for containers in Azure storage
- file Create SAS URLs for files in Azure storage
- folder Create SAS URLs for folders in Azure storage
- </code></pre>
- <h4 id="azureautomate-sas-container">AzureAutomate sas container</h4>
- <p>Automate the creation of SAS URLs for multiple containers in your Azure storage account</p>
- <h4 id="required-arguments_2">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_2">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="batch-file-format_2">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, expiry (optional), output file (optional)</code></p>
- <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>
- <h4 id="usage_2">Usage</h4>
- <pre><code>usage: AzureAutomate sas container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Create SAS URLs for containers in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, expiry (optional), output file (optional)
- </code></pre>
- <h4 id="azureautomate-sas-file">AzureAutomate sas file</h4>
- <p>Automate the creation of SAS URLs for multiple files in your Azure storage account</p>
- <h4 id="required-arguments_3">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_3">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="batch-file-format_3">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, file name and path, expiry (optional), output file (optional)</code></p>
- <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>
- <h4 id="usage_3">Usage</h4>
- <pre><code>usage: AzureAutomate sas file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Create SAS URLs for files in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, file name and path, expiry (optional), output file (optional)
- </code></pre>
- <h4 id="azureautomate-sas-folder">AzureAutomate sas folder</h4>
- <p>Automate the creation of SAS URLs for multiple folders in your Azure storage account</p>
- <h4 id="required-arguments_4">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_4">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="batch-file-format_4">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, folder name and path, expiry (optional), output file (optional)</code></p>
- <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>
- <h4 id="usage_4">Usage</h4>
- <pre><code>usage: AzureAutomate sas folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Create SAS URLs for folders in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, folder name and path, expiry (optional), output file (optional)
- </code></pre>
- <h3 id="azureautomate-move">AzureAutomate move</h3>
- <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>
- <h4 id="general-usage_3">General usage</h4>
- <pre><code>usage: AzureAutomate move [-h] {container,file,folder} ...
- Move containers/files/folders in Azure storage
- optional arguments:
- -h, --help show this help message and exit
- Move functionality:
- {container,file,folder}
- container Move containers in Azure storage
- file Move files in Azure storage
- folder Move folders in Azure storage
- </code></pre>
- <h4 id="azureautomate-move-container">AzureAutomate move container</h4>
- <p>Automate the moving of multiple containers in your Azure storage account</p>
- <h4 id="required-arguments_5">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_5">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="batch-file-format_5">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, target container, destination path (optional), storage tier (optional)</code></p>
- <p>For additional details on moving containers, please see the <a href="../move/#azuremove-container"><code>AzureMove container</code></a> section</p>
- <h4 id="usage_5">Usage</h4>
- <pre><code>usage: AzureAutomate move container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Move containers in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, target container, destination path (optional), storage tier (optional)
- </code></pre>
- <h4 id="azureautomate-move-file">AzureAutomate move file</h4>
- <p>Automate the moving of multiple files in your Azure storage account</p>
- <h4 id="required-arguments_6">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_6">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="batch-file-format_6">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, target container, file name, destination path (optional), storage tier (optional)</code></p>
- <p>For additional details on moving files, please see the <a href="../move/#azuremove-file"><code>AzureMove file</code></a> section</p>
- <h4 id="usage_6">Usage</h4>
- <pre><code>usage: AzureAutomate move file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Move files in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, target container, file name, destination path (optional), storage tier (optional)
- </code></pre>
- <h4 id="azureautomate-move-folder">AzureAutomate move folder</h4>
- <p>Automate the moving of multiple folders in your Azure storage account</p>
- <h4 id="required-arguments_7">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_7">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="batch-file-format_7">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, target container, folder name, destination path (optional), storage tier (optional)</code></p>
- <p>For additional details on moving folders, please see the <a href="../move/#azuremove-folder"><code>AzureMove folder</code></a> section</p>
- <h4 id="usage_7">Usage</h4>
- <pre><code>usage: AzureAutomate move folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Move folders in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, target container, folder name, destination path (optional), storage tier (optional)
- </code></pre>
- <h3 id="azureautomate-download">AzureAutomate download</h3>
- <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>
- <h4 id="general-usage_4">General usage</h4>
- <pre><code>usage: AzureAutomate download [-h] {container,file,folder} ...
- Download containers/files/folders in Azure storage
- optional arguments:
- -h, --help show this help message and exit
- Download functionality:
- {container,file,folder}
- container Download containers from Azure storage
- file Download files from Azure storage
- folder Download folders from Azure storage
- </code></pre>
- <h3 id="azureautomate-download-container">AzureAutomate download container</h3>
- <p>Automate the downloading of multiple containers from your Azure storage account</p>
- <h4 id="required-arguments_8">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_8">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="batch-file-format_8">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, output path (optional)</code></p>
- <p>For additional details on downloading containers, please see the <a href="../download/#azuredownload-container"><code>AzureDownload container</code></a> section</p>
- <h4 id="usage_8">Usage</h4>
- <pre><code>usage: AzureAutomate download container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Download containers from Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, output path (optional)
- </code></pre>
- <h3 id="azureautomate-download-file">AzureAutomate download file</h3>
- <p>Automate the downloading of multiple files from your Azure storage account</p>
- <h4 id="required-arguments_9">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_9">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="batch-file-format_9">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, file name, output path (optional)</code></p>
- <p>For additional details on downloading files, please see the <a href="../download/#azuredownload-file"><code>AzureDownload file</code></a> section</p>
- <h4 id="usage_9">Usage</h4>
- <pre><code>usage: AzureAutomate download file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Download files from Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, file name, output path (optional)
- </code></pre>
- <h3 id="azureautomate-download-folder">AzureAutomate download folder</h3>
- <p>Automate the downloading of multiple folders from your Azure storage account</p>
- <h4 id="required-arguments_10">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_10">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="batch-file-format_10">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, folder name, output path (optional)</code></p>
- <p>For additional details on downloading folders, please see the <a href="../download/#azuredownload-folder"><code>AzureDownload folder</code></a> section</p>
- <h4 id="usage_10">Usage</h4>
- <pre><code>usage: AzureAutomate download folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Download folders from Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, folder name, output path (optional)
- </code></pre>
- <h3 id="azureautomate-tier">AzureAutomate tier</h3>
- <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>
- <h4 id="general-usage_5">General usage</h4>
- <pre><code>usage: AzureAutomate tier [-h] {container,file,folder} ...
- Set the storage tier of containers/files/folders in Azure storage
- optional arguments:
- -h, --help show this help message and exit
- Storage tier setting functionality:
- {container,file,folder}
- container Set the storage tier of containers in Azure storage
- file Set the storage tier of files in Azure storage
- folder Set the storage tier of folders in Azure storage
- </code></pre>
- <h3 id="azureautomate-tier-container">AzureAutomate tier container</h3>
- <p>Automate setting the storage tier for multiple containers in your Azure storage account</p>
- <h4 id="required-arguments_11">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_11">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="batch-file-format_11">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, storage tier</code></p>
- <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>
- <h4 id="usage_11">Usage</h4>
- <pre><code>usage: AzureAutomate tier container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Set the storage tier of containers in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, storage tier
- </code></pre>
- <h3 id="azureautomate-tier-file">AzureAutomate tier file</h3>
- <p>Automate setting the storage tier for multiple files in your Azure storage account</p>
- <h4 id="required-arguments_12">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_12">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="batch-file-format_12">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, file name, storage tier</code></p>
- <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>
- <h4 id="usage_12">Usage</h4>
- <pre><code>usage: AzureAutomate tier file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Set the storage tier of files in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, file name, storage tier
- </code></pre>
- <h3 id="azureautomate-tier-folder">AzureAutomate tier folder</h3>
- <p>Automate setting the storage tier for multiple folders in your Azure storage account</p>
- <h4 id="required-arguments_13">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_13">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="batch-file-format_13">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, folder name, storage tier</code></p>
- <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>
- <h4 id="usage_13">Usage</h4>
- <pre><code>usage: AzureAutomate tier folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Set the storage tier of folders in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, folder name, storage tier
- </code></pre>
- <h3 id="azureautomate-delete">AzureAutomate delete</h3>
- <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>
- <h4 id="general-usage_6">General usage</h4>
- <pre><code>usage: AzureAutomate delete [-h] {container,file,folder} ...
- Delete containers/files/folders in Azure storage
- optional arguments:
- -h, --help show this help message and exit
- Delete functionality:
- {container,file,folder}
- container Delete containers in Azure storage
- file Delete files in Azure storage
- folder Delete folders in Azure storage
- </code></pre>
- <h3 id="azureautomate-delete-container">AzureAutomate delete container</h3>
- <p>Automate deleting multiple containers in your Azure storage account</p>
- <h4 id="required-arguments_14">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_14">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="batch-file-format_14">Batch file format</h4>
- <p>File with the following field:</p>
- <p><code>container name</code></p>
- <p>For additional details on deleting containers, please see the <a href="../delete/#azuredelete-container"><code>AzureDelete container</code></a> section</p>
- <h4 id="usage_14">Usage</h4>
- <pre><code>usage: AzureAutomate delete container [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Delete containers in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- File with the following field:
- container name
- </code></pre>
- <h3 id="azureautomate-delete-file">AzureAutomate delete file</h3>
- <p>Automate deleting multiple files in your Azure storage account</p>
- <h4 id="required-arguments_15">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_15">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="batch-file-format_15">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, file name, retention time (optional)</code></p>
- <p>For additional details on deleting files, please see the <a href="../delete/#azuredelete-file"><code>AzureDelete file</code></a> section</p>
- <h4 id="usage_15">Usage</h4>
- <pre><code>usage: AzureAutomate delete file [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Delete files in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, file name, retention time (optional)
- </code></pre>
- <h3 id="azureautomate-delete-folder">AzureAutomate delete folder</h3>
- <p>Automate deleting multiple folders in your Azure storage account</p>
- <h4 id="required-arguments_16">Required arguments:</h4>
- <ul>
- <li>container name</li>
- <li>account name</li>
- <li>name and path of batch file</li>
- </ul>
- <h4 id="optional-arguments_16">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="batch-file-format_16">Batch file format</h4>
- <p>Tab-separated file with the following fields:</p>
- <p><code>container name, folder name, retention time (optional)</code></p>
- <p>For additional details on deleting folders, please see the <a href="../delete/#azuredelete-folder"><code>AzureDelete folder</code></a> section</p>
- <h4 id="usage_16">Usage</h4>
- <pre><code>usage: AzureAutomate delete folder [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Delete folders in Azure storage
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file with the following fields:
- container name, folder name, retention time (optional)
- </code></pre>
- <h3 id="azureautomate-batch">AzureAutomate batch</h3>
- <p>Automate multiple operations</p>
- <h3 id="batch-file-format_17">Batch file format</h3>
- <p>Tab-separated file in the following format:</p>
- <p><code>command, sub-command, command:subcommand-specific arguments</code></p>
- <p>Please review the <a href="#azureautomate"><code>AzureAutomate</code></a> documentation for all the possible operations</p>
- <h3 id="usage_17">Usage</h3>
- <pre><code>usage: AzureAutomate batch [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY] -b BATCH_FILE
- Perform multiple different operations in batch
- 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.
- -b BATCH_FILE, --batch_file BATCH_FILE
- Tab-separated file in the following format:
- command, sub-command, arguments
- Below is the complete list of functionalities:
- upload, file, container name, file name, destination path (optional), storage tier (optional)
- upload, folder, container name, folder name, destination path (optional), storage tier (optional)
- sas, container, container name, expiry (optional), output file (optional)
- sas, file, container name, file name and path, expiry (optional), output file (optional)
- sas, folder, container name, folder name and path, expiry (optional), output file (optional)
- move, container, container name, target container, destination path (optional), storage tier (optional)
- move, file, container name, target container, file name, destination path (optional), storage tier (optional)
- move, folder, container name, target container, folder name, destination path (optional), storage tier (optional)
- download, container, container name, output path (optional)
- download, file, container name, file name, output path (optional)
- download, folder, container name, folder name, output path (optional)
- tier, container, container name, storage tier
- tier, file, container name, file name, storage tier
- tier, folder, container name, folder name, storage tier
- delete, container, container name
- delete, file, container name, file name, retention time (optional)
- delete, folder, container name, folder name, retention time (optional)
- </code></pre>
-
- </div>
- </div>
- <footer>
-
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="../list/" class="btn btn-neutral float-right" title="List">Next <span class="icon icon-circle-arrow-right"></span></a>
-
-
- <a href="../delete/" class="btn btn-neutral" title="Delete"><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="../delete/" style="color: #fcfcfc;">« Previous</a></span>
-
-
- <span style="margin-left: 15px"><a href="../list/" 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>
|