Merge pull request #4699 from dragav/feature/deprecatepurgedisable

KeyVault: deprecating the PurgeDisabled flag from secret and key attributes

Author: cormacpayne

src/ResourceManager/KeyVault/ChangeLog.md

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Deprecating the PurgeDisabled flag from Key, Secret and Certificate attributes, respectively.
+  * The flag is being superseded by the RecoveryLevel attribute.
 
 ## Version 3.4.0
 * New/updated Cmdlets to support soft-delete for KeyVault certificates

src/ResourceManager/KeyVault/Commands.KeyVault/Models/KeyAttributes.cs

@@ -35,7 +35,6 @@ internal KeyAttributes(bool? enabled, DateTime? expires, DateTime? notBefore, st
             this.KeyType = keyType;
             this.KeyOps = keyOps;
             this.Tags = tags;
-            this.PurgeDisabled = false;
         }
 
         internal KeyAttributes(bool? enabled, DateTime? expires, DateTime? notBefore, string keyType, 
@@ -50,7 +49,6 @@ internal KeyAttributes(bool? enabled, DateTime? expires, DateTime? notBefore, st
             this.Updated = updated;
             this.RecoveryLevel = deletionRecoveryLevel;
             this.Tags = (tags == null) ? null : tags.ConvertToHashtable();
-            this.PurgeDisabled = false;
         }
 
         public bool? Enabled { get; set; }
@@ -67,12 +65,7 @@ internal KeyAttributes(bool? enabled, DateTime? expires, DateTime? notBefore, st
 
         public DateTime? Updated { get; private set; }
 
-        /// <summary>
-        /// Obsolete flag indicating that the key is protected against purge.
-        /// </summary>
-        /// <remarks>
-        /// Deprecated, will be removed in the next PowerShell release.
-        /// </remarks>
+        [Obsolete("The PurgeDisabled property is being deprecated and will be removed in a future release. Please use the RecoveryLevel property instead.")]
         public bool PurgeDisabled { get; private set; }
 
         public string RecoveryLevel { get; private set; }

src/ResourceManager/KeyVault/Commands.KeyVault/Models/KeyIdentityItem.cs

@@ -38,11 +38,6 @@ internal KeyIdentityItem(Azure.KeyVault.Models.KeyItem keyItem, VaultUriHelper v
             Updated = keyItem.Attributes.Updated;
             RecoveryLevel = keyItem.Attributes.RecoveryLevel;
             Tags = (keyItem.Tags == null) ? null : keyItem.Tags.ConvertToHashtable();
-
-
-            // the PurgeDisabled field was deprecated, but is kept in the
-            // PSH SDK until the first breaking-change release.
-            PurgeDisabled = false;
         }
 
         internal KeyIdentityItem(KeyBundle keyBundle)
@@ -61,10 +56,6 @@ internal KeyIdentityItem(KeyBundle keyBundle)
             Updated = keyBundle.Attributes.Updated;
             RecoveryLevel = keyBundle.Attributes.RecoveryLevel;
             Tags = keyBundle.Attributes.Tags;
-
-            // the PurgeDisabled field was deprecated, but is kept in the
-            // PSH SDK until the first breaking-change release.
-            PurgeDisabled = false;
         }
 
         public bool? Enabled { get; set; }
@@ -77,6 +68,7 @@ internal KeyIdentityItem(KeyBundle keyBundle)
 
         public DateTime? Updated { get; private set; }
 
+        [Obsolete( "The PurgeDisabled property is being deprecated and will be removed in a future release. Please use the RecoveryLevel property instead." )]
         public bool PurgeDisabled { get; private set; }
 
         public string RecoveryLevel { get; private set; }

src/ResourceManager/KeyVault/Commands.KeyVault/Models/SecretAttributes.cs

@@ -33,7 +33,6 @@ internal SecretAttributes(bool? enabled, DateTime? expires, DateTime? notBefore,
             this.NotBefore = notBefore;
             this.ContentType = contentType;
             this.Tags = tags;
-            this.PurgeDisabled = false;
         }
 
         internal SecretAttributes(bool? enabled, DateTime? expires, DateTime? notBefore, 
@@ -47,7 +46,6 @@ internal SecretAttributes(bool? enabled, DateTime? expires, DateTime? notBefore,
             this.ContentType = contentType;
             this.RecoveryLevel = deletionRecoveryLevel;
             this.Tags = (tags == null) ? null : tags.ConvertToHashtable();
-            this.PurgeDisabled = false;
         }
 
         public bool? Enabled { get; set; }
@@ -64,12 +62,7 @@ internal SecretAttributes(bool? enabled, DateTime? expires, DateTime? notBefore,
 
         public Hashtable Tags { get; set; }
 
-        /// <summary>
-        /// Obsolete flag indicating that the secret is protected against purge.
-        /// </summary>
-        /// <remarks>
-        /// Deprecated, will be removed in the next PowerShell release.
-        /// </remarks>
+        [Obsolete( "The PurgeDisabled property is being deprecated and will be removed in a future release. Please use the RecoveryLevel property instead." )]
         public bool PurgeDisabled { get; private set; }
 
         public string RecoveryLevel { get; private set; }