|
| 1 | +# Migration Guide: From Microsoft.Azure.Storage.DataMovement to Azure.Storage.DataMovement |
| 2 | + |
| 3 | +This guide intends to assist customers in migrating from version 2 of the Azure Storage .NET Data Movement library to version 12. |
| 4 | +It will focus on side-by-side comparisons for similar operations between the v12 package, [`Azure.Storage.DataMovement`](https://www.nuget.org/packages/Azure.Storage.DataMovement) and v2 package, [`Microsoft.Azure.Storage.DataMovement`](https://www.nuget.org/packages/Microsoft.Azure.Storage.DataMovement/). |
| 5 | + |
| 6 | +Familiarity with the legacy data movement client library is assumed. For those new to the Azure Storage Data Movement client library for .NET, please refer to the Quickstart (TODO link) for the v12 library rather than this guide. |
| 7 | + |
| 8 | +## Table of contents |
| 9 | + |
| 10 | +- [Migration benefits](#migration-benefits) |
| 11 | +- [General changes](#general-changes) |
| 12 | + - [Package and namespaces](#package-and-namespaces) |
| 13 | + - [Authentication](#authentication) |
| 14 | + - [Type structure](#type-structure) |
| 15 | +- [Migration samples](#migration-samples) |
| 16 | +- [Additional information](#additional-information) |
| 17 | + |
| 18 | +## Migration benefits |
| 19 | + |
| 20 | +Version 12 of the Data Movemenet library inherits all the benefits of the version 12 storage client libraries, detailed in the next section. In addition, the following are benefits of the new design: |
| 21 | + |
| 22 | +TODO |
| 23 | + |
| 24 | +### Core client libraries |
| 25 | + |
| 26 | +To understand why we created our version 12 client libraries, you may refer to the Tech Community blog post, [Announcing the Azure Storage v12 Client Libraries](https://techcommunity.microsoft.com/t5/azure-storage/announcing-the-azure-storage-v12-client-libraries/ba-p/1482394) or refer to our video [Introducing the New Azure SDKs](https://aka.ms/azsdk/intro). |
| 27 | + |
| 28 | +Included are the following: |
| 29 | +- Thread-safe synchronous and asynchronous APIs |
| 30 | +- Improved performance |
| 31 | +- Consistent and idiomatic code organization, naming, and API structure, aligned with a set of common guidelines |
| 32 | +- The learning curve associated with the libraries was reduced |
| 33 | + |
| 34 | +Note: The blog post linked above announces deprecation for previous versions of the library. |
| 35 | + |
| 36 | +## General changes |
| 37 | + |
| 38 | +### Package and namespaces |
| 39 | + |
| 40 | +Package names and the namespaces root for version 12 Azure client libraries follow the pattern `Azure.[Area].[Service]` where the legacy libraries followed the pattern `Microsoft.Azure.[Area].[Service]`. |
| 41 | + |
| 42 | +In this case, the legacy package was installed with: |
| 43 | +``` |
| 44 | +dotnet add package Microsoft.Azure.Storage.DataMovement |
| 45 | +``` |
| 46 | + |
| 47 | +While version 12 is now installed with: |
| 48 | +``` |
| 49 | +dotnet add package Azure.Storage.DataMovement |
| 50 | +dotnet add package Azure.Storage.DataMovement.Blobs |
| 51 | +``` |
| 52 | + |
| 53 | +Note the separation of the Data Movement package from the Blob Storage Data Movement package. Packages to other storage services can be added or removed from your installation. |
| 54 | + |
| 55 | +### Authentication |
| 56 | + |
| 57 | +#### Azure Active Directory |
| 58 | + |
| 59 | +TODO |
| 60 | + |
| 61 | +You can view more [Identity samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#examples) for how to authenticate with the Identity package. |
| 62 | + |
| 63 | +#### SAS |
| 64 | + |
| 65 | +TODO |
| 66 | + |
| 67 | +#### Shared Key |
| 68 | + |
| 69 | +TODO |
| 70 | + |
| 71 | +### Type Structure |
| 72 | + |
| 73 | +TODO TransferManager changes |
| 74 | + |
| 75 | +TODO StorageResource, Container and Item |
| 76 | + |
| 77 | +TODO Providers |
| 78 | + |
| 79 | +## Migration Samples |
| 80 | + |
| 81 | +TODO |
| 82 | +- Upload |
| 83 | +- Download |
| 84 | +- S2S |
| 85 | +- Progress reporting |
| 86 | +- Error reporting |
| 87 | +- Pause/Resume |
| 88 | + |
| 89 | +## Additional information |
| 90 | + |
| 91 | +### Links and references |
| 92 | +- Quickstart (TODO link) |
| 93 | +- Samples (TODO link) |
| 94 | +- DataMovement reference (TODO link) |
| 95 | +- [Announcing the Azure Storage v12 Client Libraries](https://techcommunity.microsoft.com/t5/azure-storage/announcing-the-azure-storage-v12-client-libraries/ba-p/1482394) blog post |
0 commit comments