Merge pull request Azure#5028 from AsrOneSdk/siteRecoveryChanges

Marking Obsolete SiteRecovery and classic SiteRecovery. RecoveryServices.SiteRecovery can be used instead.

Author: cormacpayne

src/ResourceManager/SiteRecovery/ChangeLog.md

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Add deprecation warnings for all cmdlets in this module in preparation for the next breaking change release.
+    - Please see the upcoming breaking changes guide for more information on how to migrate your cmdlets from AzureRM.
 
 ## Version 5.0.1
 * Fixed assembly loading issue that caused some cmdlets to fail when executing

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Fabrics/GetAzureRmSiteRecoveryFabric.cs

@@ -29,6 +29,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryFabric", DefaultParameterSetName = ASRParameterSets.Default)]
     [OutputType(typeof(List<ASRFabric>))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrFabric cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class GetAzureRmSiteRecoveryFabric : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Fabrics/NewAzureRmSiteRecoveryFabric.cs

@@ -27,6 +27,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.New, "AzureRmSiteRecoveryFabric", DefaultParameterSetName = ASRParameterSets.Default)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "New-AzureRmRecoveryServicesAsrFabric cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class NewAzureRmSiteRecoveryFabric : SiteRecoveryCmdletBase
     {
         #region Parameters
@@ -56,7 +59,7 @@ public override void ExecuteSiteRecoveryCmdlet()
         {
             base.ExecuteSiteRecoveryCmdlet();
 
-            string fabricType = string.IsNullOrEmpty(this.Type)? FabricProviders.HyperVSite : this.Type;
+            string fabricType = string.IsNullOrEmpty(this.Type) ? FabricProviders.HyperVSite : this.Type;
 
             LongRunningOperationResponse response =
              RecoveryServicesClient.CreateAzureSiteRecoveryFabric(this.Name, fabricType);

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Fabrics/RemoveAzureRmSiteRecoveryFabric.cs

@@ -27,6 +27,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Remove, "AzureRmSiteRecoveryFabric", DefaultParameterSetName = ASRParameterSets.Default, SupportsShouldProcess = true)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Remove-AzureRmRecoveryServicesAsrFabric cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class RemoveAzureRmSiteRecoveryFabric : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Job/GetAzureSiteRecoveryJob.cs

@@ -25,6 +25,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryJob", DefaultParameterSetName = ASRParameterSets.ByParam)]
     [OutputType(typeof(IEnumerable<ASRJob>))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrJob cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class GetAzureSiteRecoveryJob : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Job/RestartAzureSiteRecoveryJob.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.SiteRecovery.Models;
+using System;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.SiteRecovery
@@ -22,6 +23,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsLifecycle.Restart, "AzureRmSiteRecoveryJob", DefaultParameterSetName = ASRParameterSets.ByObject)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Restart-AzureRmRecoveryServicesAsrJob cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class RestartAzureSiteRecoveryJob : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Job/ResumeAzureSiteRecoveryJob.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.SiteRecovery.Models;
+using System;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.SiteRecovery
@@ -22,6 +23,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsLifecycle.Resume, "AzureRmSiteRecoveryJob", DefaultParameterSetName = ASRParameterSets.ByObject)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Resume-AzureRmRecoveryServicesAsrJob cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class ResumeAzureSiteRecoveryJob : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Job/StopAzureSiteRecoveryJob.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.SiteRecovery.Models;
+using System;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.SiteRecovery
@@ -22,6 +23,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsLifecycle.Stop, "AzureRmSiteRecoveryJob", DefaultParameterSetName = ASRParameterSets.ByObject)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Stop-AzureRmRecoveryServicesAsrJob cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class StopAzureSiteRecoveryJob : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Network/GetAzureRMSiteRecoveryNetwork.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.SiteRecovery.Models;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;
@@ -24,6 +25,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryNetwork", DefaultParameterSetName = ASRParameterSets.Default)]
     [OutputType(typeof(IEnumerable<ASRNetwork>))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrNetwork cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class GetAzureRmSiteRecoveryNetwork : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Network/GetAzureRMSiteRecoveryNetworkMapping.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.SiteRecovery.Models;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;
@@ -24,6 +25,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryNetworkMapping", DefaultParameterSetName = ASRParameterSets.Default)]
     [OutputType(typeof(IEnumerable<ASRNetworkMapping>))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrNetworkMapping cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class GetAzureRmSiteRecoveryNetworkMapping : SiteRecoveryCmdletBase
     {
         /// <summary>
@@ -165,7 +169,7 @@ private void FilterE2AMappingsLegacy()
         /// Filter Enterprise to Enterprise Network mappings
         /// </summary>
         private void FilterE2EMappings()
-        {              
+        {
             foreach (NetworkMapping networkMapping in networkMappingsListResponse.NetworkMappingsList)
             {
                 string primaryFabricName = Utilities.GetValueFromArmId(networkMapping.Id, ARMResourceTypeConstants.ReplicationFabrics);

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Network/NewAzureRMSiteRecoveryNetworkMapping.cs

@@ -23,6 +23,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.New, "AzureRmSiteRecoveryNetworkMapping")]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "New-AzureRmRecoveryServicesAsrNetworkMapping cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class NewAzureRmSiteRecoveryNetworkMapping : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Network/RemoveAzureRMSiteRecoveryNetworkMapping.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Management.SiteRecovery.Models;
+using System;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.SiteRecovery
@@ -22,6 +23,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Remove, "AzureRmSiteRecoveryNetworkMapping")]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Remove-AzureRmRecoveryServicesAsrNetworkMapping cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class RemoveAzureRmSiteRecoveryNetworkMapping : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Policy/GetAzureSiteRecoveryPolicy.cs

@@ -27,6 +27,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// Retrieves Azure Site Recovery Policy.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryPolicy", DefaultParameterSetName = ASRParameterSets.Default)]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrPolicy cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     [OutputType(typeof(IEnumerable<ASRPolicy>))]
     public class GetAzureSiteRecoveryPolicy : SiteRecoveryCmdletBase
     {

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Policy/NewAzureSiteRecoveryPolicy.cs

@@ -23,6 +23,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// Creates Azure Site Recovery Policy object in memory.
     /// </summary>
     [Cmdlet(VerbsCommon.New, "AzureRmSiteRecoveryPolicy", DefaultParameterSetName = ASRParameterSets.EnterpriseToAzure)]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "New-AzureRmRecoveryServicesAsrPolicy cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class NewAzureSiteRecoveryPolicy : SiteRecoveryCmdletBase
     {
         /// <summary>

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Policy/RemoveAzureSiteRecoveryPolicy.cs

@@ -21,6 +21,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// Removes Azure Site Recovery Policy.
     /// </summary>
     [Cmdlet(VerbsCommon.Remove, "AzureRmSiteRecoveryPolicy")]
+    [System.Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Remove-AzureRmRecoveryServicesAsrPolicy cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class RemoveAzureSiteRecoveryPolicy : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Policy/StartAzureSiteRecoveryPolicyAssociationJob.cs

@@ -25,6 +25,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsLifecycle.Start, "AzureRmSiteRecoveryPolicyAssociationJob", DefaultParameterSetName = ASRParameterSets.EnterpriseToAzure)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "New-AzureRmRecoveryServicesAsrProtectionContainerMapping cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class StartAzureSiteRecoveryPolicyAssociationJob : SiteRecoveryCmdletBase
     {
         #region Parameters

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Policy/StartAzureSiteRecoveryPolicyDissociationJob.cs

@@ -24,6 +24,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsLifecycle.Start, "AzureRmSiteRecoveryPolicyDissociationJob", DefaultParameterSetName = ASRParameterSets.EnterpriseToAzure)]
     [OutputType(typeof(ASRJob))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Remove-AzureRmRecoveryServicesAsrProtectionContainerMapping cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class StartAzureSiteRecoveryPolicyDissociationJob : SiteRecoveryCmdletBase
     {
 

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Policy/UpdateAzureRmSiteRecoveryPolicy.cs

@@ -27,6 +27,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// Updates Azure Site Recovery Policy.
     /// </summary>
     [Cmdlet(VerbsData.Update, "AzureRmSiteRecoveryPolicy", DefaultParameterSetName = ASRParameterSets.Default)]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Update-AzureRmRecoveryServicesAsrPolicy cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class UpdateAzureRmSiteRecoveryPolicy : SiteRecoveryCmdletBase
     {
         #region Private
@@ -188,7 +191,7 @@ private void EnterpriseToEnterprisePolicyObject()
             this.replicationMethod = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.ReplicationMethod)) ?
                 ((string.Compare(this.ReplicationMethod, Constants.OnlineReplicationMethod, StringComparison.OrdinalIgnoreCase) == 0) ? "OverNetwork" : "Offline") :
                 ((string.Compare(replicationProviderSettings.InitialReplicationMethod, Constants.OnlineReplicationMethod, StringComparison.OrdinalIgnoreCase) == 0) ? "OverNetwork" : "Offline");
-            this.replicationFrequencyInSeconds = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.ReplicationFrequencyInSeconds)) ? 
+            this.replicationFrequencyInSeconds = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.ReplicationFrequencyInSeconds)) ?
                 PSRecoveryServicesClient.ConvertReplicationFrequencyToUshort(this.ReplicationFrequencyInSeconds) :
                 replicationProviderSettings.ReplicationFrequencyInSeconds;
             this.recoveryPoints = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.RecoveryPoints)) ?
