[Storage] [DataMovement] Renamed API from API Arch Board Feedback

sdk/storage/Azure.Storage.DataMovement.Blobs/CHANGELOG.md

@@ -21,6 +21,11 @@
     - `*BlobStorageResource.GetPropertiesAsync`
     - `*BlobStorageResource.ReadStreamAsync`
     - `*BlobStorageResource.WriteFromStreamAsync`
+- [BREAKING CHANGE] Renamed `BlobStorageResourceProvider.MakeResourceAsync` to `BlobStorageResourceProvider.CreateResourceAsync`
+- [BREAKING CHANGE] Renamed `BlobStorageResourceContainerOptions.DirectoryPrefix` to `BlobDirectoryPrefix`
+- [BREAKING CHANGE] Renamed `BlobStorageResourceContainerOptions.ResourceOptions` to `BlobOptions`
+- [BREAKING CHANGE] Moved `BlobContainerClientTransferOptions` to the `Azure.Storage.DataMovement.Blobs` namespace
+
 ### Bugs Fixed
 
 ### Other Changes

sdk/storage/Azure.Storage.DataMovement.Blobs/README.md

@@ -97,11 +97,11 @@ BlobContainerClientTransferOptions options = new BlobContainerClientTransferOpti
 {
     BlobContainerOptions = new BlobStorageResourceContainerOptions
     {
-        DirectoryPrefix = blobDirectoryPrefix
+        BlobDirectoryPrefix = blobDirectoryPrefix
     },
-    TransferOptions = new TransferOptions()
+    TransferOptions = new DataTransferOptions()
     {
-        CreateMode = StorageResourceCreateMode.Overwrite,
+        CreationPreference = StorageResourceCreationPreference.OverwriteIfExists,
     }
 };
 
@@ -130,11 +130,11 @@ BlobContainerClientTransferOptions options = new BlobContainerClientTransferOpti
 {
     BlobContainerOptions = new BlobStorageResourceContainerOptions
     {
-        DirectoryPrefix = blobDirectoryPrefix
+        BlobDirectoryPrefix = blobDirectoryPrefix
     },
-    TransferOptions = new TransferOptions()
+    TransferOptions = new DataTransferOptions()
     {
-        CreateMode = StorageResourceCreateMode.Overwrite,
+        CreationPreference = StorageResourceCreationPreference.OverwriteIfExists,
     }
 };
 
@@ -159,7 +159,7 @@ Blob `StorageResource` objects can be constructed with optional "options" argume
 ```C# Snippet:ResourceConstruction_Blobs_WithOptions_VirtualDirectory
 BlobStorageResourceContainerOptions virtualDirectoryOptions = new()
 {
-    DirectoryPrefix = "blob/directory/prefix"
+    BlobDirectoryPrefix = "blob/directory/prefix"
 };
 
 StorageResource virtualDirectoryResource = new BlobStorageResourceContainer(
@@ -190,9 +190,9 @@ if (BlobStorageResources.TryGetResourceProviders(
     out BlobStorageResourceProvider blobSrcProvider,
     out BlobStorageResourceProvider blobDstProvider))
 {
-    sourceResource ??= await blobSrcProvider?.MakeResourceAsync(
+    sourceResource ??= await blobSrcProvider?.CreateResourceAsync(
         GenerateMySasCredential(info.SourcePath));
-    destinationResource ??= await blobSrcProvider?.MakeResourceAsync(
+    destinationResource ??= await blobSrcProvider?.CreateResourceAsync(
         GenerateMySasCredential(info.DestinationPath));
 }
 ```
@@ -221,7 +221,7 @@ DataTransfer dataTransfer = await transferManager.StartTransferAsync(
         {
             // Block blobs are the default if not specified
             BlobType = BlobType.Block,
-            DirectoryPrefix = optionalDestinationPrefix,
+            BlobDirectoryPrefix = optionalDestinationPrefix,
         }),
     transferOptions: options);
 await dataTransfer.WaitForCompletionAsync();
@@ -248,7 +248,7 @@ DataTransfer dataTransfer = await transferManager.StartTransferAsync(
         blobContainerClient,
         new BlobStorageResourceContainerOptions()
         {
-            DirectoryPrefix = optionalSourcePrefix
+            BlobDirectoryPrefix = optionalSourcePrefix
         }),
     destinationResource: new LocalDirectoryStorageResourceContainer(downloadPath));
 await dataTransfer.WaitForCompletionAsync();
