Updated help text

Author: siddharth7

src/RecoveryServices/RecoveryServices.Backup/ParamHelpMsgs.cs

@@ -30,16 +30,16 @@ internal static class Container
             public const string RegisteredContainer = "The recovery services backup container.";
             public const string FriendlyName = "The name of the resource being managed by the" +
                 " Azure Backup service (for example: resource name of the VM).";
-            public const string ResourceId = "Azure VM Id";
+            public const string ResourceId = "ID of the Azure Resource containing items to be protected by Azure Backup service. Currently, only Azure VM resource IDs are supported.";
             public const string ContainerObj = "Container object that needs to be re registered.";
         }
 
         internal static class Common
         {
             public const string Vault = "The Azure Backup vault object which is the parent resource.";
             public const string VaultId = "Resource ID of the Recovery Services Vault.";
-            public const string WorkloadType = "Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles).";
-            public const string BackupManagementType = "Backup Management type of the resource (for example: MAB, DPM).";
+            public const string WorkloadType = "Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles, MSSQL).";
+            public const string BackupManagementType = "Backup Management type of the resource (for example: MAB, DPM, AzureWorkload).";
             public const string ConfirmationMessage = "Don't ask for confirmation.";
         }
 
@@ -72,7 +72,7 @@ internal static class Item
             public const string AzureVMServiceName = "Cloud Service Name for Azure Classic Compute VM.";
             public const string AzureVMResourceGroupName = "Resource Group Name for Azure Compute VM .";
             public const string ProtectedItem = "Filter value for status of job.";
-            public const string ProtectableItem = "Protectabe item";
+            public const string ProtectableItem = "Specifies the protectable item to be protected using Azure Backup.";
             public const string ProtectionStatus = "Protection status of Item";
             public const string Status = "Status of the data source";
             public const string Container = "Container where the item resides";
@@ -86,18 +86,18 @@ internal static class Item
             public const string AzureFileShareName = "Azure FileShare Name.";
             public const string AzureFileStorageAccountName = "Azure file share storage account name";
             public const string AzureFileStorageAccountResourceGroupName = "Azure file share storage account resource group name";
-            public const string BackupType = "Type of backup to be performed";
-            public const string EnableCompression = "If enabling compression is required";
-            public const string ParentID = "Parent ID";
+            public const string BackupType = "Specifies the type of backup to be taken for an on-demand backup. Allowed values are “CopyOnlyFull”, “Full”, “Differential”, “Log”.";
+            public const string EnableCompression = "A switch which will specify that the requested on-demand SQL backup should be compressed.";
+            public const string ParentID = "Specified the ARM ID of an Instance or AG.";
         }
 
         internal static class ProtectableItem
         {
-            public const string ItemType = "Protectable Item type.";
-            public const string ItemId = "Input Id";
-            public const string ItemObject = "Input Item";
-            public const string Name = "Name";
-            public const string ServerName = "Server Name";
+            public const string ItemType = "Specifies the type of protectable item. Applicable values: (SQLDataBase, SQLInstance, SQLAvailabilityGroup).";
+            public const string ItemId = "Specifies the parent entity under which the protectable items (DBs) are to be retrieved. IDs of protectable item types SQLInstance, SQLAvailabilityGroup are applicable.";
+            public const string ItemObject = "Specifies the protectable item object that can be passed as an input.";
+            public const string Name = "Specifies the name of the Database, Instance or AvailabilityGroup.";
+            public const string ServerName = "Specifies the name of the server to which the item belongs.";
         }
 
         internal static class RecoveryPoint
@@ -156,10 +156,10 @@ internal static class ProtectionCheck
 
         internal static class RecoveryPointConfig
         {
-            public const string Item = "Item";
-            public const string TargetItem = "TargetItem";
-            public const string OriginalWorkloadRestore = "OriginalWorkloadRestore";
-            public const string AlternateWorkloadRestore = "AlternateWorkloadRestore";
+            public const string Item = "Specifies the backup item on which the restore operation is being performed.";
+            public const string TargetItem = "Specifies the target on which the DB needs to be restored. For SQL restores, it needs to be of protectable item type SQLInstance only.";
+            public const string OriginalWorkloadRestore = "Specifies that the backed up DB is to be overwritten with the DB information present in the recovery point.";
+            public const string AlternateWorkloadRestore = "Specifies that the backed up DB should be restored as a new DB in another instance or as a new DB in the same instance";
         }
     }
-}
+}

src/RecoveryServices/RecoveryServices/ChangeLog.md

@@ -21,6 +21,7 @@
 * Added Sql server in Azure VM support
 * SDK Update
 * Removed VMappContainer check in Get-ProtectableItem
+* Added Name and ServerName as parameters for Get-ProtectableItem
 
 ## Version 1.0.1
 * Release with updated Authentication dependency

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

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Enable-AzRecoveryServicesBackupAutoProtection
 
 ## SYNOPSIS
-Enables auto backup for a protectable item with a specified Backup protection policy.
+This commands allows users to automatically protect all existing unprotected DBs and any DB which will be added later with the given policy. Azure backup service will then regularly scan auto-protected containers for any new DBs and automatically protect them.
 
 ## SYNTAX
 
@@ -37,7 +37,7 @@ The second cmdlet sets the Backup protection policy for the AzureWorkload using
 ## PARAMETERS
 
 ### -BackupManagementType
