Merge pull request #109924 from normesta/normesta-azcopy

Jak-MS · web-flow · commit 164c5bff3546 · 2020-04-10T12:09:07.000-05:00
Changes in support of upcoming AzCopy release
diff --git a/articles/storage/common/storage-ref-azcopy-copy.md b/articles/storage/common/storage-ref-azcopy-copy.md
@@ -4,7 +4,7 @@ description: This article provides reference information for the azcopy copy com
 author: normesta
 ms.service: storage
 ms.topic: reference
-ms.date: 10/16/2019
+ms.date: 04/10/2020
 ms.author: normesta
 ms.subservice: common
 ms.reviewer: zezha-msft
@@ -164,6 +164,8 @@ Copy a subset of buckets by using a wildcard symbol (*) in the bucket name. Like
 
 ## Options
 
+**--backup**                               Activates Windows' SeBackupPrivilege for uploads, or SeRestorePrivilege for downloads, to allow AzCopy to see read all files, regardless of their file system permissions, and to restore all permissions. Requires that the account running AzCopy already has these permissions (e.g. has administrator rights or is a member of the 'Backup Operators' group). All this flag does is activate privileges that the account already has.
+
 **--blob-type** string                     Defines the type of blob at the destination. This is used for uploading blobs and when copying between accounts (default 'Detect'). Valid values include 'Detect', 'BlockBlob', 'PageBlob', and 'AppendBlob'. When copying between accounts, a value of 'Detect' causes AzCopy to use the type of source blob to determine the type of the destination blob. When uploading a file, 'Detect' determines if the file is a VHD or a VHDX file based on the file extension. If the file is ether a VHD or VHDX file, AzCopy treats the file as a page blob. (default "Detect")
 
 **--block-blob-tier** string               Upload block blobs directly to the [access tier](../blobs/storage-blob-storage-tiers.md) of your choice. (default 'None'). Valid values include 'None', 'Hot', 'Cool', and 'Archive'. If 'None' or no tier is passed, the blob will inherit the tier of the storage account.
@@ -218,6 +220,12 @@ Copy a subset of buckets by using a wildcard symbol (*) in the bucket name. Like
 
 **--preserve-last-modified-time**          Only available when destination is file system.
 
+**--preserve-smb-permissions** string      False by default. Preserves SMB ACLs between aware resources (Windows and Azure Files). For downloads, you will also need to use the `--backup` flag to restore permissions where the new Owner will not be the user that is running AzCopy. This flag applies to both files and folders, unless a file-only filter is specified (e.g. `include-pattern`).
+
+**--preserve-smb-info** string             False by default. Preserves SMB property info (last write time, creation time, attribute bits) between SMB-aware resources (Windows and Azure Files). Only the attribute bits supported by Azure Files will be transferred; any others will be ignored. This flag applies to both files and folders, unless a file-only filter is specified (e.g. include-pattern). The information transferred for folders is the same as that for files, except for Last Write Time which is never preserved for folders.
+
+**--preserve-owner**                       Only has an effect in when downloading data, and only when the `--preserve-smb-permissions` is used. If true (the default), the file Owner and Group are preserved in downloads. If this flag is set to false, `--preserve-smb-permissions` will still preserve ACLs but Owner and Group will be based on the user that is running AzCopy.
+
 **--put-md5**                             Create an MD5 hash of each file, and save the hash as the Content-MD5 property of the destination blob or file. (By default the hash is NOT created.) Only available when uploading.
 
 **--recursive**                            Look into sub-directories recursively when uploading from local file system.
diff --git a/articles/storage/common/storage-use-azcopy-blobs.md b/articles/storage/common/storage-use-azcopy-blobs.md
@@ -4,7 +4,7 @@ description: This article contains a collection of AzCopy example commands that
 author: normesta
 ms.service: storage
 ms.topic: conceptual
