diff --git a/MigrationGuideV8toV10.md b/MigrationGuideV8toV10.md new file mode 100644 index 000000000..69a5baddb --- /dev/null +++ b/MigrationGuideV8toV10.md @@ -0,0 +1,146 @@ +# AzCopy Migration Guide for v8 to v10 + +## Purpose + +This migration guide is intended for AzCopy users who are accustomed to the v8 syntax and are seeking to migrate to v10. This article outlines the key differences between these two versions, maps popular AzCopy v8 commands to their equivalent AzCopy v10 commands, and compares the optional parameters. + +## General Usage + +**v8** + +`azcopy /Source: /Dest: [parameters]` + +**v10** + +`azcopy copy '' '' [parameters]` + +**Note** This example shows the `azcopy copy` command, but there are many other commands available to you. To see a complete list, open a command window, and type `azcopy -h`. + +## Authentication + +### Azure Active Directory (Azure AD) + +Use the same command for both v8 and v10. + +```azcopy +azcopy login +``` + +AzCopy encrypts and caches your credentials by using the built-in mechanisms of the operating system. + +### Shared Access Signature (SAS) + +**v8** - Use the appropriate parameter `/SourceSAS:[SAS]` and/or `/DestSAS:[SAS]`. + +```azcopy +azcopy + /Source:https://myaccount.blob.core.windows.net/mycontainer + /Dest:C:\MyFolder + /SourceSAS:[SAS] +``` + +**v10** - Append the SAS token to the source and/or destination URIs. + +```azcopy +azcopy copy + 'https://myaccount.blob.core.windows.net/mycontainer?SAS' + 'C:\MyFolder' +``` + +### Shared Key + +**v8** - Use flag `/SourceKey:[key]` and/or `/DestKey:[key]`. + +**v10** - Use Azure AD or SAS. + +## Common Command Comparisons + +### Download a blob to file + +**v8** + +```azcopy +azcopy + /Source:https://myaccount.blob.core.windows.net/mycontainer/myblob + /Dest:C:\MyFolder + /SourceSAS:[SAS] +``` + +**v10** + +```azcopy +azcopy copy + 'https://myaccount.blob.core.windows.net/mycontainer/myblob?SAS' + 'C:\MyFolder' +``` + +### Download all blobs from a container to directory + +**v8** + +```azcopy +azcopy + /Source:https://myaccount.blob.core.windows.net/mycontainer + /Dest:C:\MyFolder + /SourceSAS:[SAS] + /S +``` + +**v10** + +```azcopy +azcopy copy +'https://.blob.core.windows.net/?' +'C:\myDirectory\' +--recursive +``` + +## Parameters Table + +Task | v8 | v10 +------------ | ------------- | ------------- +Authenticate | `/SourceKey:`
`/DestKey:`
`/SourceSAS:`
`/DestSAS:` | Append the SAS token to the source and/or destination URI.
`'blob URI' + '?' + 'SAS'` +Check log verbosity | `/V:[verbose-log-file]` | `--log-level` +Specify journal file folder (Note: a v10 plan file is similar to a v8 journal file but is not used in the same way) | `/Z:[journal-file-folder]` | Modify environment variable:
`AZCOPY_JOB_PLAN_LOCATION` +Specify parameter file | `/@:` | Run commands in command line +Suppress confirmation prompts | `/Y` | Suppressed by default. To enable, specify parameter: overwrite +Specify number of concurrent operations | `/NC:` | Modify environment variable:
`AZCOPY_CONCURRENCY_VALUE` +Specify source/destination type | `/SourceType: