Added documentaiton to clarify BlobCopyFromUriOptions.CopySourceTagsM…

…ode behavior (#42907)
Azure · Mar 22, 2024 · 1f40862 · 1f40862
1 parent 0ef8e8d
commit 1f40862
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs
@@ -3257,7 +3257,7 @@ internal async Task<Stream> OpenReadInternal(
         /// whether it resides in the same account or in a different account.
         /// </param>
         /// <param name="options">
-        /// Optional parameters.
+        /// Optional parameters.  Note that <see cref="BlobCopyFromUriOptions.CopySourceTagsMode"/> is not applicable to this API.
         /// </param>
         /// <param name="cancellationToken">
         /// Optional <see cref="CancellationToken"/> to propagate
@@ -3412,7 +3412,7 @@ public virtual CopyFromUriOperation StartCopyFromUri(
         /// whether it resides in the same account or in a different account.
         /// </param>
         /// <param name="options">
-        /// Optional parameters.
+        /// Optional parameters.  Note that <see cref="BlobCopyFromUriOptions.CopySourceTagsMode"/> is not applicable to this API.
         /// </param>
         /// <param name="cancellationToken">
         /// Optional <see cref="CancellationToken"/> to propagate

diff --git a/sdk/storage/Azure.Storage.Blobs/src/Models/BlobCopyFromUriOptions.cs b/sdk/storage/Azure.Storage.Blobs/src/Models/BlobCopyFromUriOptions.cs
@@ -84,7 +84,7 @@ public class BlobCopyFromUriOptions
         public HttpAuthorization SourceAuthentication { get; set; }
 
         /// <summary>
-        /// Optional.
+        /// Optional.  Note that this option is not applicable to <see cref="BlobBaseClient.StartCopyFromUri(System.Uri, BlobCopyFromUriOptions, System.Threading.CancellationToken)"/> and <see cref="BlobBaseClient.StartCopyFromUriAsync(System.Uri, BlobCopyFromUriOptions, System.Threading.CancellationToken)"/>.
         /// If <see cref="BlobCopySourceTagsMode.Replace"/>, the tags on the destination blob will be set to <see cref="Tags"/>.
         /// If <see cref="BlobCopySourceTagsMode.Copy"/>, the tags on the source blob will be copied to the destination blob.
         /// Default is to replace.