@@ -212,7 +215,7 @@ private void EnterpriseToEnterprisePolicyObject()
             this.replicaDeletion = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.ReplicaDeletion)) ?
                 this.ReplicaDeletion :
                 replicationProviderSettings.ReplicaDeletionOption;
-                
+
             var updatePolicyProperties = new UpdatePolicyProperties();
 
             if (string.Compare(this.Policy.ReplicationProvider, Constants.HyperVReplica2012, StringComparison.OrdinalIgnoreCase) == 0)
@@ -240,7 +243,7 @@ private void EnterpriseToEnterprisePolicyObject()
                     InitialReplicationMethod = this.replicationMethod,
                     OnlineReplicationStartTime = this.replicationStartTime,
                     RecoveryPoints = this.recoveryPoints,
-                    ReplicaDeletion = this.replicaDeletion,                    
+                    ReplicaDeletion = this.replicaDeletion,
                     ReplicationPort = this.replicationPort,
                     ReplicationFrequencyInSeconds = replicationFrequencyInSeconds
                 };
@@ -284,7 +287,7 @@ private void EnterpriseToAzurePolicyObject()
                 replicationProviderSettings.RecoveryPoints;
             this.applicationConsistentSnapshotFrequencyInHours = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.ApplicationConsistentSnapshotFrequencyInHours)) ?
                 this.ApplicationConsistentSnapshotFrequencyInHours :
