Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 5.5 KB

Commands.md

File metadata and controls

145 lines (101 loc) · 5.5 KB
Raw

Commands overview - azmi

Here is the overview of all azmi commands and their arguments. You can run azmi <command> --help in your terminal to display help for any of the commands.

Common arguments

These are the arguments shared amongst all commands listed below.

--help

Optional bool argument. Use this argument to get help about specific command right in your terminal.

--identity

Optional String argument. Client or application ID of managed identity used to authenticate. Example: 117dc05c-4d12-4ac2-b5f8-5e239dc8bc54

--verbose

Optional boolean argument. By default commands display short, Linux style error message. If this argument is specified, then command will produce more verbose error output. It would actually display full dotnet error stack.

Comments: Commands marked with 🚧 are only available via dev build, and their content might not correspond to this page.

General commands

azmi gettoken

Command gettoken obtains Azure authorization token for usage in other command line tools.

--endpoint Optional string argument. Endpoint against which to authenticate. Examples: management, storage. Default 'management'

--jwt-format Optional bool argument. Print token in JSON Web Token (JWT) format.

Storage commands

command description
azmi listblobs Lists all blobs in container and send their names or URIs to output.
azmi getblob Downloads single blob from storage account to a local file.
azmi getblobs Downloads multiple blobs from container to a local directory.
azmi setblob Writes single local file to a storage account as a "block" blob.
azmi setblobs Writes multiple local files to storage account as "block" blobs.

Arguments overview

command source destination other arguments
listblobs --container n.a. --prefix, --exclude
getblob --blob --file --if-newer, --delete-after-copy
getblobs --container --directory --prefix, --if-newer, --delete-after-copy, --exclude, --absolute-paths
setblob --file --blob --force
setblobs --directory --container --force,--exclude, --skip-if-same

All commands support arguments --identity and --verbose.

Source and destination arguments

Arguments source and destination are mandatory.

--container String. URL of container to which file(s) will be uploaded or downloaded from. Example https://myaccount.blob.core.windows.net/mycontainer

--blob String. URL of blob which will be downloaded/updated. Example https://myaccount.blob.core.windows.net/mycontainer/myblob.txt

--directory String. Path to a local directory to which blobs will be downloaded to or uploaded from. Examples: /home/myname/blobs/ or ./mydir

--file String. Path to local file to which content will be downloaded or from which it will be uploaded. Examples: /tmp/1.txt, ./1.xml.

Other optional arguments

--if-newer Bool. Download blob(s) only if a newer version exists in a container than on local file system.

--force Bool. Forces to overwrite existing blob(s) in Azure.

--prefix String. Filters results to return only blobs whose name begins with the specified prefix.

--exclude String. Specifies which blob to exclude from list or download operation.

--delete-after-copy Bool. Deletes blob after successful copy. Similar to "move" operations on file system.

--absolute-paths Bool. Listing of blobs is formatted to absolute URIs path. E.g. https://{blobStorage-name}.blob.core.windows.net/{container-name}/file841.blob

--skip-if-same Bool. Skip setting particular blob in batch if local file and already existing remote blob are same. Try to upload otherwise.

Known limitations

Commands listblobs and getblobs return up to 5,000 blobs filtered on Azure API side by argument --prefix. Filtering with --exclude though providing more flexibility with regex, is only client side filtering. This means it operates on server filtered set which can be already topped to first 5,000 blobs. If storage account has more than 5,000 blobs, it is required to use --prefix, otherwise results might be inconclusive.

Key Vault Secret commands

command description
azmi getsecret Downloads single secret from Azure Key Vault.

Arguments overview

command source destination other arguments
azmi getsecret --secret --file n.a.

Key Vault Certificate commands

command description
azmi getcertificate Downloads certificate(s) and private key bundle from Azure Key Vault.

Arguments overview

command source destination other arguments
azmi getcertificate --certificate --file n.a.

Description

Despite command's name getcertificate this command downloads certificate(s) and corresponding private key. Command name getcertificate is pointing to "Certificate" object-type in Key Vault like https://{keyvault-name}.vault.azure.net/{object-type}/{object-name}/{object-version} . In context of Azure Portal GUI: GetCertificate Portal

Command downloads PEM (Privacy Enhanced Mail) or PFX (Personal Information Exchange; PKCS#12 archive file format) formats, depending on what content type you set in Azure Key Vault.