@@ -275,7 +275,7 @@ DataTransfer dataTransfer = await transferManager.StartTransferAsync(
         sourceContainer,
         new BlobStorageResourceContainerOptions()
         {
-            DirectoryPrefix = sourceDirectoryName
+            BlobDirectoryPrefix = sourceDirectoryName
         }),
     destinationResource: new BlobStorageResourceContainer(
         destinationContainer,
@@ -284,7 +284,7 @@ DataTransfer dataTransfer = await transferManager.StartTransferAsync(
             // all source blobs will be copied as a single type of destination blob
             // defaults to block blobs if unspecified
             BlobType = BlobType.Block,
-            DirectoryPrefix = downloadPath
+            BlobDirectoryPrefix = downloadPath
         }));
 ```
 

sdk/storage/Azure.Storage.DataMovement.Blobs/samples/Sample01b_HelloWorldAsync.cs

@@ -65,7 +65,7 @@ public async Task ResourceConstructionDemonstration()
                 #region Snippet:ResourceConstruction_Blobs_WithOptions_VirtualDirectory
                 BlobStorageResourceContainerOptions virtualDirectoryOptions = new()
                 {
-                    DirectoryPrefix = "blob/directory/prefix"
+                    BlobDirectoryPrefix = "blob/directory/prefix"
                 };
 
                 StorageResource virtualDirectoryResource = new BlobStorageResourceContainer(
@@ -161,7 +161,7 @@ public async Task RehydrateBlobResource_SasAsync()
                 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
                     sourceResource: source,
                     destinationResource: destination);
-                await dataTransfer.PauseIfRunningAsync();
+                await dataTransfer.PauseAsync();
 
                 DataTransferProperties info = await transferManager.GetResumableTransfersAsync().FirstAsync();
 
@@ -181,9 +181,9 @@ AzureSasCredential GenerateMySasCredential(string blobUri)
                     out BlobStorageResourceProvider blobSrcProvider,
                     out BlobStorageResourceProvider blobDstProvider))
                 {
-                    sourceResource ??= await blobSrcProvider?.MakeResourceAsync(
+                    sourceResource ??= await blobSrcProvider?.CreateResourceAsync(
                         GenerateMySasCredential(info.SourcePath));
-                    destinationResource ??= await blobSrcProvider?.MakeResourceAsync(
+                    destinationResource ??= await blobSrcProvider?.CreateResourceAsync(
                         GenerateMySasCredential(info.DestinationPath));
                 }
                 #endregion
@@ -249,7 +249,7 @@ public async Task DownloadSingle_SharedKeyAuthAsync()
                 // Create Blob Data Controller to skip through all failures
                 TransferManagerOptions options = new TransferManagerOptions()
                 {
-                    ErrorHandling = ErrorHandlingBehavior.ContinueOnFailure
+                    ErrorHandling = DataTransferErrorMode.ContinueOnFailure
                 };
                 TransferManager transferManager = new TransferManager(options);
 
@@ -340,14 +340,14 @@ public async Task UploadDirectory_SasAsync()
                 // Get a storage resource to a destination blob directory
                 StorageResourceContainer directoryDestination = new BlobStorageResourceContainer(
                     blobContainerClient,
-                    new BlobStorageResourceContainerOptions() { DirectoryPrefix = "sample-directory" });
+                    new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-directory" });
 
                 // Create BlobTransferManager with event handler in Options bag
                 TransferManagerOptions transferManagerOptions = new TransferManagerOptions();
-                TransferOptions options = new TransferOptions()
+                DataTransferOptions options = new DataTransferOptions()
                 {
                     MaximumTransferChunkSize = 4 * Constants.MB,
-                    CreateMode = StorageResourceCreateMode.Overwrite,
+                    CreationPreference = StorageResourceCreationPreference.OverwriteIfExists,
                 };
                 TransferManager transferManager = new TransferManager(transferManagerOptions);
 
@@ -362,7 +362,7 @@ public async Task UploadDirectory_SasAsync()
                         {
                             // Block blobs are the default if not specified
                             BlobType = BlobType.Block,
-                            DirectoryPrefix = optionalDestinationPrefix,
+                            BlobDirectoryPrefix = optionalDestinationPrefix,
                         }),
                     transferOptions: options);
                 await dataTransfer.WaitForCompletionAsync();
@@ -437,8 +437,8 @@ public async Task UploadDirectory_CompletedEventHandler()
             {
                 // Create BlobTransferManager with event handler in Options bag
                 TransferManagerOptions options = new TransferManagerOptions();
-                TransferOptions transferOptions = new TransferOptions();
-                transferOptions.SingleTransferCompleted += (SingleTransferCompletedEventArgs args) =>
+                DataTransferOptions transferOptions = new DataTransferOptions();
+                transferOptions.ItemTransferCompleted += (TransferItemCompletedEventArgs args) =>
                 {
                     using (StreamWriter logStream = File.AppendText(logFile))
                     {
@@ -453,7 +453,7 @@ public async Task UploadDirectory_CompletedEventHandler()
                     new LocalDirectoryStorageResourceContainer(sourcePath),
                     new BlobStorageResourceContainer(
                         container,
-                        new BlobStorageResourceContainerOptions() { DirectoryPrefix = "sample-blob-directory" }));
+                        new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory" }));
             }
             finally
             {
@@ -524,10 +524,10 @@ public async Task UploadDirectory_EventHandler_SasAsync()
             {
                 // Create BlobTransferManager with event handler in Options bag
                 TransferManagerOptions options = new TransferManagerOptions();
-                TransferOptions transferOptions = new TransferOptions();
-                transferOptions.TransferStatus += (TransferStatusEventArgs args) =>
+                DataTransferOptions transferOptions = new DataTransferOptions();
+                transferOptions.TransferStatusChanged += (TransferStatusEventArgs args) =>
                 {
-                    if (args.StorageTransferStatus == StorageTransferStatus.Completed)
+                    if (args.StorageTransferStatus == DataTransferStatus.Completed)
                     {
                         using (StreamWriter logStream = File.AppendText(logFile))
                         {
@@ -536,7 +536,7 @@ public async Task UploadDirectory_EventHandler_SasAsync()
                     }
                     return Task.CompletedTask;
                 };
-                transferOptions.TransferFailed += (TransferFailedEventArgs args) =>
+                transferOptions.ItemTransferFailed += (TransferItemFailedEventArgs args) =>
                 {
                     using (StreamWriter logStream = File.AppendText(logFile))
                     {
@@ -556,7 +556,7 @@ public async Task UploadDirectory_EventHandler_SasAsync()
                     new LocalDirectoryStorageResourceContainer(sourcePath),
                     new BlobStorageResourceContainer(
                         container,
-                        new BlobStorageResourceContainerOptions() { DirectoryPrefix = "sample-blob-directory" }));
+                        new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory" }));
             }
             finally
             {
@@ -609,9 +609,9 @@ public async Task DownloadDirectory_EventHandler_ActiveDirectoryAuthAsync()
             {
                 // Get a reference to a source blobs and upload sample content to download
                 StorageResourceContainer sourceDirectory = new BlobStorageResourceContainer(blobContainerClient,
-                    new BlobStorageResourceContainerOptions() { DirectoryPrefix = "sample-blob-directory" });
+                    new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory" });
                 StorageResourceContainer sourceDirectory2 = new BlobStorageResourceContainer(blobContainerClient,
-                    new BlobStorageResourceContainerOptions() { DirectoryPrefix = "sample-blob-directory2" });
+                    new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory2" });
                 StorageResourceContainer destinationDirectory = new LocalDirectoryStorageResourceContainer(downloadPath);
                 StorageResourceContainer destinationDirectory2 = new LocalDirectoryStorageResourceContainer(downloadPath2);
 
@@ -624,8 +624,8 @@ public async Task DownloadDirectory_EventHandler_ActiveDirectoryAuthAsync()
 
                 // Create BlobTransferManager with event handler in Options bag
                 TransferManagerOptions options = new TransferManagerOptions();
-                TransferOptions downloadOptions = new TransferOptions();
-                downloadOptions.TransferFailed += async (TransferFailedEventArgs args) =>
+                DataTransferOptions downloadOptions = new DataTransferOptions();
+                downloadOptions.ItemTransferFailed += async (TransferItemFailedEventArgs args) =>
                 {
                     // Log Exception Message
                     Console.WriteLine(args.Exception.Message);
@@ -646,7 +646,7 @@ await transferManager.StartTransferAsync(
                         blobContainerClient,
                         new BlobStorageResourceContainerOptions()
                         {
-                            DirectoryPrefix = optionalSourcePrefix
+                            BlobDirectoryPrefix = optionalSourcePrefix
                         }),
                     destinationResource: new LocalDirectoryStorageResourceContainer(downloadPath));
                 await dataTransfer.WaitForCompletionAsync();
@@ -713,7 +713,7 @@ public async Task CopySingle_ConnectionStringAsync()
                 #endregion
 
                 Assert.IsTrue(await destinationAppendBlobClient.ExistsAsync());
-                Assert.AreEqual(dataTransfer.TransferStatus, StorageTransferStatus.Completed);
+                Assert.AreEqual(dataTransfer.TransferStatus, DataTransferStatus.Completed);
             }
             finally
             {
@@ -767,9 +767,9 @@ public async Task CopyDirectory()
 
                 // Get a reference to a source blobs and upload sample content to download
                 StorageResourceContainer sourceDirectory1 = new BlobStorageResourceContainer(container,
-                    new BlobStorageResourceContainerOptions() { DirectoryPrefix = sourceDirectoryName });
+                    new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = sourceDirectoryName });
                 StorageResourceContainer sourceDirectory2 = new BlobStorageResourceContainer(container,
-                    new BlobStorageResourceContainerOptions() { DirectoryPrefix = sourceDirectoryName2 });
+                    new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = sourceDirectoryName2 });
 
                 // Create destination paths
                 StorageResourceContainer destinationDirectory1 = new LocalDirectoryStorageResourceContainer(downloadPath);
@@ -786,8 +786,8 @@ public async Task CopyDirectory()
                 // Create Blob Transfer Manager
                 TransferManager transferManager = new TransferManager(default);
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
-                TransferOptions options = new TransferOptions();
-                options.TransferFailed += async (TransferFailedEventArgs args) =>
+                DataTransferOptions options = new DataTransferOptions();
+                options.ItemTransferFailed += async (TransferItemFailedEventArgs args) =>
                 {
                     //await LogFailedFileAsync(args.SourceFileUri, args.DestinationFileClient.Uri, args.Exception.Message);
                 };
@@ -802,7 +802,7 @@ public async Task CopyDirectory()
                         sourceContainer,
                         new BlobStorageResourceContainerOptions()
                         {
-                            DirectoryPrefix = sourceDirectoryName
+                            BlobDirectoryPrefix = sourceDirectoryName
                         }),
                     destinationResource: new BlobStorageResourceContainer(
                         destinationContainer,
@@ -811,7 +811,7 @@ public async Task CopyDirectory()
                             // all source blobs will be copied as a single type of destination blob
                             // defaults to block blobs if unspecified
                             BlobType = BlobType.Block,
-                            DirectoryPrefix = downloadPath
+                            BlobDirectoryPrefix = downloadPath
                         }));
                 #endregion
             }
@@ -878,8 +878,8 @@ StorageSharedKeyCredential GetMyCredential(string uri)
                         out LocalStorageResourceProvider localSrcProvider,
                         out LocalStorageResourceProvider localDstProvider))
                     {
-                        sourceResource ??= localSrcProvider.MakeResource();
-                        destinationResource ??= localDstProvider.MakeResource();
+                        sourceResource ??= localSrcProvider.CreateResource();
+                        destinationResource ??= localDstProvider.CreateResource();
                     }
                     return (sourceResource, destinationResource);
                 }
@@ -942,7 +942,7 @@ public async Task PauseAndResumeAsync_DataTransferPause()
                     destinationResource: destinationResource);
 
                 // Pause from the DataTransfer object
-                await dataTransfer.PauseIfRunningAsync();
+                await dataTransfer.PauseAsync();
 
                 DataTransfer resumedTransfer = await transferManager.ResumeTransferAsync(
                     transferId: dataTransfer.Id,
@@ -1007,11 +1007,11 @@ public async Task UploadDirectory()
                     {
                         BlobContainerOptions = new BlobStorageResourceContainerOptions
                         {
-                            DirectoryPrefix = blobDirectoryPrefix
+                            BlobDirectoryPrefix = blobDirectoryPrefix
                         },
-                        TransferOptions = new TransferOptions()
+                        TransferOptions = new DataTransferOptions()
                         {
-                            CreateMode = StorageResourceCreateMode.Overwrite,
+                            CreationPreference = StorageResourceCreationPreference.OverwriteIfExists,
                         }
                     };
 
@@ -1077,11 +1077,11 @@ public async Task DownloadDirectory()
                     {
                         BlobContainerOptions = new BlobStorageResourceContainerOptions
                         {
-                            DirectoryPrefix = blobDirectoryPrefix
+                            BlobDirectoryPrefix = blobDirectoryPrefix
                         },
-                        TransferOptions = new TransferOptions()
+                        TransferOptions = new DataTransferOptions()
                         {
-                            CreateMode = StorageResourceCreateMode.Overwrite,
+                            CreationPreference = StorageResourceCreationPreference.OverwriteIfExists,
                         }
                     };