[RecoveryServices.Backup] Added fix for enable protection and updated help for register container cmdlets (#19741)

* updated help text

fixed policy parameter in the Enable-AzRecoveryServicesBackupProtection cmdlet

added example for container re-registration

updated change log

* resolved static analysis issues
updated breakingChangeIssues.csv

Author: hiaga

src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/EnableAzureRmRecoveryServicesBackupProtection.cs

@@ -43,7 +43,7 @@ public class EnableAzureRmRecoveryServicesBackupProtection : RSBackupVaultCmdlet
         /// <summary>
         /// Policy to be associated with this item as part of the protection operation.
         /// </summary>
-        [Parameter(Position = 1, Mandatory = false, HelpMessage = ParamHelpMsgs.Policy.EnableProtectionPolicy)]
+        [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.EnableProtectionPolicy)]
         [ValidateNotNullOrEmpty]
         public PolicyBase Policy { get; set; }
 

src/RecoveryServices/RecoveryServices/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* [Breaking Change] Added fix for Enable-AzRecoveryServicesBackupProtection cmdlet. Resolved the null refrence issue by making policy a mandatory parameter.
 * [Breaking Change] Removed status filter from Get-AzRecoveryServicesBackupContainer command
 * Added SubTasks Duration for IaasVM job
 

src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupProtection.md

@@ -15,35 +15,34 @@ Enables or resumes backup for an item with a specified Backup protection policy.
 
 ### AzureVMComputeEnableProtection (Default)
 ```
-Enable-AzRecoveryServicesBackupProtection [[-Policy] <PolicyBase>] [-Name] <String>
- [-ResourceGroupName] <String> [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>]
- [-ExcludeAllDataDisks] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> [-ResourceGroupName] <String>
+ [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>] [-ExcludeAllDataDisks] [-VaultId <String>]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### AzureVMClassicComputeEnableProtection
 ```
