Made changes in the registration to onboard nodes to Azure Arc (#15021)

* Made changes in the registration to onboard nodes to Azure Arc

Registering On-Premises Azure Stack HCI with Azure will also make the nodes in the cluster Azure Arc enabled.

* Change default EnableAzureArcServer to $false

Change EnableAzureArcServer to $false. We will make it default behaviour by S187 release.

* Updated Az.StackHCI BreakingChangeIssues.csv

Updated Az.StackHCI BreakingChangeIssues.csv as per recommendation

* Update BreakingChangeIssues.csv

* Remove serializedcmdlets for StackHCI since it is install in preview

Co-authored-by: Dingmeng Xue <[email protected]>
Co-authored-by: Lei Jin <[email protected]>

Author: 3 people

src/StackHCI/Az.StackHCI.psm1

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Made changes in the registration to onboard nodes to Azure Arc.
+    - Registering On-Premises Azure Stack HCI with Azure will also make the nodes in the cluster Azure Arc enabled.   
 
 ## Version 0.6.0
 * Fixed addition of assigned roles list.

src/StackHCI/ChangeLog.md

@@ -17,7 +17,7 @@ Register-AzStackHCI [-SubscriptionId] <String> [[-Region] <String>] [[-ResourceN
  [[-Tag] <Hashtable>] [[-TenantId] <String>] [[-ResourceGroupName] <String>] [[-ArmAccessToken] <String>]
  [[-GraphAccessToken] <String>] [[-AccountId] <String>] [[-EnvironmentName] <String>]
  [[-ComputerName] <String>] [[-CertificateThumbprint] <String>] [-RepairRegistration]
- [-UseDeviceAuthentication] [[-Credential] <PSCredential>] [<CommonParameters>]
+ [-UseDeviceAuthentication] [-EnableAzureArcServer] [[-Credential] <PSCredential>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -149,6 +149,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -EnableAzureArcServer
+Specifying this parameter to $false will skip registering the cluster nodes with Arc for servers.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: True
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -EnvironmentName
 Specifies the Azure Environment.
 Default is AzureCloud.

src/StackHCI/help/Register-AzStackHCI.md

@@ -16,8 +16,9 @@ The registered information available on the cluster is used to unregister the cl
 ```
 Unregister-AzStackHCI [[-SubscriptionId] <String>] [[-ResourceName] <String>] [[-TenantId] <String>]
  [[-ResourceGroupName] <String>] [[-ArmAccessToken] <String>] [[-GraphAccessToken] <String>]
- [[-AccountId] <String>] [[-EnvironmentName] <String>] [[-ComputerName] <String>] [-UseDeviceAuthentication]
- [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [[-AccountId] <String>] [[-EnvironmentName] <String>] [[-Region] <String>] [[-ComputerName] <String>]
+ [-UseDeviceAuthentication] [-DisableOnlyAzureArcServer] [[-Credential] <PSCredential>] [-Force] [-WhatIf]
+ [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -31,27 +32,31 @@ The registered information available on the cluster is used to unregister the cl
 C:\PS\>Unregister-AzStackHCI
 Result: Success
 ```
+
 Invoking on one of the cluster node
 
 ### EXAMPLE 2
 ```powershell
 C:\PS\>Unregister-AzStackHCI -ComputerName ClusterNode1
 Result: Success
 ```
+
 Invoking from the management node
 
 ### EXAMPLE 3
 ```powershell
 C:\PS\>Unregister-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ArmAccessToken etyer..ere= -GraphAccessToken acyee..rerrer -AccountId [email protected] -ResourceName DemoHCICluster3 -ResourceGroupName DemoHCIRG -Confirm:$False
 Result: Success
 ```
+
 Invoking from WAC
 
 ### EXAMPLE 4
 ```powershell
 C:\PS\>Unregister-AzStackHCI -SubscriptionId "12a0f531-56cb-4340-9501-257726d741fd" -ResourceName HciCluster1 -TenantId "c31c0dbb-ce27-4c78-ad26-a5f717c14557" -ResourceGroupName HciClusterRG -ArmAccessToken eerrer..ere= -GraphAccessToken acee..rerrer -AccountId [email protected] -EnvironmentName AzureCloud -ComputerName node1hci -Credential Get-Credential
 Result: Success
 ```
+
 Invoking with all the parameters
 
 ## PARAMETERS
@@ -97,7 +102,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 9
+Position: 10
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -113,12 +118,27 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 10
+Position: 11
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -DisableOnlyAzureArcServer
+Specifying this parameter to $true will only unregister the cluster nodes with Arc for servers and Azure Stack HCI registration will not be altered.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -EnvironmentName
 Specifies the Azure Environment.
 Default is AzureCloud.
@@ -136,6 +156,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Force
+Specifies that unregistration should continue even if we could not delete the Arc extensions on the nodes.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -GraphAccessToken
 Specifies the Graph access token.
 Specifying this along with ArmAccessToken and AccountId will avoid Azure interactive logon.
@@ -152,6 +187,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Region
+Specifies the Region the resource is created in Azure.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 9
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 Specifies the Azure Resource Group name.
 If not specified \<LocalClusterName\>-rg will be used as resource group name.