From 06717d423d63083e44280022adf0252cf874a333 Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Tue, 23 Aug 2016 14:50:34 -0700 Subject: [PATCH 1/5] Initial version of help dump. Logic to extract summary. --- help_dump.txt | 4406 ++++++++++++++++++++++ src/azure/cli/commands/__init__.py | 3 +- src/azure/cli/commands/_introspection.py | 16 +- 3 files changed, 4422 insertions(+), 3 deletions(-) create mode 100644 help_dump.txt diff --git a/help_dump.txt b/help_dump.txt new file mode 100644 index 00000000000..1193ef70c01 --- /dev/null +++ b/help_dump.txt @@ -0,0 +1,4406 @@ + +Command + az storage account check-name + +Arguments + --name [Required] + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account connection-string + +Arguments + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + --protocol : The default endpoint protocol. Allowed values: http, https. + Default: https. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account create + +Arguments + --location -l [Required]: Location. + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + --sku [Required]: The storage account SKU. (Standard_LRS, Standard_GRS, + Standard_RAGRS, Standard_ZRS, Premium_LRS). + --access-tier : Required for StandardBlob accounts. The access tier used for + billing. Cannot be set for StandardLRS, StandardGRS, + StandardRAGRS, or PremiumLRS account types. (Hot, Cool). + --custom-domain : User domain assigned to the storage account. Name is the CNAME + source. Use empty string to clear. + --encryption : Specifies which service(s) to encrypt. Allowed values: blob. + --kind : Indicates the type of storage account. (Storage, BlobStorage). + Default: Storage. + --tags : Multiple semicolon separated tags in 'key[=value]' format. Use + "" to clear existing tags. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account delete + +Arguments + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account generate-sas + +Arguments + --expiry [Required]: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS + becomes invalid. + --permissions [Required]: The permissions the SAS grants. Allowed values: (a)dd (c)reate + (d)elete (l)ist (p)rocess (r)ead (u)pdate (w)rite. Can be combined. + --resource-types [Required]: The resource types the SAS is applicable for. Allowed values: + (s)ervice (c)ontainer (o)bject. Can be combined. + --services [Required]: The storage services the SAS is applicable for. Allowed values: + (b)lob (f)ile (q)ueue (t)able. Can be combined. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, + requests from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to + accept requests. Supports only IPv4 style addresses. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS + becomes valid. Defaults to the time of the request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --name -n : The storage account name. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage account keys list + +Arguments + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account keys renew + +Arguments + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + --key : The key(s) to renew. Allowed values: secondary, both, primary. + Default: both. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account list + +Arguments + --resource-group -g: Name of resource group. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account show + +Arguments + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account show-usage + +Arguments + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o: Output format. Allowed values: json, tsv, list, table, jsonc. Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage account update + +Arguments + --name -n [Required]: The storage account name. + --resource-group -g [Required]: Name of resource group. + --access-tier : Required for StandardBlob accounts. The access tier used for + billing. Cannot be set for StandardLRS, StandardGRS, + StandardRAGRS, or PremiumLRS account types. (Hot, Cool). + --custom-domain : User domain assigned to the storage account. Name is the CNAME + source. Use empty string to clear. + --encryption : Specifies which service(s) to encrypt. Allowed values: blob. + --sku : The storage account SKU. (Standard_LRS, Standard_GRS, + Standard_RAGRS, Standard_ZRS, Premium_LRS). + --tags : Multiple semicolon separated tags in 'key[=value]' format. Use + "" to clear existing tags. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +=============================== + +Command + az storage blob copy cancel + +Arguments + --copy-id [Required]: Copy identifier provided in the copy.id of the original + copy_blob operation. + --destination-blob -b [Required]: Name of the destination blob. If the exists, it will be + overwritten. + --destination-container -c [Required]: The container name. + --lease-id : Required if the destination blob has an active infinite + lease. + --timeout : Request timeout in seconds. Applies to each call to the + service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, + jsonc. Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug + logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with + storage account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with + either storage account key or a SAS token. Var: + AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in + conjunction with storage account name. Var: + AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob copy start + +Arguments + --destination-blob -b [Required]: Name of the destination blob. If the exists, it will be + overwritten. + --destination-container -c [Required]: The container name. + --source-uri -u [Required]: A URL of up to 2 KB in length that specifies an Azure + file or blob. The value should be URL-encoded as it would + appear in a request URI. If the source is in another + account, the source must either be public or must be + authenticated via a shared access signature. If the + source is public, no authentication is required. + Examples: https://myaccount.blob.core.windows.net/myconta + iner/myblob https://myaccount.blob.core.windows.net/mycon + tainer/myblob?snapshot= https://otheraccount.bl + ob.core.windows.net/mycontainer/myblob?sastoken. + --destination-if-match : An ETag value, or the wildcard character (*). Specify an + ETag value for this conditional header to copy the blob + only if the specified ETag value matches the ETag value + for an existing destination blob. If the ETag for the + destination blob does not match the ETag specified for + If-Match, the Blob service returns status code 412 + (Precondition Failed). + --destination-if-modified-since : A DateTime value. Azure expects the date value passed in + to be UTC. If timezone is included, any non-UTC datetimes + will be converted to UTC. If a date is passed in without + timezone info, it is assumed to be UTC. Specify this + conditional header to copy the blob only if the + destination blob has been modified since the specified + date/time. If the destination blob has not been modified, + the Blob service returns status code 412 (Precondition + Failed). + --destination-if-none-match : An ETag value, or the wildcard character (*). Specify an + ETag value for this conditional header to copy the blob + only if the specified ETag value does not match the ETag + value for the destination blob. Specify the wildcard + character (*) to perform the operation only if the + destination blob does not exist. If the specified + condition isn't met, the Blob service returns status code + 412 (Precondition Failed). + --destination-if-unmodified-since : A DateTime value. Azure expects the date value passed in + to be UTC. If timezone is included, any non-UTC datetimes + will be converted to UTC. If a date is passed in without + timezone info, it is assumed to be UTC. Specify this + conditional header to copy the blob only if the + destination blob has not been modified since the + specified date/time. If the destination blob has been + modified, the Blob service returns status code 412 + (Precondition Failed). + --destination-lease-id : The lease ID specified for this header must match the + lease ID of the destination blob. If the request does not + include the lease ID or it is not valid, the operation + fails with status code 412 (Precondition Failed). + --metadata : Metadata in space-separated key=value pairs. + --source-if-match : An ETag value, or the wildcard character (*). Specify + this conditional header to copy the source blob only if + its ETag matches the value specified. If the ETag values + do not match, the Blob service returns status code 412 + (Precondition Failed). This header cannot be specified if + the source is an Azure File. + --source-if-modified-since : A DateTime value. Azure expects the date value passed in + to be UTC. If timezone is included, any non-UTC datetimes + will be converted to UTC. If a date is passed in without + timezone info, it is assumed to be UTC. Specify this + conditional header to copy the blob only if the source + blob has been modified since the specified date/time. + --source-if-none-match : An ETag value, or the wildcard character (*). Specify + this conditional header to copy the blob only if its ETag + does not match the value specified. If the values are + identical, the Blob service returns status code 412 + (Precondition Failed). This header cannot be specified if + the source is an Azure File. + --source-if-unmodified-since : A DateTime value. Azure expects the date value passed in + to be UTC. If timezone is included, any non-UTC datetimes + will be converted to UTC. If a date is passed in without + timezone info, it is assumed to be UTC. Specify this + conditional header to copy the blob only if the source + blob has not been modified since the specified date/time. + --source-lease-id : Specify this to perform the Copy Blob operation only if + the lease ID given matches the active lease ID of the + source blob. + --timeout : Request timeout in seconds. Applies to each call to the + service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, + jsonc. Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug + logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with + storage account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with + either storage account key or a SAS token. Var: + AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in + conjunction with storage account name. Var: + AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob delete + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --delete-snapshots : Required if the blob has associated snapshots. Allowed values: + only, include. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --snapshot : The snapshot parameter is an opaque DateTime value that, when + present, specifies the blob snapshot to delete. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob download + +Arguments + --container-name -c [Required]: The container name. + --file -f [Required]: Path of file to write out to. + --name -n [Required]: The blob name. + --end-range : End of byte range to use for downloading a section of the blob. + If end_range is given, start_range must be provided. The + start_range and end_range params are inclusive. Ex: + start_range=0, end_range=511 will download first 512 bytes of + blob. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --max-connections : If set to 2 or greater, an initial get will be done for the + first self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the + entire blob, the method returns at this point. If it is not, it + will download the remaining data parallel using the number of + threads equal to max_connections. Each chunk will be of size + self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request + will be done. This is not generally recommended but available if + very few threads should be used, network requests are very + expensive, or a non-seekable stream prevents parallel download. + This may also be useful if many blobs are expected to be empty + as an extra request is required for empty blobs if + max_connections is greater than 1. Default: 2. + --max-retries : Number of times to retry download of blob chunk if an error + occurs. Default: 5. + --open-mode : Mode to use when opening the file. Note that specifying append + only open_mode prevents parallel download. So, max_connections + must be set to 1 if this open_mode is used. Default: wb. + --progress-callback : Callback for progress with signature function(current, total) + where current is the number of bytes transfered so far, and + total is the size of the blob if known. + --retry-wait : Sleep time in secs between retries. Default: 1.0. + --snapshot : The snapshot parameter is an opaque DateTime value that, when + present, specifies the blob snapshot to retrieve. + --start-range : Start of byte range to use for downloading a section of the + blob. If no end_range is given, all bytes after the start_range + will be downloaded. The start_range and end_range params are + inclusive. Ex: start_range=0, end_range=511 will download first + 512 bytes of blob. + --timeout : Request timeout in seconds. Applies to each call to the service. + --validate-content : If set to true, validates an MD5 hash for each retrieved portion + of the blob. This is primarily valuable for detecting bitflips + on the wire if using http instead of https as https (the + default) will already validate. Note that the service will only + return transactional MD5s for chunks 4MB or less so the first + get request will be of size self.MAX_CHUNK_GET_SIZE instead of + self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to + greater than 4MB an error will be thrown. As computing the MD5 + takes processing time and more requests will need to be done due + to the reduced chunk size there may be some increase in latency. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob exists + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --snapshot : The snapshot parameter is an opaque DateTime value that, when + present, specifies the snapshot. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob generate-sas + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --cache-control : Response header value for Cache-Control when resource is + accessed using this shared access signature. + --content-disposition : Response header value for Content-Disposition when resource is + accessed using this shared access signature. + --content-encoding : Response header value for Content-Encoding when resource is + accessed using this shared access signature. + --content-language : Response header value for Content-Language when resource is + accessed using this shared access signature. + --content-type : Response header value for Content-Type when resource is accessed + using this shared access signature. + --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS + becomes invalid. Do not use if a stored access policy is + referenced with --id that specifies this value. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, + requests from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to + accept requests. Supports only IPv4 style addresses. + --permissions : The permissions the SAS grants. Allowed values: (a)dd (c)reate + (d)elete (r)ead (w)rite. Do not use if a stored access policy is + referenced with --id that specifies this value. Can be combined. + --policy-name : The name of a stored access policy within the container's ACL. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS + becomes valid. Do not use if a stored access policy is + referenced with --id that specifies this value. Defaults to the + time of the request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob lease acquire + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-duration : Specifies the duration of the lease, in seconds, or negative one + (-1) for a lease that never expires. A non-infinite lease can be + between 15 and 60 seconds. A lease duration cannot be changed + using renew or change. Default is -1 (infinite lease). Default: + -1. + --proposed-lease-id : Proposed lease ID, in a GUID string format. The Blob service + returns 400 (Invalid request) if the proposed lease ID is not in + the correct format. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob lease break + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-break-period : For a break operation, this is the proposed duration of seconds + that the lease should continue before it is broken, between 0 + and 60 seconds. This break period is only used if it is shorter + than the time remaining on the lease. If longer, the time + remaining on the lease is used. A new lease will not be + available before the break period has expired, but the lease may + be held for longer than the break period. If this header does + not appear with a break operation, a fixed-duration lease breaks + after the remaining lease period elapses, and an infinite lease + breaks immediately. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob lease change + +Arguments + --container-name -c [Required]: The container name. + --lease-id [Required]: Required if the blob has an active lease. + --name -n [Required]: The blob name. + --proposed-lease-id [Required]: Proposed lease ID, in a GUID string format. The Blob service + returns 400 (Invalid request) if the proposed lease ID is not in + the correct format. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob lease release + +Arguments + --container-name -c [Required]: The container name. + --lease-id [Required]: Lease ID for active lease. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob lease renew + +Arguments + --container-name -c [Required]: The container name. + --lease-id [Required]: Lease ID for active lease. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob list + +Arguments + --container-name -c [Required]: The container name. + --delimiter : When the request includes this parameter, the operation returns + a :class:`~azure.storage.blob.models.BlobPrefix` element in the + result list that acts as a placeholder for all blobs whose names + begin with the same substring up to the appearance of the + delimiter character. The delimiter may be a single character or + a string. + --include : Specifies one or more additional datasets to include in the + response. + --marker : An opaque continuation token. This value can be retrieved from + the next_marker field of a previous generator object if + num_results was specified and that generator has finished + enumerating results. If specified, this generator will begin + returning results from the point where the previous generator + stopped. + --num-results : Specifies the maximum number of blobs to return, including all + :class:`BlobPrefix` elements. If the request does not specify + num_results or specifies a value greater than 5,000, the server + will return up to 5,000 items. Setting num_results to a value + less than or equal to zero results in error response code 400 + (Bad Request). + --prefix : Filters the results to return only blobs whose names begin with + the specified prefix. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob metadata show + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --snapshot : The snapshot parameter is an opaque value that, when present, + specifies the blob snapshot to retrieve. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob metadata update + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob service-properties show + +Arguments + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob show + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --snapshot : The snapshot parameter is an opaque DateTime value that, when + present, specifies the blob snapshot to retrieve. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob snapshot + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob update + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --content-cache-control : The cache control string. + --content-disposition : Conveys additional information about how to process the response + payload, and can also be used to attach additional metadata. + --content-encoding : The content encoding type. + --content-language : The content language. + --content-md5 : The content's MD5 hash. + --content-type : The content MIME type. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob upload + +Arguments + --container-name -c [Required]: The container name. + --file -f [Required]: Path of the file to upload as the blob content. + --name -n [Required]: The blob name. + --type -t [Required]: Allowed values: page, append, block. + --content-cache-control : The cache control string. + --content-disposition : Conveys additional information about how to process the response + payload, and can also be used to attach additional metadata. + --content-encoding : The content encoding type. + --content-language : The content language. + --content-md5 : The content's MD5 hash. + --content-type : The content MIME type. + --if-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag + matches the value specified. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-none-match : An ETag value, or the wildcard character (*). Specify this + header to perform the operation only if the resource's ETag does + not match the value specified. Specify the wildcard character + (*) to perform the operation only if the resource does not + exist, and fail the operation if it does exist. + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --lease-id : Required if the blob has an active lease. + --max-connections : Maximum number of parallel connections to use when the blob size + exceeds 64MB. Default: 2. + --max-retries : Number of times to retry upload of blob chunk if an error + occurs. Default: 5. + --maxsize-condition + --metadata : Metadata in space-separated key=value pairs. + --retry-wait : Sleep time in secs between retries. Default: 1. + --timeout : Request timeout in seconds. Applies to each call to the service. + --validate-content : If true, calculates an MD5 hash for each chunk of the blob. The + storage service checks the hash of the content that has arrived + with the hash that was sent. This is primarily valuable for + detecting bitflips on the wire if using http instead of https as + https (the default) will already validate. Note that this MD5 + hash is not stored with the blob. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage blob url + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The blob name. + --protocol : Protocol to use: 'http' or 'https'. If not specified, uses the + protocol specified when BaseBlobService was initialized. + Allowed values: http, https. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container create + +Arguments + --name -n [Required]: The container name. + --fail-on-exist : Throw an exception if the container already exists. + --metadata : Metadata in space-separated key=value pairs. + --public-access : Specifies whether data in the container may be accessed publically. By + default, container data is private to the account owner. Use "blob" to + allow public read access for blobs. Use "container" to allow public read + and list access to the entire container. Allowed values: blob, container. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container delete + +Arguments + --name -n [Required]: The container name. + --fail-not-exist : Throw an exception if the container does not exist. + --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --lease-id : If specified, delete_container only succeeds if the container's lease is + active and matches this ID. Required if the container has an active + lease. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container exists + +Arguments + --name -n [Required]: The container name. + --snapshot : The snapshot parameter is an opaque DateTime value that, when present, + specifies the snapshot. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container generate-sas + +Arguments + --name -n [Required]: The container name. + --cache-control : Response header value for Cache-Control when resource is accessed using + this shared access signature. + --content-disposition: Response header value for Content-Disposition when resource is accessed + using this shared access signature. + --content-encoding : Response header value for Content-Encoding when resource is accessed + using this shared access signature. + --content-language : Response header value for Content-Language when resource is accessed + using this shared access signature. + --content-type : Response header value for Content-Type when resource is accessed using + this shared access signature. + --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + invalid. Do not use if a stored access policy is referenced with --id + that specifies this value. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests + from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to accept + requests. Supports only IPv4 style addresses. + --permissions : The permissions the SAS grants. Allowed values: (d)elete (l)ist (r)ead + (w)rite. Do not use if a stored access policy is referenced with --id + that specifies this value. Can be combined. + --policy-name : The name of a stored access policy within the container's ACL. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + valid. Do not use if a stored access policy is referenced with --id that + specifies this value. Defaults to the time of the request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container lease acquire + +Arguments + --name -n [Required]: The container name. + --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --lease-duration : Specifies the duration of the lease, in seconds, or negative one (-1) for + a lease that never expires. A non-infinite lease can be between 15 and 60 + seconds. A lease duration cannot be changed using renew or change. + Default is -1 (infinite lease). Default: -1. + --proposed-lease-id : Proposed lease ID, in a GUID string format. The Blob service returns 400 + (Invalid request) if the proposed lease ID is not in the correct format. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container lease break + +Arguments + --name -n [Required]: The container name. + --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --lease-break-period : This is the proposed duration of seconds that the lease should continue + before it is broken, between 0 and 60 seconds. This break period is only + used if it is shorter than the time remaining on the lease. If longer, + the time remaining on the lease is used. A new lease will not be + available before the break period has expired, but the lease may be held + for longer than the break period. If this header does not appear with a + break operation, a fixed-duration lease breaks after the remaining lease + period elapses, and an infinite lease breaks immediately. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container lease change + +Arguments + --lease-id [Required]: Lease ID for active lease. + --name -n [Required]: The container name. + --proposed-lease-id [Required]: Proposed lease ID, in a GUID string format. The Blob service + returns 400 (Invalid request) if the proposed lease ID is not in + the correct format. + --if-modified-since : Alter only if modified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --if-unmodified-since : Alter only if unmodified since supplied UTC datetime + (Y-m-d'T'H:M'Z'). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container lease release + +Arguments + --lease-id [Required]: Lease ID for active lease. + --name -n [Required]: The container name. + --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container lease renew + +Arguments + --lease-id [Required]: Lease ID for active lease. + --name -n [Required]: The container name. + --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container list + +Arguments + --include-metadata : Specifies that container metadata be returned in the response. + --marker : An opaque continuation token. This value can be retrieved from the + next_marker field of a previous generator object if num_results was + specified and that generator has finished enumerating results. If + specified, this generator will begin returning results from the point where + the previous generator stopped. + --num-results : Specifies the maximum number of containers to return. A single list request + may return up to 1000 contianers and potentially a continuation token which + should be followed to get additional resutls. + --prefix : Filters the results to return only containers whose names begin with the + specified prefix. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container metadata show + +Arguments + --name -n [Required]: The container name. + --lease-id : If specified, get_container_metadata only succeeds if the container's + lease is active and matches this ID. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container metadata update + +Arguments + --name -n [Required]: The container name. + --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). + --lease-id : If specified, set_container_metadata only succeeds if the container's + lease is active and matches this ID. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container policy create + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The stored access policy name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of + request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container policy delete + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The stored access policy name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container policy list + +Arguments + --container-name -c [Required]: The container name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container policy show + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The stored access policy name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container policy update + +Arguments + --container-name -c [Required]: The container name. + --name -n [Required]: The stored access policy name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of + request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage container show + +Arguments + --name -n [Required]: The container name. + --lease-id : If specified, get_container_properties only succeeds if the container's + lease is active and matches this ID. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage cors add + +Arguments + --methods [Required]: List of HTTP methods allowed to be executed by the origin. Allowed + values: DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT. + --origins [Required]: List of origin domains that will be allowed via CORS, or "*" to allow all + domains. + --services [Required]: The storage service(s) for which to add the CORS rule: (b)lob (f)ile + (q)ueue (t)able. Can be combined. + --allowed-headers : List of response headers allowed to be part of the cross-origin request. + --exposed-headers : List of response headers to expose to CORS clients. + --max-age : The number of seconds the client/browser should cache a preflight + response. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage cors clear + +Arguments + --services [Required]: The storage service(s) for which to clear CORS rules: (b)lob (f)ile + (q)ueue (t)able. Can be combined. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage cors list + +Arguments + --services : Default: bfqt. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage directory create + +Arguments + --name -n [Required]: The directory name. + --share-name -s [Required]: The file share name. + --fail-on-exist : Specify whether to throw an exception when the directory exists. + False by default. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage directory delete + +Arguments + --name -n [Required]: The directory name. + --share-name -s [Required]: The file share name. + --fail-not-exist : Specify whether to throw an exception when the directory doesn't + exist. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage directory exists + +Arguments + --name -n [Required]: The directory name. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage directory metadata show + +Arguments + --name -n [Required]: The directory name. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage directory metadata update + +Arguments + --name -n [Required]: The directory name. + --share-name -s [Required]: The file share name. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage directory show + +Arguments + --name -n [Required]: The directory name. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage entity delete + +Arguments + --partition-key [Required]: The PartitionKey of the entity. + --row-key [Required]: The RowKey of the entity. + --table-name -t [Required]: The name of the table containing the entity to delete. + --if-match : The client may specify the ETag for the entity on the request in + order to compare to the ETag maintained by the service for the + purpose of optimistic concurrency. The delete operation will be + performed only if the ETag sent by the client matches the value + maintained by the server, indicating that the entity has not been + modified since it was retrieved by the client. To force an + unconditional delete, set If-Match to the wildcard character (*). + Default: *. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage entity insert: Insert a new entity into the table. + Inserts a new entity into the table. When inserting an entity into a table, you must specify + values for the PartitionKey and RowKey system properties. Together, these properties form + the primary key and must be unique within the table. Both the PartitionKey and RowKey values + may be up to 64 KB in size. If you are using an integer value as a key, you should convert + the integer to a fixed-width string, because they are canonically sorted. For example, you + should convert the value 1 to 0000001 to ensure proper sorting. + +Arguments + --entity -e [Required]: A space-separated list of key=value pairs. Must contain a + PartitionKey and a RowKey. + --table-name -t [Required]: The name of the table to insert the entity into. + --if-exists : Specify what should happen if an entity already exists for the + specified PartitionKey and RowKey. Allowed values: fail, merge, + replace. Default: fail. + --timeout : The server timeout, expressed in seconds. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage entity merge + +Arguments + --entity -e [Required]: The entity to merge. Could be a dict or an entity object. Must + contain a PartitionKey and a RowKey. + --table-name -t [Required]: The name of the table containing the entity to merge. + --if-match : The client may specify the ETag for the entity on the request in + order to compare to the ETag maintained by the service for the + purpose of optimistic concurrency. The merge operation will be + performed only if the ETag sent by the client matches the value + maintained by the server, indicating that the entity has not been + modified since it was retrieved by the client. To force an + unconditional merge, set If-Match to the wildcard character (*). + Default: *. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage entity query + +Arguments + --table-name -t [Required]: The name of the table to query. + --accept : Specifies the accepted content type of the response payload. See. + Default: application/json;odata=minimalmetadata. + --filter : Returns only entities that satisfy the specified filter. Note that + no more than 15 discrete comparisons are permitted within a $filter + string. See http://msdn.microsoft.com/en- + us/library/windowsazure/dd894031.aspx for more information on + constructing filters. + --marker : An opaque continuation object. This value can be retrieved from the + next_marker field of a previous generator object if max_results was + specified and that generator has finished enumerating results. If + specified, this generator will begin returning results from the + point where the previous generator stopped. + --num-results : The maximum number of entities to return. + --select : Returns only the desired properties of an entity from the set. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage entity replace + +Arguments + --entity -e [Required]: The entity to update. Could be a dict or an entity object. Must + contain a PartitionKey and a RowKey. + --table-name -t [Required]: The name of the table containing the entity to update. + --if-match : The client may specify the ETag for the entity on the request in + order to compare to the ETag maintained by the service for the + purpose of optimistic concurrency. The update operation will be + performed only if the ETag sent by the client matches the value + maintained by the server, indicating that the entity has not been + modified since it was retrieved by the client. To force an + unconditional update, set If-Match to the wildcard character (*). + Default: *. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage entity show + +Arguments + --partition-key [Required]: The PartitionKey of the entity. + --row-key [Required]: The RowKey of the entity. + --table-name -t [Required]: The name of the table to get the entity from. + --accept : Specifies the accepted content type of the response payload. See. + Default: application/json;odata=minimalmetadata. + --select : Returns only the desired properties of an entity from the set. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file copy cancel + +Arguments + --copy-id [Required]: Copy identifier provided in the copy.id of the original + copy_file operation. + --destination-path -p [Required]: The path to the file within the file share. + --destination-share -s [Required]: Name of the destination share. The share must exist. + --timeout : Request timeout in seconds. Applies to each call to the + service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, + jsonc. Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: + AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file copy start + +Arguments + --destination-path -p [Required]: The path to the file within the file share. + --destination-share -s [Required]: Name of the destination share. The share must exist. + --source-uri -u [Required]: A URL of up to 2 KB in length that specifies an Azure file or + blob. The value should be URL-encoded as it would appear in a + request URI. If the source is in another account, the source + must either be public or must be authenticated via a shared + access signature. If the source is public, no authentication + is required. Examples: + https://myaccount.file.core.windows.net/myshare/mydir/myfile + https://otheraccount.file.core.windows.net/myshare/mydir/myfi + le?sastoken. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the + service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, + jsonc. Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: + AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file delete + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file download + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --dest : Path of the file to write to. The source filename will be used if + not specified. + --end-range : End of byte range to use for downloading a section of the file. If + end_range is given, start_range must be provided. The start_range + and end_range params are inclusive. Ex: start_range=0, end_range=511 + will download first 512 bytes of file. + --max-connections : If set to 2 or greater, an initial get will be done for the first + self.MAX_SINGLE_GET_SIZE bytes of the file. If this is the entire + file, the method returns at this point. If it is not, it will + download the remaining data parallel using the number of threads + equal to max_connections. Each chunk will be of size + self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request + will be done. This is not generally recommended but available if + very few threads should be used, network requests are very + expensive, or a non-seekable stream prevents parallel download. This + may also be valuable if the file is being concurrently modified to + enforce atomicity or if many files are expected to be empty as an + extra request is required for empty files if max_connections is + greater than 1. Default: 2. + --max-retries : Number of times to retry download of file chunk if an error occurs. + Default: 5. + --open-mode : Mode to use when opening the file. Note that specifying append only + open_mode prevents parallel download. So, max_connections must be + set to 1 if this open_mode is used. Default: wb. + --retry-wait : Sleep time in secs between retries. Default: 1.0. + --start-range : Start of byte range to use for downloading a section of the file. If + no end_range is given, all bytes after the start_range will be + downloaded. The start_range and end_range params are inclusive. Ex: + start_range=0, end_range=511 will download first 512 bytes of file. + --timeout : Request timeout in seconds. Applies to each call to the service. + --validate-content : If set to true, validates an MD5 hash for each retrieved portion of + the file. This is primarily valuable for detecting bitflips on the + wire if using http instead of https as https (the default) will + already validate. Note that the service will only return + transactional MD5s for chunks 4MB or less so the first get request + will be of size self.MAX_CHUNK_GET_SIZE instead of + self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to + greater than 4MB an error will be thrown. As computing the MD5 takes + processing time and more requests will need to be done due to the + reduced chunk size there may be some increase in latency. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file exists + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file generate-sas + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --cache-control : Response header value for Cache-Control when resource is accessed + using this shared access signature. + --content-disposition : Response header value for Content-Disposition when resource is + accessed using this shared access signature. + --content-encoding : Response header value for Content-Encoding when resource is accessed + using this shared access signature. + --content-language : Response header value for Content-Language when resource is accessed + using this shared access signature. + --content-type : Response header value for Content-Type when resource is accessed + using this shared access signature. + --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + invalid. Do not use if a stored access policy is referenced with + --id that specifies this value. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, + requests from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to + accept requests. Supports only IPv4 style addresses. + --permissions : The permissions the SAS grants. Allowed values: (c)reate (d)elete + (r)ead (w)rite. Do not use if a stored access policy is referenced + with --id that specifies this value. Can be combined. + --policy-name : The name of a stored access policy within the share's ACL. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + valid. Do not use if a stored access policy is referenced with --id + that specifies this value. Defaults to the time of the request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file list + +Arguments + --share-name -s [Required]: The file share name. + --marker : An opaque continuation token. This value can be retrieved from the + next_marker field of a previous generator object if num_results was + specified and that generator has finished enumerating results. If + specified, this generator will begin returning results from the + point where the previous generator stopped. + --num-results : Specifies the maximum number of files to return, including all + directory elements. If the request does not specify num_results or + specifies a value greater than 5,000, the server will return up to + 5,000 items. Setting num_results to a value less than or equal to + zero results in error response code 400 (Bad Request). + --path -p : The directory path within the file share. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file metadata show + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file metadata update + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file resize + +Arguments + --content-length [Required]: The length to resize the file to. + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file show + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file update + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --content-cache-control : The cache control string. + --content-disposition : Conveys additional information about how to process the response + payload, and can also be used to attach additional metadata. + --content-encoding : The content encoding type. + --content-language : The content language. + --content-md5 : The content's MD5 hash. + --content-type : The content MIME type. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file upload + +Arguments + --share-name -s [Required]: The file share name. + --source [Required]: Path of the local file to upload as the file content. + --content-cache-control : The cache control string. + --content-disposition : Conveys additional information about how to process the response + payload, and can also be used to attach additional metadata. + --content-encoding : The content encoding type. + --content-language : The content language. + --content-md5 : The content's MD5 hash. + --content-type : The content MIME type. + --max-connections : Maximum number of parallel connections to use. Default: 2. + --max-retries : Number of times to retry upload of file chunk if an error occurs. + Default: 5. + --metadata : Metadata in space-separated key=value pairs. + --path -p : The path to the file within the file share. If the file name is + omitted, the source file name will be used. + --retry-wait : Sleep time in secs between retries. Default: 1.0. + --timeout : Request timeout in seconds. Applies to each call to the service. + --validate-content : If true, calculates an MD5 hash for each range of the file. The + storage service checks the hash of the content that has arrived with + the hash that was sent. This is primarily valuable for detecting + bitflips on the wire if using http instead of https as https (the + default) will already validate. Note that this MD5 hash is not + stored with the file. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage file url + +Arguments + --path -p [Required]: The path to the file within the file share. + --share-name -s [Required]: The file share name. + --protocol : Protocol to use: 'http' or 'https'. If not specified, uses the + protocol specified when FileService was initialized. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage logging show + +Arguments + --services : The storage services from which to retrieve logging info: (b)lob (q)ueue + (t)able. Can be combined. Default: bqt. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage logging update + +Arguments + --log [Required]: The operations for which to enable logging: (r)ead (w)rite (d)elete. Can + be combined. + --retention [Required]: Number of days for which to retain logs. 0 to disable. + --services [Required]: The storage service(s) for which to update logging info: (b)lob (q)ueue + (t)able. Can be combined. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage message clear + +Arguments + --queue-name -q [Required]: The queue name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage message delete + +Arguments + --id [Required]: The message id identifying the message to delete. + --pop-receipt [Required]: A valid pop receipt value returned from an earlier call to the + :func:`~get_messages` or :func:`~update_message`. + --queue-name -q [Required]: The queue name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage message get + +Arguments + --queue-name -q [Required]: The queue name. + --num-messages : A nonzero integer value that specifies the number of messages to + retrieve from the queue, up to a maximum of 32. If fewer are + visible, the visible messages are returned. By default, a single + message is retrieved from the queue with this operation. + --timeout : Request timeout in seconds. Applies to each call to the service. + --visibility-timeout : Specifies the new visibility timeout value, in seconds, relative to + server time. The new value must be larger than or equal to 1 second, + and cannot be larger than 7 days. The visibility timeout of a + message can be set to a value later than the expiry time. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage message peek + +Arguments + --queue-name -q [Required]: The queue name. + --num-messages : A nonzero integer value that specifies the number of messages to + peek from the queue, up to a maximum of 32. By default, a single + message is peeked from the queue with this operation. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage message put + +Arguments + --content [Required]: Message content. Allowed type is determined by the encode_function + set on the service. Default is str. The encoded message can be up to + 64KB in size. + --queue-name -q [Required]: The queue name. + --time-to-live : Specifies the time-to-live interval for the message, in seconds. The + maximum time-to-live allowed is 7 days. If this parameter is + omitted, the default time-to-live is 7 days. + --timeout : Request timeout in seconds. Applies to each call to the service. + --visibility-timeout : If not specified, the default value is 0. Specifies the new + visibility timeout value, in seconds, relative to server time. The + value must be larger than or equal to 0, and cannot be larger than 7 + days. The visibility timeout of a message cannot be set to a value + later than the expiry time. visibility_timeout should be set to a + value smaller than the time-to-live value. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage message update + +Arguments + --id [Required]: The message id identifying the message to update. + --pop-receipt [Required]: A valid pop receipt value returned from an earlier call to the + :func:`~get_messages` or :func:`~update_message` operation. + --queue-name -q [Required]: The queue name. + --visibility-timeout [Required]: Specifies the new visibility timeout value, in seconds, + relative to server time. The new value must be larger than or + equal to 0, and cannot be larger than 7 days. The visibility + timeout of a message cannot be set to a value later than the + expiry time. A message can be updated until it has been deleted + or has expired. + --content : Message content. Allowed type is determined by the + encode_function set on the service. Default is str. + --timeout : Request timeout in seconds. Applies to each call to the + service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more + information and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction + with storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage metrics show + +Arguments + --interval : Filter the set of metrics to retrieve by time interval. Allowed values: + hour, minute, both. Default: both. + --services : The storage services from which to retrieve metrics info: (b)lob (f)ile + (q)ueue (t)able. Can be combined. Default: bfqt. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage metrics update + +Arguments + --retention [Required]: Number of days for which to retain metrics. 0 to disable. Applies to + both hour and minute metrics if both are specified. + --services [Required]: The storage service(s) for which to update metrics info: (b)lob (f)ile + (q)ueue (t)able. Can be combined. + --api : Specify whether to include API in metrics. Applies to both hour and + minute metrics if both are specified. Must be specified if hour or + minute metrics are enabled and being updated. Allowed values: enable, + disable. + --hour : Update the hourly metrics. Allowed values: enable, disable. + --minute : Update the by-minute metrics. Allowed values: enable, disable. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue create + +Arguments + --name -n [Required]: The queue name. + --fail-on-exist : Specifies whether to throw an exception if the queue already exists. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue delete + +Arguments + --name -n [Required]: The queue name. + --fail-not-exist : Specifies whether to throw an exception if the queue doesn't exist. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue exists + +Arguments + --name -n [Required]: The queue name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue generate-sas + +Arguments + --name -n [Required]: The queue name. + --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + invalid. Do not use if a stored access policy is referenced with --id that + specifies this value. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests + from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to accept + requests. Supports only IPv4 style addresses. + --permissions : The permissions the SAS grants. Allowed values: (a)dd (p)rocess (r)ead + (u)pdate. Do not use if a stored access policy is referenced with --id + that specifies this value. Can be combined. + --policy-name : The name of a stored access policy within the queue's ACL. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + valid. Do not use if a stored access policy is referenced with --id that + specifies this value. Defaults to the time of the request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue list + +Arguments + --include-metadata : Specifies that container metadata be returned in the response. + --marker : An opaque continuation token. This value can be retrieved from the + next_marker field of a previous generator object if num_results was + specified and that generator has finished enumerating results. If + specified, this generator will begin returning results from the point where + the previous generator stopped. + --num-results : The maximum number of queues to return. + --prefix : Filters the results to return only queues with names that begin with the + specified prefix. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue metadata show + +Arguments + --name -n [Required]: The queue name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue metadata update + +Arguments + --name -n [Required]: The queue name. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue policy create + +Arguments + --name -n [Required]: The stored access policy name. + --queue-name -q [Required]: The queue name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Can be combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue policy delete + +Arguments + --name -n [Required]: The stored access policy name. + --queue-name -q [Required]: The queue name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue policy list + +Arguments + --queue-name -q [Required]: The queue name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue policy show + +Arguments + --name -n [Required]: The stored access policy name. + --queue-name -q [Required]: The queue name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue policy update + +Arguments + --name -n [Required]: The stored access policy name. + --queue-name -q [Required]: The queue name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Can be combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage queue stats + +Arguments + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share create + +Arguments + --name -n [Required]: The file share name. + --fail-on-exist : Specify whether to throw an exception when the share exists. False by + default. + --metadata : Metadata in space-separated key=value pairs. + --quota : Specifies the maximum size of the share, in gigabytes. Must be greater + than 0, and less than or equal to 5TB (5120). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share delete + +Arguments + --name -n [Required]: The file share name. + --fail-not-exist : Specify whether to throw an exception when the share doesn't exist. False + by default. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share exists + +Arguments + --name -n [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share generate-sas + +Arguments + --name -n [Required]: The file share name. + --cache-control : Response header value for Cache-Control when resource is accessed using + this shared access signature. + --content-disposition: Response header value for Content-Disposition when resource is accessed + using this shared access signature. + --content-encoding : Response header value for Content-Encoding when resource is accessed + using this shared access signature. + --content-language : Response header value for Content-Language when resource is accessed + using this shared access signature. + --content-type : Response header value for Content-Type when resource is accessed using + this shared access signature. + --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + invalid. Do not use if a stored access policy is referenced with --id + that specifies this value. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests + from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to accept + requests. Supports only IPv4 style addresses. + --permissions : The permissions the SAS grants. Allowed values: (d)elete (l)ist (r)ead + (w)rite. Do not use if a stored access policy is referenced with --id + that specifies this value. Can be combined. + --policy-name : The name of a stored access policy within the share's ACL. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + valid. Do not use if a stored access policy is referenced with --id that + specifies this value. Defaults to the time of the request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share list + +Arguments + --include-metadata : Specifies that share metadata be returned in the response. + --marker : An opaque continuation token. This value can be retrieved from the + next_marker field of a previous generator object if num_results was + specified and that generator has finished enumerating results. If + specified, this generator will begin returning results from the point where + the previous generator stopped. + --num-results : Specifies the maximum number of shares to return. + --prefix : Filters the results to return only shares whose names begin with the + specified prefix. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share metadata show + +Arguments + --name -n [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share metadata update + +Arguments + --name -n [Required]: The file share name. + --metadata : Metadata in space-separated key=value pairs. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share policy create + +Arguments + --name -n [Required]: The stored access policy name. + --share-name -s [Required]: The file share name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share policy delete + +Arguments + --name -n [Required]: The stored access policy name. + --share-name -s [Required]: The file share name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share policy list + +Arguments + --share-name -s [Required]: The file share name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share policy show + +Arguments + --name -n [Required]: The stored access policy name. + --share-name -s [Required]: The file share name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share policy update + +Arguments + --name -n [Required]: The stored access policy name. + --share-name -s [Required]: The file share name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share show + +Arguments + --name -n [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share stats + +Arguments + --name -n [Required]: The file share name. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage share update + +Arguments + --name -n [Required]: The file share name. + --quota [Required]: Specifies the maximum size of the share, in gigabytes. Must be greater + than 0, and less than or equal to 5 TB (5120 GB). + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table batch commit + +Arguments + --batch [Required]: The batch to commit. + --table-name -t [Required]: The name of the table to commit the batch to. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table batch create + +Arguments + --table-name -t [Required]: The name of the table to commit the batch to. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table create + +Arguments + --name -n [Required]: The name of the table to create. The table name may contain only + alphanumeric characters and cannot begin with a numeric character. It is + case-insensitive and must be from 3 to 63 characters long. + --fail-on-exist : Throw an exception if the table already exists. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table delete + +Arguments + --name -n [Required]: The name of the table to delete. + --fail-not-exist : Specifies whether to throw an exception if the table doesn't exist. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table exists + +Arguments + --name -n [Required]: The name of table to check for existence. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table generate-sas + +Arguments + --name -n [Required]: The name of the table to create a SAS token for. + --end-pk : The maximum partition key accessible with this shared access signature. + endpk must accompany endrk. Key values are inclusive. If omitted, there is + no upper bound on the table entities that can be accessed. + --end-rk : The maximum row key accessible with this shared access signature. endpk + must accompany endrk. Key values are inclusive. If omitted, there is no + upper bound on the table entities that can be accessed. + --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + invalid. Do not use if a stored access policy is referenced with --id that + specifies this value. + --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests + from both the HTTP and HTTPS protocol are permitted. + --ip : Specifies the IP address or range of IP addresses from which to accept + requests. Supports only IPv4 style addresses. + --permissions : The permissions the SAS grants. Allowed values: (r)ead/query (a)dd + (u)pdate (d)elete. Do not use if a stored access policy is referenced with + --id that specifies this value. Can be combined. + --policy-name : The name of a stored access policy within the table's ACL. + --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes + valid. Do not use if a stored access policy is referenced with --id that + specifies this value. Defaults to the time of the request. + --start-pk : The minimum partition key accessible with this shared access signature. + startpk must accompany startrk. Key values are inclusive. If omitted, + there is no lower bound on the table entities that can be accessed. + --start-rk : The minimum row key accessible with this shared access signature. startpk + must accompany startrk. Key values are inclusive. If omitted, there is no + lower bound on the table entities that can be accessed. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account + name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table list + +Arguments + --marker : An opaque continuation object. This value can be retrieved from the + next_marker field of a previous generator object if num_results was + specified and that generator has finished enumerating results. If + specified, this generator will begin returning results from the point where + the previous generator stopped. + --num-results : The maximum number of tables to return. + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table policy create + +Arguments + --name -n [Required]: The stored access policy name. + --table-name -t [Required]: The container name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (r)ead/query (a)dd (u)pdate (d)elete. Can be + combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table policy delete + +Arguments + --name -n [Required]: The stored access policy name. + --table-name -t [Required]: The container name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table policy list + +Arguments + --table-name -t [Required]: The container name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table policy show + +Arguments + --name -n [Required]: The stored access policy name. + --table-name -t [Required]: The container name. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table policy update + +Arguments + --name -n [Required]: The stored access policy name. + --table-name -t [Required]: The container name. + --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). + --permissions : Allowed values: (r)ead/query (a)dd (u)pdate (d)elete. Can be + combined. + --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. + Default: json. + --query : JMESPath query string. See http://jmespath.org/ for more information + and examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage + account name. Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either + storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string : Storage account connection string. Var: + AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with + storage account name. Var: AZURE_SAS_TOKEN. + +=============================== + +Command + az storage table stats + +Arguments + --timeout : Request timeout in seconds. Applies to each call to the service. + +Global Arguments + --debug : Increase logging verbosity to show all debug logs. + --help -h : Show this help message and exit. + --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: + json. + --query : JMESPath query string. See http://jmespath.org/ for more information and + examples. + --verbose : Increase logging verbosity. Use --debug for full debug logs. + +Storage Account Arguments + --account-key : Storage account key. Must be used in conjunction with storage account name. + Var: AZURE_STORAGE_KEY. + --account-name : Storage account name. Must be used in conjunction with either storage + account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. + --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. + --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage + account name. Var: AZURE_SAS_TOKEN. + +=============================== diff --git a/src/azure/cli/commands/__init__.py b/src/azure/cli/commands/__init__.py index 4047ee780b3..b173ce65a23 100644 --- a/src/azure/cli/commands/__init__.py +++ b/src/azure/cli/commands/__init__.py @@ -17,7 +17,7 @@ from azure.cli._util import CLIError import azure.cli._logging as _logging -from ._introspection import extract_args_from_signature +from ._introspection import extract_args_from_signature, extract_summary_from_docstring logger = _logging.get_az_logger(__name__) @@ -233,6 +233,7 @@ def _execute_command(kwargs): name = ' '.join(name.split()) cmd = CliCommand(name, _execute_command, simple_output_query=simple_output_query) + #cmd.description = extract_summary_from_docstring(operation) cmd.arguments.update(extract_args_from_signature(operation)) return cmd diff --git a/src/azure/cli/commands/_introspection.py b/src/azure/cli/commands/_introspection.py index 87755854237..415fa401d95 100644 --- a/src/azure/cli/commands/_introspection.py +++ b/src/azure/cli/commands/_introspection.py @@ -6,9 +6,21 @@ import inspect import re +def extract_summary_from_docstring(operation): + """ Extract the summary from the doccomments of the command. """ + lines = inspect.getdoc(operation) + regex = re.compile('\s*(:param)\s+(.+)\s*:(.*)') + summary = '' + if lines: + match = regex.search(lines) + if match: + summary = lines[:match.regs[0][0]] + else: + summary = lines + return summary + def _option_descriptions(operation): - """Pull out parameter help from doccomments of the command - """ + """ Extract parameter help from doccomments of the command. """ option_descs = {} lines = inspect.getdoc(operation) if lines: From 066e8dd726035f49a45ccfb3d0e8327044abbf9f Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Tue, 23 Aug 2016 14:06:37 -0700 Subject: [PATCH 2/5] Fix issue #680. --- src/azure/cli/commands/_introspection.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/azure/cli/commands/_introspection.py b/src/azure/cli/commands/_introspection.py index 415fa401d95..8e56e26a988 100644 --- a/src/azure/cli/commands/_introspection.py +++ b/src/azure/cli/commands/_introspection.py @@ -23,6 +23,7 @@ def _option_descriptions(operation): """ Extract parameter help from doccomments of the command. """ option_descs = {} lines = inspect.getdoc(operation) + param_breaks = ["'''", '"""', ':param', ':type', ':return', ':rtype'] if lines: lines = lines.splitlines() index = 0 @@ -38,7 +39,7 @@ def _option_descriptions(operation): index += 1 while index < len(lines): temp = lines[index].strip() - if temp.startswith(':'): + if any(temp.startswith(x) for x in param_breaks): break else: if temp: From ce762dcf6911a86c80008823b2c2a3f1395ea518 Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Tue, 23 Aug 2016 16:12:59 -0700 Subject: [PATCH 3/5] Fix issues #365 and #447. --- help_dump.txt | 18 ++++++++++-------- src/azure/cli/_help.py | 22 +++++++++++++++------- src/azure/cli/commands/__init__.py | 4 ++-- src/azure/cli/commands/_introspection.py | 4 ++-- 4 files changed, 29 insertions(+), 19 deletions(-) diff --git a/help_dump.txt b/help_dump.txt index 1193ef70c01..87fe4c29141 100644 --- a/help_dump.txt +++ b/help_dump.txt @@ -148,7 +148,7 @@ Command Arguments --name -n [Required]: The storage account name. --resource-group -g [Required]: Name of resource group. - --key : The key(s) to renew. Allowed values: secondary, both, primary. + --key : The key(s) to renew. Allowed values: secondary, primary, both. Default: both. Global Arguments @@ -393,7 +393,7 @@ Arguments --container-name -c [Required]: The container name. --name -n [Required]: The blob name. --delete-snapshots : Required if the blob has associated snapshots. Allowed values: - only, include. + include, only. --if-match : An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. @@ -1137,7 +1137,7 @@ Arguments --container-name -c [Required]: The container name. --file -f [Required]: Path of the file to upload as the blob content. --name -n [Required]: The blob name. - --type -t [Required]: Allowed values: page, append, block. + --type -t [Required]: Allowed values: block, append, page. --content-cache-control : The cache control string. --content-disposition : Conveys additional information about how to process the response payload, and can also be used to attach additional metadata. @@ -1235,7 +1235,7 @@ Arguments --public-access : Specifies whether data in the container may be accessed publically. By default, container data is private to the account owner. Use "blob" to allow public read access for blobs. Use "container" to allow public read - and list access to the entire container. Allowed values: blob, container. + and list access to the entire container. Allowed values: container, blob. --timeout : Request timeout in seconds. Applies to each call to the service. Global Arguments @@ -2202,8 +2202,9 @@ Command Arguments --table-name -t [Required]: The name of the table to query. - --accept : Specifies the accepted content type of the response payload. See. - Default: application/json;odata=minimalmetadata. + --accept : Specifies the accepted content type of the response payload. See + :class:`~azure.storage.table.models.TablePayloadFormat` for possible + values. Default: application/json;odata=minimalmetadata. --filter : Returns only entities that satisfy the specified filter. Note that no more than 15 discrete comparisons are permitted within a $filter string. See http://msdn.microsoft.com/en- @@ -2284,8 +2285,9 @@ Arguments --partition-key [Required]: The PartitionKey of the entity. --row-key [Required]: The RowKey of the entity. --table-name -t [Required]: The name of the table to get the entity from. - --accept : Specifies the accepted content type of the response payload. See. - Default: application/json;odata=minimalmetadata. + --accept : Specifies the accepted content type of the response payload. See + :class:`~azure.storage.table.models.TablePayloadFormat` for possible + values. Default: application/json;odata=minimalmetadata. --select : Returns only the desired properties of an entity from the set. --timeout : Request timeout in seconds. Applies to each call to the service. diff --git a/src/azure/cli/_help.py b/src/azure/cli/_help.py index 4a01333b918..932dd7abf66 100644 --- a/src/azure/cli/_help.py +++ b/src/azure/cli/_help.py @@ -137,11 +137,12 @@ def _print_groups(help_file): def _print_items(items): for c in sorted(items, key=lambda h: h.name): - _print_indent('{0}{1}{2}'.format(c.name, - _get_column_indent(c.name, max_name_length), - ': ' + c.short_summary if c.short_summary else ''), - indent) - + column_indent = _get_column_indent(c.name, max_name_length) + summary = ': ' + c.short_summary if c.short_summary else '' + summary = summary.replace('\n', ' ') + hanging_indent = max_name_length + indent*4 + 2 + _print_indent( + '{0}{1}{2}'.format(c.name, column_indent, summary), indent, hanging_indent) _print_indent('') indent = 1 @@ -160,7 +161,7 @@ def _print_items(items): _print_items(subcommands) def _get_choices_defaults_str(p): - choice_str = ' Allowed values: {0}.'.format(', '.join([str(x) for x in p.choices])) \ + choice_str = ' Allowed values: {0}.'.format(', '.join(sorted([str(x) for x in p.choices]))) \ if p.choices else '' default_str = ' Default: {0}.'.format(p.default) \ if p.default and p.default != argparse.SUPPRESS else '' @@ -212,7 +213,14 @@ def __init__(self, delimiters): self.examples = '' def load(self, options): - self.short_summary = getattr(options, 'description', None) + description = getattr(options, 'description', None) + try: + self.short_summary = description[:description.index('.')] + self.long_summary = description[description.index('.') + 1:].lstrip() + except (ValueError, AttributeError): + self.short_summary = description + self.long_summary = None + file_data = (_load_help_file_from_string(options.help_file) if hasattr(options, '_defaults') else None) diff --git a/src/azure/cli/commands/__init__.py b/src/azure/cli/commands/__init__.py index b173ce65a23..e8e03b95a7f 100644 --- a/src/azure/cli/commands/__init__.py +++ b/src/azure/cli/commands/__init__.py @@ -17,7 +17,7 @@ from azure.cli._util import CLIError import azure.cli._logging as _logging -from ._introspection import extract_args_from_signature, extract_summary_from_docstring +from ._introspection import extract_args_from_signature, extract_full_summary_from_signature logger = _logging.get_az_logger(__name__) @@ -233,7 +233,7 @@ def _execute_command(kwargs): name = ' '.join(name.split()) cmd = CliCommand(name, _execute_command, simple_output_query=simple_output_query) - #cmd.description = extract_summary_from_docstring(operation) + cmd.description = extract_full_summary_from_signature(operation) cmd.arguments.update(extract_args_from_signature(operation)) return cmd diff --git a/src/azure/cli/commands/_introspection.py b/src/azure/cli/commands/_introspection.py index 8e56e26a988..253772fb4f6 100644 --- a/src/azure/cli/commands/_introspection.py +++ b/src/azure/cli/commands/_introspection.py @@ -6,10 +6,10 @@ import inspect import re -def extract_summary_from_docstring(operation): +def extract_full_summary_from_signature(operation): """ Extract the summary from the doccomments of the command. """ lines = inspect.getdoc(operation) - regex = re.compile('\s*(:param)\s+(.+)\s*:(.*)') + regex = re.compile(r'\s*(:param)\s+(.+)\s*:(.*)') summary = '' if lines: match = regex.search(lines) From 21fd43de6b2953cb95d4538de7b689d79aa4c4a2 Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Wed, 24 Aug 2016 13:59:58 -0700 Subject: [PATCH 4/5] Code review fixes. --- help_dump.txt | 4408 ---------------------- src/azure/cli/_help.py | 29 +- src/azure/cli/commands/_introspection.py | 4 +- 3 files changed, 20 insertions(+), 4421 deletions(-) delete mode 100644 help_dump.txt diff --git a/help_dump.txt b/help_dump.txt deleted file mode 100644 index 87fe4c29141..00000000000 --- a/help_dump.txt +++ /dev/null @@ -1,4408 +0,0 @@ - -Command - az storage account check-name - -Arguments - --name [Required] - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account connection-string - -Arguments - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - --protocol : The default endpoint protocol. Allowed values: http, https. - Default: https. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account create - -Arguments - --location -l [Required]: Location. - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - --sku [Required]: The storage account SKU. (Standard_LRS, Standard_GRS, - Standard_RAGRS, Standard_ZRS, Premium_LRS). - --access-tier : Required for StandardBlob accounts. The access tier used for - billing. Cannot be set for StandardLRS, StandardGRS, - StandardRAGRS, or PremiumLRS account types. (Hot, Cool). - --custom-domain : User domain assigned to the storage account. Name is the CNAME - source. Use empty string to clear. - --encryption : Specifies which service(s) to encrypt. Allowed values: blob. - --kind : Indicates the type of storage account. (Storage, BlobStorage). - Default: Storage. - --tags : Multiple semicolon separated tags in 'key[=value]' format. Use - "" to clear existing tags. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account delete - -Arguments - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account generate-sas - -Arguments - --expiry [Required]: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS - becomes invalid. - --permissions [Required]: The permissions the SAS grants. Allowed values: (a)dd (c)reate - (d)elete (l)ist (p)rocess (r)ead (u)pdate (w)rite. Can be combined. - --resource-types [Required]: The resource types the SAS is applicable for. Allowed values: - (s)ervice (c)ontainer (o)bject. Can be combined. - --services [Required]: The storage services the SAS is applicable for. Allowed values: - (b)lob (f)ile (q)ueue (t)able. Can be combined. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, - requests from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to - accept requests. Supports only IPv4 style addresses. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS - becomes valid. Defaults to the time of the request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --name -n : The storage account name. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage account keys list - -Arguments - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account keys renew - -Arguments - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - --key : The key(s) to renew. Allowed values: secondary, primary, both. - Default: both. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account list - -Arguments - --resource-group -g: Name of resource group. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account show - -Arguments - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account show-usage - -Arguments - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o: Output format. Allowed values: json, tsv, list, table, jsonc. Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage account update - -Arguments - --name -n [Required]: The storage account name. - --resource-group -g [Required]: Name of resource group. - --access-tier : Required for StandardBlob accounts. The access tier used for - billing. Cannot be set for StandardLRS, StandardGRS, - StandardRAGRS, or PremiumLRS account types. (Hot, Cool). - --custom-domain : User domain assigned to the storage account. Name is the CNAME - source. Use empty string to clear. - --encryption : Specifies which service(s) to encrypt. Allowed values: blob. - --sku : The storage account SKU. (Standard_LRS, Standard_GRS, - Standard_RAGRS, Standard_ZRS, Premium_LRS). - --tags : Multiple semicolon separated tags in 'key[=value]' format. Use - "" to clear existing tags. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -=============================== - -Command - az storage blob copy cancel - -Arguments - --copy-id [Required]: Copy identifier provided in the copy.id of the original - copy_blob operation. - --destination-blob -b [Required]: Name of the destination blob. If the exists, it will be - overwritten. - --destination-container -c [Required]: The container name. - --lease-id : Required if the destination blob has an active infinite - lease. - --timeout : Request timeout in seconds. Applies to each call to the - service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, - jsonc. Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug - logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with - storage account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with - either storage account key or a SAS token. Var: - AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in - conjunction with storage account name. Var: - AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob copy start - -Arguments - --destination-blob -b [Required]: Name of the destination blob. If the exists, it will be - overwritten. - --destination-container -c [Required]: The container name. - --source-uri -u [Required]: A URL of up to 2 KB in length that specifies an Azure - file or blob. The value should be URL-encoded as it would - appear in a request URI. If the source is in another - account, the source must either be public or must be - authenticated via a shared access signature. If the - source is public, no authentication is required. - Examples: https://myaccount.blob.core.windows.net/myconta - iner/myblob https://myaccount.blob.core.windows.net/mycon - tainer/myblob?snapshot= https://otheraccount.bl - ob.core.windows.net/mycontainer/myblob?sastoken. - --destination-if-match : An ETag value, or the wildcard character (*). Specify an - ETag value for this conditional header to copy the blob - only if the specified ETag value matches the ETag value - for an existing destination blob. If the ETag for the - destination blob does not match the ETag specified for - If-Match, the Blob service returns status code 412 - (Precondition Failed). - --destination-if-modified-since : A DateTime value. Azure expects the date value passed in - to be UTC. If timezone is included, any non-UTC datetimes - will be converted to UTC. If a date is passed in without - timezone info, it is assumed to be UTC. Specify this - conditional header to copy the blob only if the - destination blob has been modified since the specified - date/time. If the destination blob has not been modified, - the Blob service returns status code 412 (Precondition - Failed). - --destination-if-none-match : An ETag value, or the wildcard character (*). Specify an - ETag value for this conditional header to copy the blob - only if the specified ETag value does not match the ETag - value for the destination blob. Specify the wildcard - character (*) to perform the operation only if the - destination blob does not exist. If the specified - condition isn't met, the Blob service returns status code - 412 (Precondition Failed). - --destination-if-unmodified-since : A DateTime value. Azure expects the date value passed in - to be UTC. If timezone is included, any non-UTC datetimes - will be converted to UTC. If a date is passed in without - timezone info, it is assumed to be UTC. Specify this - conditional header to copy the blob only if the - destination blob has not been modified since the - specified date/time. If the destination blob has been - modified, the Blob service returns status code 412 - (Precondition Failed). - --destination-lease-id : The lease ID specified for this header must match the - lease ID of the destination blob. If the request does not - include the lease ID or it is not valid, the operation - fails with status code 412 (Precondition Failed). - --metadata : Metadata in space-separated key=value pairs. - --source-if-match : An ETag value, or the wildcard character (*). Specify - this conditional header to copy the source blob only if - its ETag matches the value specified. If the ETag values - do not match, the Blob service returns status code 412 - (Precondition Failed). This header cannot be specified if - the source is an Azure File. - --source-if-modified-since : A DateTime value. Azure expects the date value passed in - to be UTC. If timezone is included, any non-UTC datetimes - will be converted to UTC. If a date is passed in without - timezone info, it is assumed to be UTC. Specify this - conditional header to copy the blob only if the source - blob has been modified since the specified date/time. - --source-if-none-match : An ETag value, or the wildcard character (*). Specify - this conditional header to copy the blob only if its ETag - does not match the value specified. If the values are - identical, the Blob service returns status code 412 - (Precondition Failed). This header cannot be specified if - the source is an Azure File. - --source-if-unmodified-since : A DateTime value. Azure expects the date value passed in - to be UTC. If timezone is included, any non-UTC datetimes - will be converted to UTC. If a date is passed in without - timezone info, it is assumed to be UTC. Specify this - conditional header to copy the blob only if the source - blob has not been modified since the specified date/time. - --source-lease-id : Specify this to perform the Copy Blob operation only if - the lease ID given matches the active lease ID of the - source blob. - --timeout : Request timeout in seconds. Applies to each call to the - service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, - jsonc. Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug - logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with - storage account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with - either storage account key or a SAS token. Var: - AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in - conjunction with storage account name. Var: - AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob delete - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --delete-snapshots : Required if the blob has associated snapshots. Allowed values: - include, only. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --snapshot : The snapshot parameter is an opaque DateTime value that, when - present, specifies the blob snapshot to delete. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob download - -Arguments - --container-name -c [Required]: The container name. - --file -f [Required]: Path of file to write out to. - --name -n [Required]: The blob name. - --end-range : End of byte range to use for downloading a section of the blob. - If end_range is given, start_range must be provided. The - start_range and end_range params are inclusive. Ex: - start_range=0, end_range=511 will download first 512 bytes of - blob. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --max-connections : If set to 2 or greater, an initial get will be done for the - first self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the - entire blob, the method returns at this point. If it is not, it - will download the remaining data parallel using the number of - threads equal to max_connections. Each chunk will be of size - self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request - will be done. This is not generally recommended but available if - very few threads should be used, network requests are very - expensive, or a non-seekable stream prevents parallel download. - This may also be useful if many blobs are expected to be empty - as an extra request is required for empty blobs if - max_connections is greater than 1. Default: 2. - --max-retries : Number of times to retry download of blob chunk if an error - occurs. Default: 5. - --open-mode : Mode to use when opening the file. Note that specifying append - only open_mode prevents parallel download. So, max_connections - must be set to 1 if this open_mode is used. Default: wb. - --progress-callback : Callback for progress with signature function(current, total) - where current is the number of bytes transfered so far, and - total is the size of the blob if known. - --retry-wait : Sleep time in secs between retries. Default: 1.0. - --snapshot : The snapshot parameter is an opaque DateTime value that, when - present, specifies the blob snapshot to retrieve. - --start-range : Start of byte range to use for downloading a section of the - blob. If no end_range is given, all bytes after the start_range - will be downloaded. The start_range and end_range params are - inclusive. Ex: start_range=0, end_range=511 will download first - 512 bytes of blob. - --timeout : Request timeout in seconds. Applies to each call to the service. - --validate-content : If set to true, validates an MD5 hash for each retrieved portion - of the blob. This is primarily valuable for detecting bitflips - on the wire if using http instead of https as https (the - default) will already validate. Note that the service will only - return transactional MD5s for chunks 4MB or less so the first - get request will be of size self.MAX_CHUNK_GET_SIZE instead of - self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to - greater than 4MB an error will be thrown. As computing the MD5 - takes processing time and more requests will need to be done due - to the reduced chunk size there may be some increase in latency. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob exists - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --snapshot : The snapshot parameter is an opaque DateTime value that, when - present, specifies the snapshot. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob generate-sas - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --cache-control : Response header value for Cache-Control when resource is - accessed using this shared access signature. - --content-disposition : Response header value for Content-Disposition when resource is - accessed using this shared access signature. - --content-encoding : Response header value for Content-Encoding when resource is - accessed using this shared access signature. - --content-language : Response header value for Content-Language when resource is - accessed using this shared access signature. - --content-type : Response header value for Content-Type when resource is accessed - using this shared access signature. - --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS - becomes invalid. Do not use if a stored access policy is - referenced with --id that specifies this value. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, - requests from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to - accept requests. Supports only IPv4 style addresses. - --permissions : The permissions the SAS grants. Allowed values: (a)dd (c)reate - (d)elete (r)ead (w)rite. Do not use if a stored access policy is - referenced with --id that specifies this value. Can be combined. - --policy-name : The name of a stored access policy within the container's ACL. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS - becomes valid. Do not use if a stored access policy is - referenced with --id that specifies this value. Defaults to the - time of the request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob lease acquire - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-duration : Specifies the duration of the lease, in seconds, or negative one - (-1) for a lease that never expires. A non-infinite lease can be - between 15 and 60 seconds. A lease duration cannot be changed - using renew or change. Default is -1 (infinite lease). Default: - -1. - --proposed-lease-id : Proposed lease ID, in a GUID string format. The Blob service - returns 400 (Invalid request) if the proposed lease ID is not in - the correct format. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob lease break - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-break-period : For a break operation, this is the proposed duration of seconds - that the lease should continue before it is broken, between 0 - and 60 seconds. This break period is only used if it is shorter - than the time remaining on the lease. If longer, the time - remaining on the lease is used. A new lease will not be - available before the break period has expired, but the lease may - be held for longer than the break period. If this header does - not appear with a break operation, a fixed-duration lease breaks - after the remaining lease period elapses, and an infinite lease - breaks immediately. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob lease change - -Arguments - --container-name -c [Required]: The container name. - --lease-id [Required]: Required if the blob has an active lease. - --name -n [Required]: The blob name. - --proposed-lease-id [Required]: Proposed lease ID, in a GUID string format. The Blob service - returns 400 (Invalid request) if the proposed lease ID is not in - the correct format. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob lease release - -Arguments - --container-name -c [Required]: The container name. - --lease-id [Required]: Lease ID for active lease. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob lease renew - -Arguments - --container-name -c [Required]: The container name. - --lease-id [Required]: Lease ID for active lease. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob list - -Arguments - --container-name -c [Required]: The container name. - --delimiter : When the request includes this parameter, the operation returns - a :class:`~azure.storage.blob.models.BlobPrefix` element in the - result list that acts as a placeholder for all blobs whose names - begin with the same substring up to the appearance of the - delimiter character. The delimiter may be a single character or - a string. - --include : Specifies one or more additional datasets to include in the - response. - --marker : An opaque continuation token. This value can be retrieved from - the next_marker field of a previous generator object if - num_results was specified and that generator has finished - enumerating results. If specified, this generator will begin - returning results from the point where the previous generator - stopped. - --num-results : Specifies the maximum number of blobs to return, including all - :class:`BlobPrefix` elements. If the request does not specify - num_results or specifies a value greater than 5,000, the server - will return up to 5,000 items. Setting num_results to a value - less than or equal to zero results in error response code 400 - (Bad Request). - --prefix : Filters the results to return only blobs whose names begin with - the specified prefix. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob metadata show - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --snapshot : The snapshot parameter is an opaque value that, when present, - specifies the blob snapshot to retrieve. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob metadata update - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob service-properties show - -Arguments - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob show - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --snapshot : The snapshot parameter is an opaque DateTime value that, when - present, specifies the blob snapshot to retrieve. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob snapshot - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob update - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --content-cache-control : The cache control string. - --content-disposition : Conveys additional information about how to process the response - payload, and can also be used to attach additional metadata. - --content-encoding : The content encoding type. - --content-language : The content language. - --content-md5 : The content's MD5 hash. - --content-type : The content MIME type. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob upload - -Arguments - --container-name -c [Required]: The container name. - --file -f [Required]: Path of the file to upload as the blob content. - --name -n [Required]: The blob name. - --type -t [Required]: Allowed values: block, append, page. - --content-cache-control : The cache control string. - --content-disposition : Conveys additional information about how to process the response - payload, and can also be used to attach additional metadata. - --content-encoding : The content encoding type. - --content-language : The content language. - --content-md5 : The content's MD5 hash. - --content-type : The content MIME type. - --if-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag - matches the value specified. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-none-match : An ETag value, or the wildcard character (*). Specify this - header to perform the operation only if the resource's ETag does - not match the value specified. Specify the wildcard character - (*) to perform the operation only if the resource does not - exist, and fail the operation if it does exist. - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --lease-id : Required if the blob has an active lease. - --max-connections : Maximum number of parallel connections to use when the blob size - exceeds 64MB. Default: 2. - --max-retries : Number of times to retry upload of blob chunk if an error - occurs. Default: 5. - --maxsize-condition - --metadata : Metadata in space-separated key=value pairs. - --retry-wait : Sleep time in secs between retries. Default: 1. - --timeout : Request timeout in seconds. Applies to each call to the service. - --validate-content : If true, calculates an MD5 hash for each chunk of the blob. The - storage service checks the hash of the content that has arrived - with the hash that was sent. This is primarily valuable for - detecting bitflips on the wire if using http instead of https as - https (the default) will already validate. Note that this MD5 - hash is not stored with the blob. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage blob url - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The blob name. - --protocol : Protocol to use: 'http' or 'https'. If not specified, uses the - protocol specified when BaseBlobService was initialized. - Allowed values: http, https. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container create - -Arguments - --name -n [Required]: The container name. - --fail-on-exist : Throw an exception if the container already exists. - --metadata : Metadata in space-separated key=value pairs. - --public-access : Specifies whether data in the container may be accessed publically. By - default, container data is private to the account owner. Use "blob" to - allow public read access for blobs. Use "container" to allow public read - and list access to the entire container. Allowed values: container, blob. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container delete - -Arguments - --name -n [Required]: The container name. - --fail-not-exist : Throw an exception if the container does not exist. - --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --lease-id : If specified, delete_container only succeeds if the container's lease is - active and matches this ID. Required if the container has an active - lease. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container exists - -Arguments - --name -n [Required]: The container name. - --snapshot : The snapshot parameter is an opaque DateTime value that, when present, - specifies the snapshot. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container generate-sas - -Arguments - --name -n [Required]: The container name. - --cache-control : Response header value for Cache-Control when resource is accessed using - this shared access signature. - --content-disposition: Response header value for Content-Disposition when resource is accessed - using this shared access signature. - --content-encoding : Response header value for Content-Encoding when resource is accessed - using this shared access signature. - --content-language : Response header value for Content-Language when resource is accessed - using this shared access signature. - --content-type : Response header value for Content-Type when resource is accessed using - this shared access signature. - --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - invalid. Do not use if a stored access policy is referenced with --id - that specifies this value. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests - from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to accept - requests. Supports only IPv4 style addresses. - --permissions : The permissions the SAS grants. Allowed values: (d)elete (l)ist (r)ead - (w)rite. Do not use if a stored access policy is referenced with --id - that specifies this value. Can be combined. - --policy-name : The name of a stored access policy within the container's ACL. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - valid. Do not use if a stored access policy is referenced with --id that - specifies this value. Defaults to the time of the request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container lease acquire - -Arguments - --name -n [Required]: The container name. - --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --lease-duration : Specifies the duration of the lease, in seconds, or negative one (-1) for - a lease that never expires. A non-infinite lease can be between 15 and 60 - seconds. A lease duration cannot be changed using renew or change. - Default is -1 (infinite lease). Default: -1. - --proposed-lease-id : Proposed lease ID, in a GUID string format. The Blob service returns 400 - (Invalid request) if the proposed lease ID is not in the correct format. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container lease break - -Arguments - --name -n [Required]: The container name. - --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --lease-break-period : This is the proposed duration of seconds that the lease should continue - before it is broken, between 0 and 60 seconds. This break period is only - used if it is shorter than the time remaining on the lease. If longer, - the time remaining on the lease is used. A new lease will not be - available before the break period has expired, but the lease may be held - for longer than the break period. If this header does not appear with a - break operation, a fixed-duration lease breaks after the remaining lease - period elapses, and an infinite lease breaks immediately. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container lease change - -Arguments - --lease-id [Required]: Lease ID for active lease. - --name -n [Required]: The container name. - --proposed-lease-id [Required]: Proposed lease ID, in a GUID string format. The Blob service - returns 400 (Invalid request) if the proposed lease ID is not in - the correct format. - --if-modified-since : Alter only if modified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --if-unmodified-since : Alter only if unmodified since supplied UTC datetime - (Y-m-d'T'H:M'Z'). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container lease release - -Arguments - --lease-id [Required]: Lease ID for active lease. - --name -n [Required]: The container name. - --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container lease renew - -Arguments - --lease-id [Required]: Lease ID for active lease. - --name -n [Required]: The container name. - --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --if-unmodified-since: Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container list - -Arguments - --include-metadata : Specifies that container metadata be returned in the response. - --marker : An opaque continuation token. This value can be retrieved from the - next_marker field of a previous generator object if num_results was - specified and that generator has finished enumerating results. If - specified, this generator will begin returning results from the point where - the previous generator stopped. - --num-results : Specifies the maximum number of containers to return. A single list request - may return up to 1000 contianers and potentially a continuation token which - should be followed to get additional resutls. - --prefix : Filters the results to return only containers whose names begin with the - specified prefix. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container metadata show - -Arguments - --name -n [Required]: The container name. - --lease-id : If specified, get_container_metadata only succeeds if the container's - lease is active and matches this ID. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container metadata update - -Arguments - --name -n [Required]: The container name. - --if-modified-since : Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z'). - --lease-id : If specified, set_container_metadata only succeeds if the container's - lease is active and matches this ID. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container policy create - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The stored access policy name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of - request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container policy delete - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The stored access policy name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container policy list - -Arguments - --container-name -c [Required]: The container name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container policy show - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The stored access policy name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container policy update - -Arguments - --container-name -c [Required]: The container name. - --name -n [Required]: The stored access policy name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of - request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage container show - -Arguments - --name -n [Required]: The container name. - --lease-id : If specified, get_container_properties only succeeds if the container's - lease is active and matches this ID. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage cors add - -Arguments - --methods [Required]: List of HTTP methods allowed to be executed by the origin. Allowed - values: DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT. - --origins [Required]: List of origin domains that will be allowed via CORS, or "*" to allow all - domains. - --services [Required]: The storage service(s) for which to add the CORS rule: (b)lob (f)ile - (q)ueue (t)able. Can be combined. - --allowed-headers : List of response headers allowed to be part of the cross-origin request. - --exposed-headers : List of response headers to expose to CORS clients. - --max-age : The number of seconds the client/browser should cache a preflight - response. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage cors clear - -Arguments - --services [Required]: The storage service(s) for which to clear CORS rules: (b)lob (f)ile - (q)ueue (t)able. Can be combined. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage cors list - -Arguments - --services : Default: bfqt. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage directory create - -Arguments - --name -n [Required]: The directory name. - --share-name -s [Required]: The file share name. - --fail-on-exist : Specify whether to throw an exception when the directory exists. - False by default. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage directory delete - -Arguments - --name -n [Required]: The directory name. - --share-name -s [Required]: The file share name. - --fail-not-exist : Specify whether to throw an exception when the directory doesn't - exist. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage directory exists - -Arguments - --name -n [Required]: The directory name. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage directory metadata show - -Arguments - --name -n [Required]: The directory name. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage directory metadata update - -Arguments - --name -n [Required]: The directory name. - --share-name -s [Required]: The file share name. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage directory show - -Arguments - --name -n [Required]: The directory name. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage entity delete - -Arguments - --partition-key [Required]: The PartitionKey of the entity. - --row-key [Required]: The RowKey of the entity. - --table-name -t [Required]: The name of the table containing the entity to delete. - --if-match : The client may specify the ETag for the entity on the request in - order to compare to the ETag maintained by the service for the - purpose of optimistic concurrency. The delete operation will be - performed only if the ETag sent by the client matches the value - maintained by the server, indicating that the entity has not been - modified since it was retrieved by the client. To force an - unconditional delete, set If-Match to the wildcard character (*). - Default: *. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage entity insert: Insert a new entity into the table. - Inserts a new entity into the table. When inserting an entity into a table, you must specify - values for the PartitionKey and RowKey system properties. Together, these properties form - the primary key and must be unique within the table. Both the PartitionKey and RowKey values - may be up to 64 KB in size. If you are using an integer value as a key, you should convert - the integer to a fixed-width string, because they are canonically sorted. For example, you - should convert the value 1 to 0000001 to ensure proper sorting. - -Arguments - --entity -e [Required]: A space-separated list of key=value pairs. Must contain a - PartitionKey and a RowKey. - --table-name -t [Required]: The name of the table to insert the entity into. - --if-exists : Specify what should happen if an entity already exists for the - specified PartitionKey and RowKey. Allowed values: fail, merge, - replace. Default: fail. - --timeout : The server timeout, expressed in seconds. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage entity merge - -Arguments - --entity -e [Required]: The entity to merge. Could be a dict or an entity object. Must - contain a PartitionKey and a RowKey. - --table-name -t [Required]: The name of the table containing the entity to merge. - --if-match : The client may specify the ETag for the entity on the request in - order to compare to the ETag maintained by the service for the - purpose of optimistic concurrency. The merge operation will be - performed only if the ETag sent by the client matches the value - maintained by the server, indicating that the entity has not been - modified since it was retrieved by the client. To force an - unconditional merge, set If-Match to the wildcard character (*). - Default: *. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage entity query - -Arguments - --table-name -t [Required]: The name of the table to query. - --accept : Specifies the accepted content type of the response payload. See - :class:`~azure.storage.table.models.TablePayloadFormat` for possible - values. Default: application/json;odata=minimalmetadata. - --filter : Returns only entities that satisfy the specified filter. Note that - no more than 15 discrete comparisons are permitted within a $filter - string. See http://msdn.microsoft.com/en- - us/library/windowsazure/dd894031.aspx for more information on - constructing filters. - --marker : An opaque continuation object. This value can be retrieved from the - next_marker field of a previous generator object if max_results was - specified and that generator has finished enumerating results. If - specified, this generator will begin returning results from the - point where the previous generator stopped. - --num-results : The maximum number of entities to return. - --select : Returns only the desired properties of an entity from the set. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage entity replace - -Arguments - --entity -e [Required]: The entity to update. Could be a dict or an entity object. Must - contain a PartitionKey and a RowKey. - --table-name -t [Required]: The name of the table containing the entity to update. - --if-match : The client may specify the ETag for the entity on the request in - order to compare to the ETag maintained by the service for the - purpose of optimistic concurrency. The update operation will be - performed only if the ETag sent by the client matches the value - maintained by the server, indicating that the entity has not been - modified since it was retrieved by the client. To force an - unconditional update, set If-Match to the wildcard character (*). - Default: *. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage entity show - -Arguments - --partition-key [Required]: The PartitionKey of the entity. - --row-key [Required]: The RowKey of the entity. - --table-name -t [Required]: The name of the table to get the entity from. - --accept : Specifies the accepted content type of the response payload. See - :class:`~azure.storage.table.models.TablePayloadFormat` for possible - values. Default: application/json;odata=minimalmetadata. - --select : Returns only the desired properties of an entity from the set. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file copy cancel - -Arguments - --copy-id [Required]: Copy identifier provided in the copy.id of the original - copy_file operation. - --destination-path -p [Required]: The path to the file within the file share. - --destination-share -s [Required]: Name of the destination share. The share must exist. - --timeout : Request timeout in seconds. Applies to each call to the - service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, - jsonc. Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: - AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file copy start - -Arguments - --destination-path -p [Required]: The path to the file within the file share. - --destination-share -s [Required]: Name of the destination share. The share must exist. - --source-uri -u [Required]: A URL of up to 2 KB in length that specifies an Azure file or - blob. The value should be URL-encoded as it would appear in a - request URI. If the source is in another account, the source - must either be public or must be authenticated via a shared - access signature. If the source is public, no authentication - is required. Examples: - https://myaccount.file.core.windows.net/myshare/mydir/myfile - https://otheraccount.file.core.windows.net/myshare/mydir/myfi - le?sastoken. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the - service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, - jsonc. Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: - AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file delete - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file download - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --dest : Path of the file to write to. The source filename will be used if - not specified. - --end-range : End of byte range to use for downloading a section of the file. If - end_range is given, start_range must be provided. The start_range - and end_range params are inclusive. Ex: start_range=0, end_range=511 - will download first 512 bytes of file. - --max-connections : If set to 2 or greater, an initial get will be done for the first - self.MAX_SINGLE_GET_SIZE bytes of the file. If this is the entire - file, the method returns at this point. If it is not, it will - download the remaining data parallel using the number of threads - equal to max_connections. Each chunk will be of size - self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request - will be done. This is not generally recommended but available if - very few threads should be used, network requests are very - expensive, or a non-seekable stream prevents parallel download. This - may also be valuable if the file is being concurrently modified to - enforce atomicity or if many files are expected to be empty as an - extra request is required for empty files if max_connections is - greater than 1. Default: 2. - --max-retries : Number of times to retry download of file chunk if an error occurs. - Default: 5. - --open-mode : Mode to use when opening the file. Note that specifying append only - open_mode prevents parallel download. So, max_connections must be - set to 1 if this open_mode is used. Default: wb. - --retry-wait : Sleep time in secs between retries. Default: 1.0. - --start-range : Start of byte range to use for downloading a section of the file. If - no end_range is given, all bytes after the start_range will be - downloaded. The start_range and end_range params are inclusive. Ex: - start_range=0, end_range=511 will download first 512 bytes of file. - --timeout : Request timeout in seconds. Applies to each call to the service. - --validate-content : If set to true, validates an MD5 hash for each retrieved portion of - the file. This is primarily valuable for detecting bitflips on the - wire if using http instead of https as https (the default) will - already validate. Note that the service will only return - transactional MD5s for chunks 4MB or less so the first get request - will be of size self.MAX_CHUNK_GET_SIZE instead of - self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to - greater than 4MB an error will be thrown. As computing the MD5 takes - processing time and more requests will need to be done due to the - reduced chunk size there may be some increase in latency. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file exists - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file generate-sas - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --cache-control : Response header value for Cache-Control when resource is accessed - using this shared access signature. - --content-disposition : Response header value for Content-Disposition when resource is - accessed using this shared access signature. - --content-encoding : Response header value for Content-Encoding when resource is accessed - using this shared access signature. - --content-language : Response header value for Content-Language when resource is accessed - using this shared access signature. - --content-type : Response header value for Content-Type when resource is accessed - using this shared access signature. - --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - invalid. Do not use if a stored access policy is referenced with - --id that specifies this value. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, - requests from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to - accept requests. Supports only IPv4 style addresses. - --permissions : The permissions the SAS grants. Allowed values: (c)reate (d)elete - (r)ead (w)rite. Do not use if a stored access policy is referenced - with --id that specifies this value. Can be combined. - --policy-name : The name of a stored access policy within the share's ACL. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - valid. Do not use if a stored access policy is referenced with --id - that specifies this value. Defaults to the time of the request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file list - -Arguments - --share-name -s [Required]: The file share name. - --marker : An opaque continuation token. This value can be retrieved from the - next_marker field of a previous generator object if num_results was - specified and that generator has finished enumerating results. If - specified, this generator will begin returning results from the - point where the previous generator stopped. - --num-results : Specifies the maximum number of files to return, including all - directory elements. If the request does not specify num_results or - specifies a value greater than 5,000, the server will return up to - 5,000 items. Setting num_results to a value less than or equal to - zero results in error response code 400 (Bad Request). - --path -p : The directory path within the file share. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file metadata show - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file metadata update - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file resize - -Arguments - --content-length [Required]: The length to resize the file to. - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file show - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file update - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --content-cache-control : The cache control string. - --content-disposition : Conveys additional information about how to process the response - payload, and can also be used to attach additional metadata. - --content-encoding : The content encoding type. - --content-language : The content language. - --content-md5 : The content's MD5 hash. - --content-type : The content MIME type. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file upload - -Arguments - --share-name -s [Required]: The file share name. - --source [Required]: Path of the local file to upload as the file content. - --content-cache-control : The cache control string. - --content-disposition : Conveys additional information about how to process the response - payload, and can also be used to attach additional metadata. - --content-encoding : The content encoding type. - --content-language : The content language. - --content-md5 : The content's MD5 hash. - --content-type : The content MIME type. - --max-connections : Maximum number of parallel connections to use. Default: 2. - --max-retries : Number of times to retry upload of file chunk if an error occurs. - Default: 5. - --metadata : Metadata in space-separated key=value pairs. - --path -p : The path to the file within the file share. If the file name is - omitted, the source file name will be used. - --retry-wait : Sleep time in secs between retries. Default: 1.0. - --timeout : Request timeout in seconds. Applies to each call to the service. - --validate-content : If true, calculates an MD5 hash for each range of the file. The - storage service checks the hash of the content that has arrived with - the hash that was sent. This is primarily valuable for detecting - bitflips on the wire if using http instead of https as https (the - default) will already validate. Note that this MD5 hash is not - stored with the file. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage file url - -Arguments - --path -p [Required]: The path to the file within the file share. - --share-name -s [Required]: The file share name. - --protocol : Protocol to use: 'http' or 'https'. If not specified, uses the - protocol specified when FileService was initialized. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage logging show - -Arguments - --services : The storage services from which to retrieve logging info: (b)lob (q)ueue - (t)able. Can be combined. Default: bqt. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage logging update - -Arguments - --log [Required]: The operations for which to enable logging: (r)ead (w)rite (d)elete. Can - be combined. - --retention [Required]: Number of days for which to retain logs. 0 to disable. - --services [Required]: The storage service(s) for which to update logging info: (b)lob (q)ueue - (t)able. Can be combined. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage message clear - -Arguments - --queue-name -q [Required]: The queue name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage message delete - -Arguments - --id [Required]: The message id identifying the message to delete. - --pop-receipt [Required]: A valid pop receipt value returned from an earlier call to the - :func:`~get_messages` or :func:`~update_message`. - --queue-name -q [Required]: The queue name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage message get - -Arguments - --queue-name -q [Required]: The queue name. - --num-messages : A nonzero integer value that specifies the number of messages to - retrieve from the queue, up to a maximum of 32. If fewer are - visible, the visible messages are returned. By default, a single - message is retrieved from the queue with this operation. - --timeout : Request timeout in seconds. Applies to each call to the service. - --visibility-timeout : Specifies the new visibility timeout value, in seconds, relative to - server time. The new value must be larger than or equal to 1 second, - and cannot be larger than 7 days. The visibility timeout of a - message can be set to a value later than the expiry time. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage message peek - -Arguments - --queue-name -q [Required]: The queue name. - --num-messages : A nonzero integer value that specifies the number of messages to - peek from the queue, up to a maximum of 32. By default, a single - message is peeked from the queue with this operation. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage message put - -Arguments - --content [Required]: Message content. Allowed type is determined by the encode_function - set on the service. Default is str. The encoded message can be up to - 64KB in size. - --queue-name -q [Required]: The queue name. - --time-to-live : Specifies the time-to-live interval for the message, in seconds. The - maximum time-to-live allowed is 7 days. If this parameter is - omitted, the default time-to-live is 7 days. - --timeout : Request timeout in seconds. Applies to each call to the service. - --visibility-timeout : If not specified, the default value is 0. Specifies the new - visibility timeout value, in seconds, relative to server time. The - value must be larger than or equal to 0, and cannot be larger than 7 - days. The visibility timeout of a message cannot be set to a value - later than the expiry time. visibility_timeout should be set to a - value smaller than the time-to-live value. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage message update - -Arguments - --id [Required]: The message id identifying the message to update. - --pop-receipt [Required]: A valid pop receipt value returned from an earlier call to the - :func:`~get_messages` or :func:`~update_message` operation. - --queue-name -q [Required]: The queue name. - --visibility-timeout [Required]: Specifies the new visibility timeout value, in seconds, - relative to server time. The new value must be larger than or - equal to 0, and cannot be larger than 7 days. The visibility - timeout of a message cannot be set to a value later than the - expiry time. A message can be updated until it has been deleted - or has expired. - --content : Message content. Allowed type is determined by the - encode_function set on the service. Default is str. - --timeout : Request timeout in seconds. Applies to each call to the - service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more - information and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction - with storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage metrics show - -Arguments - --interval : Filter the set of metrics to retrieve by time interval. Allowed values: - hour, minute, both. Default: both. - --services : The storage services from which to retrieve metrics info: (b)lob (f)ile - (q)ueue (t)able. Can be combined. Default: bfqt. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage metrics update - -Arguments - --retention [Required]: Number of days for which to retain metrics. 0 to disable. Applies to - both hour and minute metrics if both are specified. - --services [Required]: The storage service(s) for which to update metrics info: (b)lob (f)ile - (q)ueue (t)able. Can be combined. - --api : Specify whether to include API in metrics. Applies to both hour and - minute metrics if both are specified. Must be specified if hour or - minute metrics are enabled and being updated. Allowed values: enable, - disable. - --hour : Update the hourly metrics. Allowed values: enable, disable. - --minute : Update the by-minute metrics. Allowed values: enable, disable. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue create - -Arguments - --name -n [Required]: The queue name. - --fail-on-exist : Specifies whether to throw an exception if the queue already exists. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue delete - -Arguments - --name -n [Required]: The queue name. - --fail-not-exist : Specifies whether to throw an exception if the queue doesn't exist. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue exists - -Arguments - --name -n [Required]: The queue name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue generate-sas - -Arguments - --name -n [Required]: The queue name. - --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - invalid. Do not use if a stored access policy is referenced with --id that - specifies this value. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests - from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to accept - requests. Supports only IPv4 style addresses. - --permissions : The permissions the SAS grants. Allowed values: (a)dd (p)rocess (r)ead - (u)pdate. Do not use if a stored access policy is referenced with --id - that specifies this value. Can be combined. - --policy-name : The name of a stored access policy within the queue's ACL. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - valid. Do not use if a stored access policy is referenced with --id that - specifies this value. Defaults to the time of the request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue list - -Arguments - --include-metadata : Specifies that container metadata be returned in the response. - --marker : An opaque continuation token. This value can be retrieved from the - next_marker field of a previous generator object if num_results was - specified and that generator has finished enumerating results. If - specified, this generator will begin returning results from the point where - the previous generator stopped. - --num-results : The maximum number of queues to return. - --prefix : Filters the results to return only queues with names that begin with the - specified prefix. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue metadata show - -Arguments - --name -n [Required]: The queue name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue metadata update - -Arguments - --name -n [Required]: The queue name. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue policy create - -Arguments - --name -n [Required]: The stored access policy name. - --queue-name -q [Required]: The queue name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Can be combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue policy delete - -Arguments - --name -n [Required]: The stored access policy name. - --queue-name -q [Required]: The queue name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue policy list - -Arguments - --queue-name -q [Required]: The queue name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue policy show - -Arguments - --name -n [Required]: The stored access policy name. - --queue-name -q [Required]: The queue name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue policy update - -Arguments - --name -n [Required]: The stored access policy name. - --queue-name -q [Required]: The queue name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Can be combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage queue stats - -Arguments - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share create - -Arguments - --name -n [Required]: The file share name. - --fail-on-exist : Specify whether to throw an exception when the share exists. False by - default. - --metadata : Metadata in space-separated key=value pairs. - --quota : Specifies the maximum size of the share, in gigabytes. Must be greater - than 0, and less than or equal to 5TB (5120). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share delete - -Arguments - --name -n [Required]: The file share name. - --fail-not-exist : Specify whether to throw an exception when the share doesn't exist. False - by default. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share exists - -Arguments - --name -n [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share generate-sas - -Arguments - --name -n [Required]: The file share name. - --cache-control : Response header value for Cache-Control when resource is accessed using - this shared access signature. - --content-disposition: Response header value for Content-Disposition when resource is accessed - using this shared access signature. - --content-encoding : Response header value for Content-Encoding when resource is accessed - using this shared access signature. - --content-language : Response header value for Content-Language when resource is accessed - using this shared access signature. - --content-type : Response header value for Content-Type when resource is accessed using - this shared access signature. - --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - invalid. Do not use if a stored access policy is referenced with --id - that specifies this value. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests - from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to accept - requests. Supports only IPv4 style addresses. - --permissions : The permissions the SAS grants. Allowed values: (d)elete (l)ist (r)ead - (w)rite. Do not use if a stored access policy is referenced with --id - that specifies this value. Can be combined. - --policy-name : The name of a stored access policy within the share's ACL. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - valid. Do not use if a stored access policy is referenced with --id that - specifies this value. Defaults to the time of the request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share list - -Arguments - --include-metadata : Specifies that share metadata be returned in the response. - --marker : An opaque continuation token. This value can be retrieved from the - next_marker field of a previous generator object if num_results was - specified and that generator has finished enumerating results. If - specified, this generator will begin returning results from the point where - the previous generator stopped. - --num-results : Specifies the maximum number of shares to return. - --prefix : Filters the results to return only shares whose names begin with the - specified prefix. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share metadata show - -Arguments - --name -n [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share metadata update - -Arguments - --name -n [Required]: The file share name. - --metadata : Metadata in space-separated key=value pairs. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share policy create - -Arguments - --name -n [Required]: The stored access policy name. - --share-name -s [Required]: The file share name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share policy delete - -Arguments - --name -n [Required]: The stored access policy name. - --share-name -s [Required]: The file share name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share policy list - -Arguments - --share-name -s [Required]: The file share name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share policy show - -Arguments - --name -n [Required]: The stored access policy name. - --share-name -s [Required]: The file share name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share policy update - -Arguments - --name -n [Required]: The stored access policy name. - --share-name -s [Required]: The file share name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share show - -Arguments - --name -n [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share stats - -Arguments - --name -n [Required]: The file share name. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage share update - -Arguments - --name -n [Required]: The file share name. - --quota [Required]: Specifies the maximum size of the share, in gigabytes. Must be greater - than 0, and less than or equal to 5 TB (5120 GB). - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table batch commit - -Arguments - --batch [Required]: The batch to commit. - --table-name -t [Required]: The name of the table to commit the batch to. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table batch create - -Arguments - --table-name -t [Required]: The name of the table to commit the batch to. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table create - -Arguments - --name -n [Required]: The name of the table to create. The table name may contain only - alphanumeric characters and cannot begin with a numeric character. It is - case-insensitive and must be from 3 to 63 characters long. - --fail-on-exist : Throw an exception if the table already exists. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table delete - -Arguments - --name -n [Required]: The name of the table to delete. - --fail-not-exist : Specifies whether to throw an exception if the table doesn't exist. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table exists - -Arguments - --name -n [Required]: The name of table to check for existence. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table generate-sas - -Arguments - --name -n [Required]: The name of the table to create a SAS token for. - --end-pk : The maximum partition key accessible with this shared access signature. - endpk must accompany endrk. Key values are inclusive. If omitted, there is - no upper bound on the table entities that can be accessed. - --end-rk : The maximum row key accessible with this shared access signature. endpk - must accompany endrk. Key values are inclusive. If omitted, there is no - upper bound on the table entities that can be accessed. - --expiry : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - invalid. Do not use if a stored access policy is referenced with --id that - specifies this value. - --https-only : Only permit requests made with the HTTPS protocol. If omitted, requests - from both the HTTP and HTTPS protocol are permitted. - --ip : Specifies the IP address or range of IP addresses from which to accept - requests. Supports only IPv4 style addresses. - --permissions : The permissions the SAS grants. Allowed values: (r)ead/query (a)dd - (u)pdate (d)elete. Do not use if a stored access policy is referenced with - --id that specifies this value. Can be combined. - --policy-name : The name of a stored access policy within the table's ACL. - --start : Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes - valid. Do not use if a stored access policy is referenced with --id that - specifies this value. Defaults to the time of the request. - --start-pk : The minimum partition key accessible with this shared access signature. - startpk must accompany startrk. Key values are inclusive. If omitted, - there is no lower bound on the table entities that can be accessed. - --start-rk : The minimum row key accessible with this shared access signature. startpk - must accompany startrk. Key values are inclusive. If omitted, there is no - lower bound on the table entities that can be accessed. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account - name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table list - -Arguments - --marker : An opaque continuation object. This value can be retrieved from the - next_marker field of a previous generator object if num_results was - specified and that generator has finished enumerating results. If - specified, this generator will begin returning results from the point where - the previous generator stopped. - --num-results : The maximum number of tables to return. - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table policy create - -Arguments - --name -n [Required]: The stored access policy name. - --table-name -t [Required]: The container name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (r)ead/query (a)dd (u)pdate (d)elete. Can be - combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table policy delete - -Arguments - --name -n [Required]: The stored access policy name. - --table-name -t [Required]: The container name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table policy list - -Arguments - --table-name -t [Required]: The container name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table policy show - -Arguments - --name -n [Required]: The stored access policy name. - --table-name -t [Required]: The container name. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table policy update - -Arguments - --name -n [Required]: The stored access policy name. - --table-name -t [Required]: The container name. - --expiry : Expiration UTC datetime in (Y-m-d'T'H:M'Z'). - --permissions : Allowed values: (r)ead/query (a)dd (u)pdate (d)elete. Can be - combined. - --start : Start UTC datetime (Y-m-d'T'H:M'Z'). Defaults to time of request. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. - Default: json. - --query : JMESPath query string. See http://jmespath.org/ for more information - and examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage - account name. Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either - storage account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string : Storage account connection string. Var: - AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with - storage account name. Var: AZURE_SAS_TOKEN. - -=============================== - -Command - az storage table stats - -Arguments - --timeout : Request timeout in seconds. Applies to each call to the service. - -Global Arguments - --debug : Increase logging verbosity to show all debug logs. - --help -h : Show this help message and exit. - --output -o : Output format. Allowed values: json, tsv, list, table, jsonc. Default: - json. - --query : JMESPath query string. See http://jmespath.org/ for more information and - examples. - --verbose : Increase logging verbosity. Use --debug for full debug logs. - -Storage Account Arguments - --account-key : Storage account key. Must be used in conjunction with storage account name. - Var: AZURE_STORAGE_KEY. - --account-name : Storage account name. Must be used in conjunction with either storage - account key or a SAS token. Var: AZURE_STORAGE_ACCOUNT. - --connection-string: Storage account connection string. Var: AZURE_STORAGE_CONNECTION_STRING. - --sas-token : A Shared Access Signature (SAS). Must be used in conjunction with storage - account name. Var: AZURE_SAS_TOKEN. - -=============================== diff --git a/src/azure/cli/_help.py b/src/azure/cli/_help.py index 932dd7abf66..7fd1e20778b 100644 --- a/src/azure/cli/_help.py +++ b/src/azure/cli/_help.py @@ -13,6 +13,8 @@ __all__ = ['print_detailed_help', 'print_welcome_message', 'GroupHelpFile', 'CommandHelpFile'] +FIRST_LINE_PREFIX = ': ' + def show_help(nouns, parser, is_group): delimiters = ' '.join(nouns) help_file = CommandHelpFile(delimiters, parser) \ @@ -61,7 +63,7 @@ def print_description_list(help_files): for help_file in sorted(help_files, key=lambda h: h.name): _print_indent('{0}{1}{2}'.format(help_file.name, _get_column_indent(help_file.name, max_name_length), - ': ' + help_file.short_summary \ + FIRST_LINE_PREFIX + help_file.short_summary \ if help_file.short_summary \ else ''), indent) @@ -97,13 +99,16 @@ def print_arguments(help_file): print('') print(p.group_name) last_group_name = p.group_name - _print_indent('{0}{1}{2}{3}'.format(p.name, - _get_column_indent(p.name + required_text, - max_name_length), - required_text, - ': ' + short_summary if short_summary else ''), - indent, - max_name_length + indent*4 + 2) + _print_indent( + '{0}{1}{2}{3}'.format( + p.name, + _get_column_indent(p.name + required_text, max_name_length), + required_text, + FIRST_LINE_PREFIX + short_summary if short_summary else '' + ), + indent, + _get_hanging_indent(max_name_length, indent) + ) indent = 2 if p.long_summary: @@ -123,7 +128,7 @@ def _print_header(help_file): indent += 1 _print_indent('{0}{1}'.format('az ' + help_file.command, - ': ' + help_file.short_summary + FIRST_LINE_PREFIX + help_file.short_summary if help_file.short_summary else ''), indent) @@ -138,7 +143,7 @@ def _print_groups(help_file): def _print_items(items): for c in sorted(items, key=lambda h: h.name): column_indent = _get_column_indent(c.name, max_name_length) - summary = ': ' + c.short_summary if c.short_summary else '' + summary = FIRST_LINE_PREFIX + c.short_summary if c.short_summary else '' summary = summary.replace('\n', ' ') hanging_indent = max_name_length + indent*4 + 2 _print_indent( @@ -219,7 +224,6 @@ def load(self, options): self.long_summary = description[description.index('.') + 1:].lstrip() except (ValueError, AttributeError): self.short_summary = description - self.long_summary = None file_data = (_load_help_file_from_string(options.help_file) if hasattr(options, '_defaults') @@ -348,6 +352,9 @@ def __init__(self, _data): self.text = _data['text'] +def _get_hanging_indent(max_length, indent): + return max_length + (indent * 4) + len(FIRST_LINE_PREFIX) + def _print_indent(s, indent=0, subsequent_spaces=-1): tw = textwrap.TextWrapper(initial_indent=' '*indent, subsequent_indent=(' '*indent diff --git a/src/azure/cli/commands/_introspection.py b/src/azure/cli/commands/_introspection.py index 253772fb4f6..c51a9109f28 100644 --- a/src/azure/cli/commands/_introspection.py +++ b/src/azure/cli/commands/_introspection.py @@ -9,10 +9,10 @@ def extract_full_summary_from_signature(operation): """ Extract the summary from the doccomments of the command. """ lines = inspect.getdoc(operation) - regex = re.compile(r'\s*(:param)\s+(.+)\s*:(.*)') + regex = r'\s*(:param)\s+(.+)\s*:(.*)' summary = '' if lines: - match = regex.search(lines) + match = re.search(regex, lines) if match: summary = lines[:match.regs[0][0]] else: From ce044e6d54c1d183d5a41ac9094a281bb96c3e4b Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Wed, 24 Aug 2016 15:47:13 -0700 Subject: [PATCH 5/5] Code review fixes. --- src/azure/cli/_help.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/azure/cli/_help.py b/src/azure/cli/_help.py index 7fd1e20778b..bf5957bf16d 100644 --- a/src/azure/cli/_help.py +++ b/src/azure/cli/_help.py @@ -351,10 +351,6 @@ def __init__(self, _data): self.name = _data['name'] self.text = _data['text'] - -def _get_hanging_indent(max_length, indent): - return max_length + (indent * 4) + len(FIRST_LINE_PREFIX) - def _print_indent(s, indent=0, subsequent_spaces=-1): tw = textwrap.TextWrapper(initial_indent=' '*indent, subsequent_indent=(' '*indent @@ -369,6 +365,9 @@ def _print_indent(s, indent=0, subsequent_spaces=-1): def _get_column_indent(text, max_name_length): return ' '*(max_name_length - len(text)) +def _get_hanging_indent(max_length, indent): + return max_length + (indent * 4) + len(FIRST_LINE_PREFIX) + def _normalize_text(s): if not s or len(s) < 2: return s or ''