-                replicationProviderSettings.ApplicationConsistentSnapshotFrequencyInHours;           
+                replicationProviderSettings.ApplicationConsistentSnapshotFrequencyInHours;
             this.replicationStartTime = this.MyInvocation.BoundParameters.ContainsKey(Utilities.GetMemberName(() => this.ReplicationStartTime)) ?
                 this.replicationStartTime :
                 replicationProviderSettings.OnlineReplicationStartTime;

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/Properties/Resources.Designer.cs

@@ -27,6 +27,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryProtectableItem", DefaultParameterSetName = ASRParameterSets.ByObject)]
     [OutputType(typeof(IEnumerable<ASRProtectableItem>))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrProtectableItem cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class GetAzureRmSiteRecoveryProtectableItem : SiteRecoveryCmdletBase
     {
         #region Parameters
@@ -86,8 +89,8 @@ private void GetByFriendlyName()
             ProtectableItemListResponse protectableItemListResponse = RecoveryServicesClient.GetAzureSiteRecoveryProtectableItem(
                 Utilities.GetValueFromArmId(this.ProtectionContainer.ID, ARMResourceTypeConstants.ReplicationFabrics),
                 this.ProtectionContainer.Name);
-            ProtectableItem protectableItem = 
-                protectableItemListResponse.ProtectableItems.SingleOrDefault(t => 
+            ProtectableItem protectableItem =
+                protectableItemListResponse.ProtectableItems.SingleOrDefault(t =>
                 string.Compare(t.Properties.FriendlyName, this.FriendlyName, StringComparison.OrdinalIgnoreCase) == 0);
 
             if (protectableItem != null)

src/ResourceManager/SiteRecovery/Commands.SiteRecovery/ProtectableItem/GetAzureRmSiteRecoveryProtectableItem.cs

@@ -28,6 +28,9 @@ namespace Microsoft.Azure.Commands.SiteRecovery
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmSiteRecoveryProtectionContainer", DefaultParameterSetName = ASRParameterSets.Default)]
     [OutputType(typeof(IEnumerable<ASRProtectionContainer>))]
+    [Obsolete("This cmdlet has been marked for deprecation in an upcoming release. Please use the " +
+        "Get-AzureRmRecoveryServicesAsrProtectionContainer cmdlet from the AzureRm.RecoveryServices.SiteRecovery module instead.",
+        false)]
     public class GetAzureRmSiteRecoveryProtectionContainer : SiteRecoveryCmdletBase
     {
         #region Parameters