-Backup Management type of the resource (for example: MAB, DPM).
+Backup Management type of the resource (for example: MAB, DPM, AzureWorkload).
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType
@@ -68,7 +68,7 @@ Accept wildcard characters: False
 ```
 
 ### -InputItem
-Item Id
+Specifies the protectable item object that can be passed as an input.
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase
@@ -128,7 +128,7 @@ Accept wildcard characters: False
 ```
 
 ### -WorkloadType
-Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles).
+Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles, MSSQL).
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType
@@ -187,4 +187,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS

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

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-AzRecoveryServicesBackupProtectableItem
 
 ## SYNOPSIS
-Get protectable items from a container.
+This command will retrieve all protectable items within a certain container or across all registered containers. It will consist of all the elements of the hierarchy of the application. Returns DBs and their upper tier entities like Instance, AvailabilityGroup etc.
 
 ## SYNTAX
 
@@ -80,7 +80,7 @@ Accept wildcard characters: False
 ```
 
 ### -ItemType
-Protectable Item type.
+Specifies the type of protectable item. Applicable values: (SQLDataBase, SQLInstance, SQLAvailabilityGroup).
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemType
@@ -96,7 +96,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-Name
+Specifies the name of the Database, Instance or AvailabilityGroup.
 
 ```yaml
 Type: System.String
@@ -111,7 +111,7 @@ Accept wildcard characters: False
 ```
 
 ### -ParentID
-Parent ID
+Specified the ARM ID of an Instance or AG.
 
 ```yaml
 Type: System.String
@@ -126,7 +126,7 @@ Accept wildcard characters: False
 ```
 
 ### -ServerName
-Server Name
+Specifies the name of the server to which the item belongs.
 
 ```yaml
 Type: System.String
@@ -156,7 +156,7 @@ Accept wildcard characters: False
 ```
 
 ### -WorkloadType
-Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles).
+Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles, MSSQL).
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType
@@ -185,4 +185,4 @@ System.String
 
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS

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

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-AzRecoveryServicesBackupRecoveryLogChain
 
 ## SYNOPSIS
-Get time ranges for a backed up item.
+This command lists the start and end points of the unbroken log chain of the given backup item. Use it to determine whether the point-in-time, to which the user wants the DB to be restored, is valid or not.
 
 ## SYNTAX
 
@@ -135,4 +135,4 @@ System.String
 
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS

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

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-AzRecoveryServicesBackupWorkloadRecoveryConfig
 
 ## SYNOPSIS
-Get recovery plan for a backup up item.
+This command constructs the recovery configuration of a backed up item such as SQL DB. The configuration object stores all details such as the recovery mode, target destinations for the restore and application specific parameters like target physical paths for SQL.
 
 ## SYNTAX
 
@@ -46,7 +46,7 @@ THe third cmdlet crreats a recovery plan for a alternate location restore.
 ## PARAMETERS
 
 ### -AlternateWorkloadRestore
-AlternateWorkloadRestore
+Specifies that the backed up DB is to be overwritten with the DB information present in the recovery point.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -76,7 +76,7 @@ Accept wildcard characters: False
 ```
 
 ### -Item
-Item
+Specifies the backup item on which the restore operation is being performed.
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ItemBase
@@ -91,7 +91,7 @@ Accept wildcard characters: False
 ```
 
 ### -OriginalWorkloadRestore
-OriginalWorkloadRestore
+Specifies that the backed up DB is to be overwritten with the DB information present in the recovery point.
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -136,7 +136,7 @@ Accept wildcard characters: False
 ```
 
 ### -TargetItem
-TargetItem
+Specifies the target on which the DB needs to be restored. For SQL restores, it needs to be of protectable item type SQLInstance only.
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ProtectableItemBase
@@ -210,4 +210,4 @@ System.String
 
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS

src/RecoveryServices/RecoveryServices/help/Initialize-AzRecoveryServicesBackupProtectableItem.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Initialize-AzRecoveryServicesBackupProtectableItem
 
 ## SYNOPSIS
-Enquires for new DBs in the workload.
+This command triggers the discovery of any unprotected items of the given workload type in the given container. If the DB application is not auto-protected use this command to discover new DBs whenever they are added and proceed to protect them.
 
 ## SYNTAX
 
@@ -77,7 +77,7 @@ Accept wildcard characters: False
 ```
 
 ### -WorkloadType
-Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles).
+Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles, MSSQL).
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType
@@ -106,4 +106,4 @@ System.String
 
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS

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

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Register-AzRecoveryServicesBackupContainer
 
 ## SYNOPSIS
-Registers a protectable container.
+This command allows Azure Backup to convert the ‘Resource’ to a ‘Backup Container’ which is then registered to the given Recovery services vault. The Azure Backup service can then discover workloads of the given workload type within this container to be protected later.
 
 ## SYNTAX
 
@@ -64,7 +64,7 @@ Accept wildcard characters: False
 ```
 
 ### -ResourceId
-Azure VM Id
+ID of the Azure Resource whose representative item needs to be checked if it is already protected by some RecoveryServices Vault in the subscription.
 
 ```yaml
 Type: System.String
@@ -94,7 +94,7 @@ Accept wildcard characters: False
 ```
 
 ### -WorkloadType
-Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles).
+Workload type of the resource (for example: AzureVM, WindowsServer, AzureFiles, MSSQL).
 
 ```yaml
 Type: Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.WorkloadType
@@ -153,4 +153,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS