Added support for deleting Shares that have leased snapshots

sdk/storage/Azure.Storage.Files.Shares/api/Azure.Storage.Files.Shares.netstandard2.0.cs

@@ -286,7 +286,11 @@ public ShareServiceClient(System.Uri serviceUri, Azure.Storage.StorageSharedKeyC
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareClient>> CreateShareAsync(string shareName, Azure.Storage.Files.Shares.Models.ShareCreateOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareClient>> CreateShareAsync(string shareName, System.Collections.Generic.IDictionary<string, string> metadata = null, int? quotaInGB = default(int?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response DeleteShare(string shareName, Azure.Storage.Files.Shares.Models.ShareDeleteOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public virtual Azure.Response DeleteShare(string shareName, bool includeSnapshots = true, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response> DeleteShareAsync(string shareName, Azure.Storage.Files.Shares.Models.ShareDeleteOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public virtual System.Threading.Tasks.Task<Azure.Response> DeleteShareAsync(string shareName, bool includeSnapshots = true, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response<Azure.Storage.Files.Shares.Models.ShareServiceProperties> GetProperties(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.Models.ShareServiceProperties>> GetPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
@@ -438,7 +442,7 @@ public partial class ShareDeleteOptions
     {
         public ShareDeleteOptions() { }
         public Azure.Storage.Files.Shares.Models.ShareFileRequestConditions Conditions { get { throw null; } set { } }
-        public bool IncludeSnapshots { get { throw null; } set { } }
+        public Azure.Storage.Files.Shares.Models.ShareSnapshotsDeleteOption? ShareSnapshotsDeleteOption { get { throw null; } set { } }
     }
     public partial class ShareDirectoryInfo
     {
@@ -844,6 +848,11 @@ internal ShareSnapshotInfo() { }
         public System.DateTimeOffset LastModified { get { throw null; } }
         public string Snapshot { get { throw null; } }
     }
+    public enum ShareSnapshotsDeleteOption
+    {
+        Include = 0,
+        IncludeWithLeased = 1,
+    }
     [System.FlagsAttribute]
     public enum ShareStates
     {

sdk/storage/Azure.Storage.Files.Shares/src/Models/ShareDeleteOptions.cs

@@ -13,10 +13,10 @@ namespace Azure.Storage.Files.Shares.Models
     public class ShareDeleteOptions
     {
         /// <summary>
-        /// A value indicating whether to delete a share's snapshots in addition
+        /// A value indicating whether to delete a share's snapshots or leased snapshots in addition
         /// to the share itself.
         /// </summary>
-        public bool IncludeSnapshots { get; set; }
+        public ShareSnapshotsDeleteOption? ShareSnapshotsDeleteOption { get; set; }
 
         /// <summary>
         /// Optional <see cref="ShareFileRequestConditions"/> to add conditions
@@ -29,7 +29,7 @@ public class ShareDeleteOptions
         /// </summary>
         public ShareDeleteOptions()
         {
-            IncludeSnapshots = true;
+            ShareSnapshotsDeleteOption = Models.ShareSnapshotsDeleteOption.Include;
         }
     }
 }

sdk/storage/Azure.Storage.Files.Shares/src/Models/ShareSnapshotsDeleteOption.cs

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Azure.Storage.Files.Shares.Models
+{
+    /// <summary>
+    /// Options to delete a share's snapshots.
+    /// </summary>
+    public enum ShareSnapshotsDeleteOption
+    {
+        /// <summary>
+        /// The share's snapshots that do not have an active lease will be deleted with the share.
+        /// </summary>
+        Include,
+
+        /// <summary>
+        /// All of the share's snapshots, including those with an active lease, will be deleted with the share.
+        /// </summary>
+        IncludeWithLeased
+    }
+}

sdk/storage/Azure.Storage.Files.Shares/src/ShareClient.cs

@@ -908,7 +908,8 @@ public virtual Response<bool> DeleteIfExists(
             ShareDeleteOptions options = default,
             CancellationToken cancellationToken = default) =>
             DeleteIfExistsInternal(
-                includeSnapshots: options?.IncludeSnapshots ?? true,
+                includeSnapshots: default,
+                shareSnapshotsDeleteOption: options?.ShareSnapshotsDeleteOption,
                 conditions: options?.Conditions,
                 async: false,
                 cancellationToken).EnsureCompleted();
@@ -938,7 +939,8 @@ public virtual async Task<Response<bool>> DeleteIfExistsAsync(
             ShareDeleteOptions options = default,
             CancellationToken cancellationToken = default) =>
             await DeleteIfExistsInternal(
-                includeSnapshots: options?.IncludeSnapshots ?? true,
+                includeSnapshots: default,
+                shareSnapshotsDeleteOption: options?.ShareSnapshotsDeleteOption,
                 conditions: options?.Conditions,
                 async: true,
                 cancellationToken).ConfigureAwait(false);
@@ -973,6 +975,7 @@ public virtual Response<bool> DeleteIfExists(
             CancellationToken cancellationToken) =>
             DeleteIfExistsInternal(
                 includeSnapshots,
+                shareSnapshotsDeleteOption: default,
                 conditions: default,
                 async: false,
                 cancellationToken).EnsureCompleted();
@@ -1007,6 +1010,7 @@ public virtual async Task<Response<bool>> DeleteIfExistsAsync(
             CancellationToken cancellationToken) =>
             await DeleteIfExistsInternal(
                 includeSnapshots,
+                shareSnapshotsDeleteOption: default,
                 conditions: default,
                 async: true,
                 cancellationToken).ConfigureAwait(false);
@@ -1022,6 +1026,9 @@ await DeleteIfExistsInternal(
         /// A value indicating whether to delete a share's snapshots in addition
         /// to the share itself.
         /// </param>
+        /// <param name="shareSnapshotsDeleteOption">
+        /// Parameter indicating if the share's snapshots or leased snapshots should be deleted.
+        /// </param>
         /// <param name="conditions">
         /// Optional <see cref="ShareFileRequestConditions"/> to add conditions
         /// on deleting the share.
@@ -1042,6 +1049,7 @@ await DeleteIfExistsInternal(
         /// </remarks>
         private async Task<Response<bool>> DeleteIfExistsInternal(
             bool includeSnapshots,
+            ShareSnapshotsDeleteOption? shareSnapshotsDeleteOption,
             ShareFileRequestConditions conditions,
             bool async,
             CancellationToken cancellationToken)
@@ -1056,6 +1064,7 @@ private async Task<Response<bool>> DeleteIfExistsInternal(
                 {
                     Response response = await DeleteInternal(
                         includeSnapshots,
+                        shareSnapshotsDeleteOption,
                         conditions,
                         async,
                         cancellationToken,
@@ -1232,7 +1241,8 @@ public virtual Response Delete(
             ShareDeleteOptions options = default,
             CancellationToken cancellationToken = default) =>
             DeleteInternal(
-                includeSnapshots: options?.IncludeSnapshots ?? true,
+                includeSnapshots: default,
+                shareSnapshotsDeleteOption: options?.ShareSnapshotsDeleteOption,
                 conditions: options?.Conditions,
                 async: false,
                 cancellationToken)
@@ -1264,7 +1274,8 @@ public virtual async Task<Response> DeleteAsync(
             ShareDeleteOptions options = default,
             CancellationToken cancellationToken = default) =>
             await DeleteInternal(
-                includeSnapshots: options?.IncludeSnapshots ?? true,
+                includeSnapshots: default,
+                shareSnapshotsDeleteOption: options?.ShareSnapshotsDeleteOption,
                 conditions: options?.Conditions,
                 async: true,
                 cancellationToken)
@@ -1299,6 +1310,7 @@ public virtual Response Delete(
             CancellationToken cancellationToken = default) =>
             DeleteInternal(
                 includeSnapshots,
+                shareSnapshotsDeleteOption: default,
                 conditions: default,
                 async: false,
                 cancellationToken)
@@ -1333,6 +1345,7 @@ public virtual async Task<Response> DeleteAsync(
             CancellationToken cancellationToken = default) =>
             await DeleteInternal(
                 includeSnapshots,
+                shareSnapshotsDeleteOption: default,
                 conditions: default,
                 async: true,
                 cancellationToken)
@@ -1347,8 +1360,10 @@ await DeleteInternal(
         /// Delete Share</see>.
         /// </summary>
         /// <param name="includeSnapshots">
-        /// A value indicating whether to delete a share's snapshots in addition
-        /// to the share itself.
+        /// If this share snapshots should be deleted.  This parameter is for backwards compatibility.
+        /// </param>
+        /// <param name="shareSnapshotsDeleteOption">
+        /// Parameter indicating if the share's snapshots or leased snapshots should be deleted.
         /// </param>
         /// <param name="conditions">
         /// Optional <see cref="ShareFileRequestConditions"/> to add conditions
@@ -1372,7 +1387,8 @@ await DeleteInternal(
         /// a failure occurs.
         /// </remarks>
         internal async Task<Response> DeleteInternal(
-            bool includeSnapshots,
+            bool? includeSnapshots,
+            ShareSnapshotsDeleteOption? shareSnapshotsDeleteOption,
             ShareFileRequestConditions conditions,
             bool async,
             CancellationToken cancellationToken,
@@ -1386,16 +1402,15 @@ internal async Task<Response> DeleteInternal(
                     $"{nameof(Uri)}: {Uri}");
                 try
                 {
-                    DeleteSnapshotsOptionType? deleteSnapshotsOption;
-
                     // DeleteSnapshotsOptionType.Include is not valid when deleting a Snapshot Share.
                     if (Uri.GetQueryParameters().ContainsKey(Constants.ShareSnapshotParameterName))
                     {
-                        deleteSnapshotsOption = null;
+                        shareSnapshotsDeleteOption = null;
                     }
-                    else
+                    // This is for backwards compatibility.  Perviously, ShareClient.Delete() took a bool includSnapshots parameter.s
+                    else if ((includeSnapshots == null || includeSnapshots == true) && shareSnapshotsDeleteOption == null)
                     {
-                        deleteSnapshotsOption = includeSnapshots ? DeleteSnapshotsOptionType.Include : (DeleteSnapshotsOptionType?)null;
+                        shareSnapshotsDeleteOption = ShareSnapshotsDeleteOption.Include;
                     }
 
                     return await FileRestClient.Share.DeleteAsync(
@@ -1404,7 +1419,7 @@ internal async Task<Response> DeleteInternal(
                         Uri,
                         version: Version.ToVersionString(),
                         leaseId: conditions?.LeaseId,
-                        deleteSnapshots: deleteSnapshotsOption,
+                        deleteSnapshots: shareSnapshotsDeleteOption.ToShareSnapshotsDeleteOptionInternal(),
                         async: async,
                         operationName: operationName ?? $"{nameof(ShareClient)}.{nameof(Delete)}",
                         cancellationToken: cancellationToken)

sdk/storage/Azure.Storage.Files.Shares/src/ShareExtensions.cs

@@ -38,5 +38,19 @@ internal static string ToFileDateTimeString(this DateTimeOffset? dateTimeOffset)
 
         private static string ToFileDateTimeString(this DateTimeOffset dateTimeOffset)
             => dateTimeOffset.UtcDateTime.ToString(Constants.File.FileTimeFormat, CultureInfo.InvariantCulture);
+
+        internal static ShareSnapshotsDeleteOptionInternal? ToShareSnapshotsDeleteOptionInternal(this ShareSnapshotsDeleteOption? option)
+        {
+            if (option == null)
+            {
+                return null;
+            }
+            return option switch
+            {
+                ShareSnapshotsDeleteOption.Include => ShareSnapshotsDeleteOptionInternal.Include,
+                ShareSnapshotsDeleteOption.IncludeWithLeased => ShareSnapshotsDeleteOptionInternal.IncludeLeased,
+                _ => throw new ArgumentException($"Invalid {nameof(ShareSnapshotsDeleteOption)}: {option}"),
+            };
+        }
     }
 }