-Enable-AzRecoveryServicesBackupProtection [[-Policy] <PolicyBase>] [-Name] <String> [-ServiceName] <String>
+Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String> [-ServiceName] <String>
  [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>] [-ExcludeAllDataDisks] [-VaultId <String>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### AzureFileShareEnableProtection
 ```
-Enable-AzRecoveryServicesBackupProtection [[-Policy] <PolicyBase>] [-Name] <String>
+Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Name] <String>
  [-StorageAccountName] <String> [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
  [-Confirm] [<CommonParameters>]
 ```
 
 ### AzureWorkloadEnableProtection
 ```
-Enable-AzRecoveryServicesBackupProtection [[-Policy] <PolicyBase>] [-ProtectableItem] <ProtectableItemBase>
+Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-ProtectableItem] <ProtectableItemBase>
  [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ModifyProtection
 ```
-Enable-AzRecoveryServicesBackupProtection [[-Policy] <PolicyBase>] [-Item] <ItemBase>
+Enable-AzRecoveryServicesBackupProtection [-Policy] <PolicyBase> [-Item] <ItemBase>
  [-InclusionDisksList <String[]>] [-ExclusionDisksList <String[]>] [-ResetExclusionSettings]
  [-ExcludeAllDataDisks] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [-Token <String>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -75,6 +74,8 @@ The third cmdlet sets the Backup protection policy for the ARM virtual machine n
 Enables backup for an item with a specified Backup protection policy or resumes backup for an item that has data retained when backup was stopped.
 
 <!-- Aladdin Generated Example -->
+
+
 ```powershell
 Enable-AzRecoveryServicesBackupProtection -Item $Item -Policy $Pol -VaultId $vault
 ```
@@ -181,7 +182,7 @@ Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.PolicyBase
 Parameter Sets: (All)
 Aliases:
 
-Required: False
+Required: True
 Position: 1
 Default value: None
 Accept pipeline input: False

src/RecoveryServices/RecoveryServices/help/Get-AzRecoveryServicesBackupContainer.md

@@ -16,8 +16,8 @@ Gets Backup containers.
 
 ```
 Get-AzRecoveryServicesBackupContainer [-ContainerType] <ContainerType> [[-BackupManagementType] <String>]
- [[-FriendlyName] <String>] [[-ResourceGroupName] <String>] [[-Status] <ContainerRegistrationStatus>]
- [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+ [[-FriendlyName] <String>] [[-ResourceGroupName] <String>] [-VaultId <String>]
+ [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -33,7 +33,7 @@ Set the vault context by using the -VaultId parameter.
 
 ```powershell
 $vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
-Get-AzRecoveryServicesBackupContainer -ContainerType "AzureVM" -Status "Registered" -FriendlyName "V2VM" -VaultId $vault.ID
+Get-AzRecoveryServicesBackupContainer -ContainerType "AzureVM" -FriendlyName "V2VM" -VaultId $vault.ID
 ```
 
 This command gets the container named V2VM of type AzureVM.
@@ -65,7 +65,7 @@ This parameter is used to differentiate Windows machines that are backed up usin
 Type: System.String
 Parameter Sets: (All)
 Aliases:
-Accepted values: AzureVM, MAB, AzureWorkload, AzureStorage
+Accepted values: AzureVM, AzureStorage, AzureWorkload, MAB
 
 Required: False
 Position: 2
@@ -146,26 +146,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Status
-
-Specifies the container registration status.
-The acceptable values for this parameter are:
-
-- Registered
-
-```yaml
-Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerRegistrationStatus
-Parameter Sets: (All)
-Aliases:
-Accepted values: Registered
-
-Required: False
-Position: 5
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -VaultId
 
 ARM ID of the Recovery Services Vault.

src/RecoveryServices/RecoveryServices/help/Register-AzRecoveryServicesBackupContainer.md

@@ -31,13 +31,22 @@ This command allows Azure Backup to convert the Resource to a Backup Container w
 
 ## EXAMPLES
 
-### Example 1
+### Example 1 Register a backup container
 ```powershell
 Register-AzRecoveryServicesBackupContainer -ResourceId <AzureVMID> -VaultId <vaultID> -WorkloadType MSSQL -BackupManagementType AzureWorkload
 ```
 
 The cmdlet registers an azure VM as a container for the workload MSSQL.
 
+### Example 2 Re-register a backup container
+```powershell
+$vault = Get-AzRecoveryServicesVault -ResourceGroupName "rgName"  -Name "vaultName"
+$container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureVMAppContainer -VaultId $vault.ID 
+Register-AzRecoveryServicesBackupContainer -Container $container[-1] -BackupManagementType AzureWorkload -WorkloadType MSSQL -VaultId $vault.ID
+```
+
+The first command fetches the recovery services vault. The second command fetches all the backup containers registered with the recovery services vault. The third command triggers a re-register operation for the container $container[-1], to re-register an already registered container we pass -Container parameter.
+
 ## PARAMETERS
 
 ### -BackupManagementType

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

@@ -1,4 +1,10 @@
 "AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
 "Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.UpdateAzureRmRecoveryServicesVault","Update-AzRecoveryServicesVault","0","1060","The parameter set 'AzureRSVaultAddMSIdentity' for cmdlet 'Update-AzRecoveryServicesVault' is no longer the default parameter set.","Change the default parameter for cmdlet 'Update-AzRecoveryServicesVault' back to 'AzureRSVaultAddMSIdentity'."
 "Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.GetAzureRmRecoveryServicesBackupContainer","Get-AzRecoveryServicesBackupContainer","0","2000","The cmdlet 'Get-AzRecoveryServicesBackupContainer' no longer supports the parameter 'Status' and no alias was found for the original parameter name.","Add the parameter 'Status' back to the cmdlet 'Get-AzRecoveryServicesBackupContainer', or add an alias to the original parameter name."
-"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.GetAzureRmRecoveryServicesBackupContainer","Get-AzRecoveryServicesBackupContainer","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Get-AzRecoveryServicesBackupContainer' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Get-AzRecoveryServicesBackupContainer'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.GetAzureRmRecoveryServicesBackupContainer","Get-AzRecoveryServicesBackupContainer","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Get-AzRecoveryServicesBackupContainer' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Get-AzRecoveryServicesBackupContainer'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.EnableAzureRmRecoveryServicesBackupProtection","Enable-AzRecoveryServicesBackupProtection","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Enable-AzRecoveryServicesBackupProtection' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Enable-AzRecoveryServicesBackupProtection'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.EnableAzureRmRecoveryServicesBackupProtection","Enable-AzRecoveryServicesBackupProtection","0","1050","The parameter set 'AzureVMClassicComputeEnableProtection' for cmdlet 'Enable-AzRecoveryServicesBackupProtection' has been removed.","Add parameter set 'AzureVMClassicComputeEnableProtection' back to cmdlet 'Enable-AzRecoveryServicesBackupProtection'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.EnableAzureRmRecoveryServicesBackupProtection","Enable-AzRecoveryServicesBackupProtection","0","1050","The parameter set 'AzureVMComputeEnableProtection' for cmdlet 'Enable-AzRecoveryServicesBackupProtection' has been removed.","Add parameter set 'AzureVMComputeEnableProtection' back to cmdlet 'Enable-AzRecoveryServicesBackupProtection'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.EnableAzureRmRecoveryServicesBackupProtection","Enable-AzRecoveryServicesBackupProtection","0","1050","The parameter set 'AzureFileShareEnableProtection' for cmdlet 'Enable-AzRecoveryServicesBackupProtection' has been removed.","Add parameter set 'AzureFileShareEnableProtection' back to cmdlet 'Enable-AzRecoveryServicesBackupProtection'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.EnableAzureRmRecoveryServicesBackupProtection","Enable-AzRecoveryServicesBackupProtection","0","1050","The parameter set 'AzureWorkloadEnableProtection' for cmdlet 'Enable-AzRecoveryServicesBackupProtection' has been removed.","Add parameter set 'AzureWorkloadEnableProtection' back to cmdlet 'Enable-AzRecoveryServicesBackupProtection'."
+"Az.RecoveryServices","Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.EnableAzureRmRecoveryServicesBackupProtection","Enable-AzRecoveryServicesBackupProtection","0","1050","The parameter set 'ModifyProtection' for cmdlet 'Enable-AzRecoveryServicesBackupProtection' has been removed.","Add parameter set 'ModifyProtection' back to cmdlet 'Enable-AzRecoveryServicesBackupProtection'."