Skip to content

Commit 4601848

Browse files
Library updates
1 parent e1596c9 commit 4601848

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

articles/storage/common/storage-use-data-movement-library.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: pauljewellmsft
77

88
ms.service: azure-storage
99
ms.topic: how-to
10-
ms.date: 01/31/2025
10+
ms.date: 02/11/2025
1111
ms.author: pauljewell
1212
ms.subservice: storage-common-concepts
1313
ms.devlang: csharp
@@ -18,7 +18,9 @@ ms.custom: devx-track-csharp, devx-track-dotnet
1818

1919
The Azure Storage Data Movement library is a cross-platform open source library that is designed for high performance uploading, downloading, and copying of blobs and files. The Data Movement library provides convenient methods that aren't available in the Azure Storage client library for .NET. These methods allow you to set the number of parallel operations, track transfer progress, resume a canceled transfer, and more.
2020

21-
The Data Movement library is only available for .NET, and only supports Azure Blob Storage and Azure Files.
21+
The Data Movement library is only available for .NET, and only supports Azure Blob Storage and Azure Files. You should consider these limitations and other [known issues](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md#known-issues) when deciding whether to use the Data Movement library.
22+
23+
If you're migrating code from the older **Microsoft.Azure.Storage.DataMovement** library (version 2.X.X) to the current **Azure.Storage.DataMovement** library (version 12.X.X), see the [Migration guide](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.DataMovement/MigrationGuide.md#migration-guide-from-microsoftazurestoragedatamovement-to-azurestoragedatamovement).
2224

2325
[API reference docs](/dotnet/api/azure.storage.datamovement) | [Source code](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.DataMovement) | [Package (NuGet)](https://www.nuget.org/packages/Azure.Storage.DataMovement) | Samples: [Blobs](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.DataMovement.Blobs/samples) / [Files](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.DataMovement.Files.Shares/samples)
2426

@@ -34,7 +36,7 @@ If you don't have an existing project, this section shows you how to set up a pr
3436

3537
#### Install packages
3638

37-
From your project directory, install packages for the Azure Storage Data Movement client library and the Azure Identity client library using the `dotnet add package` command. The Azure.Identity package is needed for passwordless connections to Azure services.
39+
From your project directory, install packages for the Azure Storage Data Movement client library and the Azure Identity client library using the `dotnet add package` command. The **Azure.Identity** package is needed for passwordless connections to Azure services.
3840

3941
```dotnetcli
4042
dotnet add package Azure.Storage.DataMovement
@@ -243,7 +245,7 @@ To resume a transfer, call the following method:
243245

244246
- [TransferManager.ResumeTransferAsync](/dotnet/api/azure.storage.datamovement.transfermanager.resumetransferasync)
245247

246-
Provide the transfer ID of the transfer that you want to resume. The transfer ID is a unique identifier for the transfer that's returned as part of the `TransferOperation` object when the transfer is started. If you don't know the transfer ID value, you can call [TransferManager.GetTransfersAsync](/dotnet/api/azure.storage.datamovement.transfermanager.gettransfersasync) to find the transfer and it's corresponding ID.
248+
Provide the transfer ID of the transfer that you want to resume. The transfer ID is a unique identifier for the transfer that's returned as part of the `TransferOperation` object when the transfer is started. If you don't know the transfer ID value, you can call [TransferManager.GetTransfersAsync](/dotnet/api/azure.storage.datamovement.transfermanager.gettransfersasync) to find the transfer and its corresponding ID.
247249

248250
The following code example shows how to resume a transfer:
249251

@@ -279,7 +281,7 @@ The `TransferStatus` property returns a [TransferStatus](/dotnet/api/azure.stora
279281

280282
| Property | Type | Description |
281283
| --- | --- | --- |
282-
| `HasCompletedSuccessfully` | Boolean | Represents if the transfer has completed successfully without any failure or skipped items. |
284+
| `HasCompletedSuccessfully` | Boolean | Represents if the transfer completes successfully without any failure or skipped items. |
283285
| `HasFailedItems` | Boolean | Represents if transfer has any failure items. If set to `true`, the transfer has at least one failure item. If set to `false`, the transfer currently has no failures. |
284286
| `HasSkippedItems` | Boolean | Represents if transfer has any skipped items. If set to `true`, the transfer has at least one skipped item. If set to `false`, the transfer currently has no skipped items. It's possible to never have any items skipped if `SkipIfExists` isn't enabled in [TransferOptions.CreationPreference](/dotnet/api/azure.storage.datamovement.transferoptions.creationpreference). |
285287
| `State` | [TransferState](/dotnet/api/azure.storage.datamovement.transferstate) | Defines the types of the state a transfer can have. See [TransferState](/dotnet/api/azure.storage.datamovement.transferstate) for details. |
@@ -329,18 +331,18 @@ BlobServiceClient client = new BlobServiceClient(
329331
BlobContainerClient containerClient = client.GetBlobContainerClient("sample-container");
330332
```
331333

332-
The following code example shows how to upload local directory contents to `sample-container` using `StartUploadDirectoryAsync`:
334+
The following code example shows how to upload local directory contents to `sample-container` using `UploadDirectoryAsync`:
333335

334336
```csharp
335-
TransferOperation transfer = await containerClient.StartUploadDirectoryAsync("local/directory/path");
337+
TransferOperation transfer = await containerClient.UploadDirectoryAsync("local/directory/path");
336338

337339
await transfer.WaitForCompletionAsync();
338340
```
339341

340-
The following code example shows how to download the contents of `sample-container` to a local directory using `StartDownloadDirectoryAsync`:
342+
The following code example shows how to download the contents of `sample-container` to a local directory using `DownloadDirectoryAsync`:
341343

342344
```csharp
343-
TransferOperation transfer = await containerClient.StartDownloadToDirectoryAsync("local/directory/path");
345+
TransferOperation transfer = await containerClient.DownloadToDirectoryAsync("local/directory/path");
344346

345347
await transfer.WaitForCompletionAsync();
346348
```

0 commit comments

Comments
 (0)