[Az.StorageSync] Change default parameter set of Invoke-AzStorageSyncChangeDetection (#16986)

* initial commit

* update changelog

* update change detection doc

* regenerate docs

* Update ChangeLog.md

* Create BreakingChangeIssues.csv

Co-authored-by: Yabo Hu <[email protected]>
Co-authored-by: ankushbindlish2 <[email protected]>

Author: 3 people

src/StorageSync/StorageSync/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Changed default parameter set of Invoke-AzStorageSyncChangeDetection to use full share detection
 
 ## Version 1.6.1
 * Fixed a bug where not all properties of PSSyncSessionStatus and PSSyncActivityStatus objects were being populated properly.

src/StorageSync/StorageSync/CloudEndpoint/InvokeChangeDetectionCommand.cs

@@ -33,7 +33,7 @@ namespace Microsoft.Azure.Commands.StorageSync.CloudEndpoint
     /// </summary>
     /// <seealso cref="Microsoft.Azure.Commands.StorageSync.Common.StorageSyncClientCmdletBase" />
     [Cmdlet(VerbsLifecycle.Invoke, StorageSyncNouns.NounAzureRmStorageSyncChangeDetection,
-        DefaultParameterSetName = StorageSyncParameterSets.ChangeDetectionStringAndDirectoryParameterSet, SupportsShouldProcess = true), OutputType(typeof(void))]
+        DefaultParameterSetName = StorageSyncParameterSets.ChangeDetectionFullShareStringParameterSet, SupportsShouldProcess = true), OutputType(typeof(void))]
     public class InvokeChangeDetectionCommand : StorageSyncClientCmdletBase
     {
         /// <summary>

src/StorageSync/StorageSync/help/Invoke-AzStorageSyncChangeDetection.md

@@ -20,25 +20,25 @@ This command can be used to manually initiate the detection of namespace changes
 
 ## SYNTAX
 
-### StringAndDirectoryParameterSet (Default)
+### FullShareStringParameterSet (Default)
 ```
 Invoke-AzStorageSyncChangeDetection [-ResourceGroupName] <String> [-StorageSyncServiceName] <String>
- [-SyncGroupName] <String> -Name <String> -DirectoryPath <String> [-Recursive] [-PassThru] [-AsJob]
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-SyncGroupName] <String> -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
+ [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
-### StringAndPathParameterSet
+### StringAndDirectoryParameterSet
 ```
 Invoke-AzStorageSyncChangeDetection [-ResourceGroupName] <String> [-StorageSyncServiceName] <String>
- [-SyncGroupName] <String> -Name <String> -Path <String[]> [-PassThru] [-AsJob]
+ [-SyncGroupName] <String> -Name <String> -DirectoryPath <String> [-Recursive] [-PassThru] [-AsJob]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
-### FullShareStringParameterSet
+### StringAndPathParameterSet
 ```
 Invoke-AzStorageSyncChangeDetection [-ResourceGroupName] <String> [-StorageSyncServiceName] <String>
- [-SyncGroupName] <String> -Name <String> [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-SyncGroupName] <String> -Name <String> -Path <String[]> [-PassThru] [-AsJob]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ResourceIdAndDirectoryParameterSet
@@ -178,7 +178,7 @@ Name of the CloudEndpoint. The name is a GUID, not the friendly name that's disp
 
 ```yaml
 Type: System.String
-Parameter Sets: StringAndDirectoryParameterSet, StringAndPathParameterSet, FullShareStringParameterSet
+Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet
 Aliases: CloudEndpointName
 
 Required: True
@@ -238,7 +238,7 @@ Resource Group Name.
 
 ```yaml
 Type: System.String
-Parameter Sets: StringAndDirectoryParameterSet, StringAndPathParameterSet, FullShareStringParameterSet
+Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet
 Aliases:
 
 Required: True
@@ -268,7 +268,7 @@ Name of the StorageSyncService.
 
 ```yaml
 Type: System.String
-Parameter Sets: StringAndDirectoryParameterSet, StringAndPathParameterSet, FullShareStringParameterSet
+Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet
 Aliases: ParentName
 
 Required: True
@@ -283,7 +283,7 @@ Name of the SyncGroup.
 
 ```yaml
 Type: System.String
-Parameter Sets: StringAndDirectoryParameterSet, StringAndPathParameterSet, FullShareStringParameterSet
+Parameter Sets: FullShareStringParameterSet, StringAndDirectoryParameterSet, StringAndPathParameterSet
 Aliases:
 
 Required: True

tools/StaticAnalysis/Exceptions/Az.StorageSync/BreakingChangeIssues.csv

@@ -0,0 +1,3 @@
+"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
+"Az.StorageSync","Microsoft.Azure.Commands.StorageSync.CloudEndpoint.InvokeChangeDetectionCommand","Invoke-AzStorageSyncChangeDetection","0","1060","The parameter set 'StringAndDirectoryParameterSet' for cmdlet 'Invoke-AzStorageSyncChangeDetection' is no longer the default parameter set.","Change the default parameter for cmdlet 'Invoke-AzStorageSyncChangeDetection' back to 'StringAndDirectoryParameterSet'."
+"Az.StorageSync","Microsoft.Azure.Commands.StorageSync.CloudEndpoint.InvokeChangeDetectionCommand","Invoke-AzStorageSyncChangeDetection","0","1060","The parameter set 'StringAndDirectoryParameterSet' for cmdlet 'Invoke-AzStorageSyncChangeDetection' is no longer the default parameter set.","Change the default parameter for cmdlet 'Invoke-AzStorageSyncChangeDetection' back to 'StringAndDirectoryParameterSet'."