[Az.StorageSync] Deprecate Invoke-AzStorageSyncFileRecall cmdlet (#14906

)

* deprecate Invoke-AzStorageSyncFileRecall cmdlet

* update documentation and tests

* generate help update

* update strings

* fully remove recall cmdlet, update help files, tests, and other content

* clean up designer file

* Revert changes to breaking change doc

src/StorageSync/StorageSync.Test/ScenarioTests/ServerEndpointTests.ps1

@@ -131,15 +131,6 @@ function Test-ServerEndpoint2
         Assert-AreEqual $serverLocalPath $serverEndpoint2.ServerLocalPath
         Assert-AreEqual $volumeFreeSpacePercent2 $serverEndpoint2.VolumeFreeSpacePercent
 
-        Write-Verbose "Recall ServerEndpoint by Name"
-        Invoke-AzStorageSyncFileRecall -ResourceGroupName $resourceGroupName -StorageSyncServiceName $storageSyncServiceName -SyncGroupName  $syncGroupName -Name $serverEndpointName -AsJob | Wait-Job
-
-        Write-Verbose "Recall ServerEndpoint by InputObject"
-        Invoke-AzStorageSyncFileRecall -InputObject $serverEndpoint -AsJob | Wait-Job
-
-        Write-Verbose "Recall ServerEndpoint by ResourceId"
-        Invoke-AzStorageSyncFileRecall -ResourceId $serverEndpoint.ResourceId -AsJob | Wait-Job
-
         Write-Verbose "Removing ServerEndpoint: $serverEndpointName"
         Remove-AzStorageSyncServerEndpoint -Force -ResourceGroupName $resourceGroupName -StorageSyncServiceName $storageSyncServiceName -SyncGroupName $syncGroupName -Name $serverEndpointName -AsJob | Wait-Job
 

src/StorageSync/StorageSync/Az.StorageSync.psd1

@@ -83,7 +83,7 @@ CmdletsToExport = 'Invoke-AzStorageSyncCompatibilityCheck',
                'New-AzStorageSyncServerEndpoint', 
                'Get-AzStorageSyncServerEndpoint', 
                'Remove-AzStorageSyncServerEndpoint', 
-               'Set-AzStorageSyncServerEndpoint', 'Invoke-AzStorageSyncFileRecall', 
+               'Set-AzStorageSyncServerEndpoint', 
                'Register-AzStorageSyncServer', 'Unregister-AzStorageSyncServer', 
                'Get-AzStorageSyncServer', 'Reset-AzStorageSyncServerCertificate', 
                'Invoke-AzStorageSyncChangeDetection'

src/StorageSync/StorageSync/ChangeLog.md

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Deprecating Invoke-AzStorageSyncFileRecall.
+    - Customers should instead use Invoke-StorageSyncFileRecall, a cmdlet that is shipped with the Azure File Sync agent.
 
 ## Version 1.4.0
 * Added Sync tiering policy feature with download policy and local cache mode

src/StorageSync/StorageSync/Common/StorageSyncCmdletNames.cs

@@ -43,10 +43,6 @@ public class StorageSyncCmdletNames
         /// </summary>
         public const string NewAzureRmStorageSyncServerEndpoint = VerbsCommon.New + "-" + StorageSyncNouns.NounAzureRmStorageSyncServerEndpoint;
         /// <summary>
-        /// The invoke azure rm storage sync file recall
-        /// </summary>
-        public const string InvokeAzureRmStorageSyncFileRecall = VerbsLifecycle.Invoke + "-" + StorageSyncNouns.NounAzureRmStorageSyncFileRecall;
-        /// <summary>
         /// The get azure rm storage sync service
         /// </summary>
         public const string GetAzureRmStorageSyncService = VerbsCommon.Get + "-" + StorageSyncNouns.NounAzureRmStorageSyncService;

src/StorageSync/StorageSync/Common/StorageSyncNouns.cs

@@ -47,10 +47,6 @@ public class StorageSyncNouns
         /// </summary>
         public const string NounAzureRmStorageSyncServerConfiguration = StorageSyncConstants.ProductPrefix + "ServerConfiguration";
         /// <summary>
-        /// The noun azure rm storage sync file recall
-        /// </summary>
-        public const string NounAzureRmStorageSyncFileRecall = StorageSyncConstants.ProductPrefix + "FileRecall";
-        /// <summary>
         /// The noun azure rm storage sync server certificate
         /// </summary>
         public const string NounAzureRmStorageSyncServerCertificate = NounAzureRmStorageSyncServer + "Certificate";

src/StorageSync/StorageSync/Properties/StorageSyncResources.resx

@@ -123,9 +123,6 @@
   <data name="GetSyncServerCertificateErrorMessageFormat" xml:space="preserve">
     <value>COM Exception while loading certificate: HResult: {0} Message: {1}</value>
   </data>
-  <data name="InvokeStorageSyncFileRecallActionMessage" xml:space="preserve">
-    <value>Invoke Storage Sync File Recall</value>
-  </data>
   <data name="MissingAfsAgentInstallerPathErrorMessage" xml:space="preserve">
     <value>We cannot find the Storage Sync agent installed in the system. The given registry AfsAgentInstallerPath cannot be found.</value>
   </data>

src/StorageSync/StorageSync/help/Az.StorageSync.md

@@ -32,9 +32,6 @@ This command can be used to manually initiate the detection of namespaces change
 ### [Invoke-AzStorageSyncCompatibilityCheck](Invoke-AzStorageSyncCompatibilityCheck.md)
 Checks for potential compatibility issues between your system and Azure File Sync.
 
-### [Invoke-AzStorageSyncFileRecall](Invoke-AzStorageSyncFileRecall.md)
-This command recalls all tiered files back to local disk.
-
 ### [New-AzStorageSyncCloudEndpoint](New-AzStorageSyncCloudEndpoint.md)
 This command creates an Azure File Sync cloud endpoint in a sync group.