-ms.date: 10/22/2019
+ms.date: 04/10/2020
 ms.author: normesta
 ms.subservice: common
 ms.reviewer: dineshm
@@ -14,6 +14,9 @@ ms.reviewer: dineshm
 
 AzCopy is a command-line utility that you can use to copy data to, from, or between storage accounts. This article contains example commands that work with Blob storage.
 
+> [!TIP]
+> The examples in this article enclose path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
+
 ## Get started
 
 See the [Get started with AzCopy](storage-use-azcopy-v10.md) article to download AzCopy and learn about the ways that you can provide authorization credentials to the storage service.
@@ -27,9 +30,6 @@ See the [Get started with AzCopy](storage-use-azcopy-v10.md) article to download
 
 ## Create a container
 
-> [!TIP]
-> The examples in this section enclose path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
-
 You can use the [azcopy make](storage-ref-azcopy-make.md) command to create a container. The examples in this section create a container named `mycontainer`.
 
 |    |     |
@@ -52,10 +52,16 @@ This section contains the following examples:
 > * Upload the contents of a directory 
 > * Upload specific files
 
-For detailed reference docs, see [azcopy copy](storage-ref-azcopy-copy.md).
-
 > [!TIP]
-> The examples in this section enclose path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
+> You can tweak your upload operation by using optional flags. Here's a few examples.
+>
+> |Scenario|Flag|
+> |---|---|
+> |Upload files as Append Blobs or Page Blobs.|**--blob-type**=\[BlockBlob\|PageBlob\|AppendBlob\]|
+> |Upload to a specific access tier (such as the archive tier).|**--block-blob-tier**=\[None\|Hot\|Cool\|Archive\]|
+> |Automatically decompress files.|**--decompress**=\[gzip\|deflate\]|
+> 
+> For a complete list, see [options](storage-ref-azcopy-copy.md#options).
 
 ### Upload a file
 
@@ -67,10 +73,6 @@ For detailed reference docs, see [azcopy copy](storage-ref-azcopy-copy.md).
 
 You can also upload a file by using a wildcard symbol (*) anywhere in the file path or file name. For example: `'C:\myDirectory\*.txt'`, or `C:\my*\*.txt`.
 
-> [!NOTE]
-> AzCopy by default uploads data as block blobs. To upload files as Append Blobs or Page Blobs, use the flag `--blob-type=[BlockBlob|PageBlob|AppendBlob]`.
-> AzCopy by default uploads your data to inherit the account access tier. To upload files to a specific [access tier](../blobs/storage-blob-storage-tiers.md), use the flag `--block-blob-tier=[Hot|Cool|Archive]`.
-
 ### Upload a directory
 
 This example copies a directory (and all of the files in that directory) to a blob container. The result is a directory in the container by the same name.
@@ -147,14 +149,20 @@ This section contains the following examples:
 > * Download the contents of a directory
 > * Download specific files
 
+> [!TIP]
+> You can tweak your download operation by using optional flags. Here's a few examples.
+>
+> |Scenario|Flag|
+> |---|---|
+> |Automatically decompress files.|**--decompress**=\[gzip\|deflate\]|
+> |Specify how detailed you want your copy-related log entries to be.|**--log-level**=\[WARNING\|ERROR\|INFO\|NONE\]|
+> |Specify if and how to overwrite the conflicting files and blobs at the destination.|**--overwrite**=\[true\|false\|ifSourceNewer\|prompt\]|
+> 
+> For a complete list, see [options](storage-ref-azcopy-copy.md#options).
+
 > [!NOTE]
 > If the `Content-md5` property value of a blob contains a hash, AzCopy calculates an MD5 hash for downloaded data and verifies that the MD5 hash stored in the blob's `Content-md5` property matches the calculated hash. If these values don't match, the download fails unless you override this behavior by appending `--check-md5=NoCheck` or `--check-md5=LogOnly` to the copy command.
 
-For detailed reference docs, see [azcopy copy](storage-ref-azcopy-copy.md).
-
-> [!TIP]
-> The examples in this section enclose path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
-
 ### Download a file
 
 |    |     |
@@ -240,12 +248,18 @@ This section contains the following examples:
 > * Copy a container to another storage account
 > * Copy all containers, directories, and files to another storage account
 
-For detailed reference docs, see [azcopy copy](storage-ref-azcopy-copy.md).
+These examples also work with accounts that have a hierarchical namespace. [Multi-protocol access on Data Lake Storage](../blobs/data-lake-storage-multi-protocol-access.md) enables you to use the same URL syntax (`blob.core.windows.net`) on those accounts.
 
 > [!TIP]
-> The examples in this section enclose path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
-
- These examples also work with accounts that have a hierarchical namespace. [Multi-protocol access on Data Lake Storage](../blobs/data-lake-storage-multi-protocol-access.md) enables you to use the same URL syntax (`blob.core.windows.net`) on those accounts. 
+> You can tweak your copy operation by using optional flags. Here's a few examples.
+>
+> |Scenario|Flag|
+> |---|---|
+> |Copy files as Append Blobs or Page Blobs.|**--blob-type**=\[BlockBlob\|PageBlob\|AppendBlob\]|
+> |Copy to a specific access tier (such as the archive tier).|**--block-blob-tier**=\[None\|Hot\|Cool\|Archive\]|
+> |Automatically decompress files.|**--decompress**=\[gzip\|deflate\]|
+> 
+> For a complete list, see [options](storage-ref-azcopy-copy.md#options).
 
 ### Copy a blob to another storage account
 
@@ -301,10 +315,16 @@ If you set the `--delete-destination` flag to `true` AzCopy deletes files withou
 > [!NOTE]
 > To prevent accidental deletions, make sure to enable the [soft delete](https://docs.microsoft.com/azure/storage/blobs/storage-blob-soft-delete) feature before you use the `--delete-destination=prompt|true` flag.
 
-For detailed reference docs, see [azcopy sync](storage-ref-azcopy-sync.md).
-
 > [!TIP]
-> The examples in this section enclose path arguments with single quotes (''). Use single quotes in all command shells except for the Windows Command Shell (cmd.exe). If you're using a Windows Command Shell (cmd.exe), enclose path arguments with double quotes ("") instead of single quotes ('').
+> You can tweak your sync operation by using optional flags. Here's a few examples.
+>
+> |Scenario|Flag|
+> |---|---|
+> |Specify how strictly MD5 hashes should be validated when downloading.|**--check-md5**=\[NoCheck\|LogOnly\|FailIfDifferent\|FailIfDifferentOrMissing\]|
+> |Exclude files based on a pattern.|**--exclude-path**|
+> |Specify how detailed you want your sync-related log entries to be.|**--log-level**=\[WARNING\|ERROR\|INFO\|NONE\]|
+> 
+> For a complete list, see [options](storage-ref-azcopy-sync.md#options).
 
 ### Update a container with changes to a local file system
 
diff --git a/articles/storage/common/storage-use-azcopy-configure.md b/articles/storage/common/storage-use-azcopy-configure.md
@@ -4,7 +4,7 @@ description: Configure, optimize, and troubleshoot AzCopy.
 author: normesta
 ms.service: storage
 ms.topic: conceptual
-ms.date: 01/28/2020
+ms.date: 04/10/2020
 ms.author: normesta
 ms.subservice: common
 ms.reviewer: dineshm
@@ -49,9 +49,6 @@ This section helps you perform these optimization tasks:
 
 You can run a performance benchmark test on specific blob containers to view general performance statistics and to identity performance bottlenecks. 
 
-> [!NOTE]
-> In the current release, this feature is available only for Blob Storage containers.
-
 Use the following command to run a performance benchmark test.
 
 |    |     |
diff --git a/articles/storage/common/storage-use-azcopy-files.md b/articles/storage/common/storage-use-azcopy-files.md
