Updated help, change log and fixed tests.

Author: Samuel Anudeep

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Test/ScenarioTests/IaasVm/ProtectionCheckTests.ps1

@@ -28,22 +28,22 @@ function Test-AzureVMProtectionCheck
 			-Type AzureVM
 
 		Assert-NotNull $status
-		Assert-False $status.BackedUp
+		Assert-False { $status.BackedUp }
 
 		$vault = Create-RecoveryServicesVault $resourceGroupName $location
 		Enable-Protection $vault $vm
 
 		$status = Get-AzureRmRecoveryServicesBackupStatus -ResourceId $vm.Id
 		Assert-NotNull $status
-		Assert-True $status.BackedUp
-		Assert-True { $status.VaultId -eq $vaultId }
+		Assert-True { $status.BackedUp }
+		Assert-True { $status.VaultId -eq $vault.ID }
 
 		Delete-Vault $vault
 
 		$status = Get-AzureRmRecoveryServicesBackupStatus -ResourceId $vm.Id
 
 		Assert-NotNull $status
-		Assert-False $status.BackedUp
+		Assert-False { $status.BackedUp }
 	}
 	finally
 	{

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/ChangeLog.md

@@ -19,7 +19,7 @@
 -->
 ## Current Release
 * Fixed formatting of OutputType in help files
-* Added Get-AzureRmRecoveryServicesBackupStatus cmdlet. This cmdlet takes a VM ID and returns null (if this VM is not protected by any vault in the subscription) and the vault name (if the VM is protected by some vault). 
+* Added Get-AzureRmRecoveryServicesBackupStatus cmdlet. This cmdlet takes a VM ID and checks if the VM is protected by some vault in the subscription. If there exists such a vault, the cmdlet outputs the vault details.
 
 ## Version 4.2.0
 * Added -Vault parameter to RecoveryServices.Backup cmdlets. When passed, this will override the Set-AzureRmRecoveryServicesContext cmdlet.

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/AzureRM.RecoveryServices.Backup.md

@@ -54,7 +54,7 @@ Downloads a script to mount all the files of the recovery point.
 Gets a base schedule policy object.
 
 ### [Get-AzureRmRecoveryServicesBackupStatus](Get-AzureRmRecoveryServicesBackupStatus.md)
-The command returns null/empty if the specified resource is not protected under any Recovery Services vault in the subscription. If it is protected, the relevant vault details will be returned.
+Checks whether your ARM resource is backed up or not.
 
 ### [New-AzureRmRecoveryServicesBackupProtectionPolicy](New-AzureRmRecoveryServicesBackupProtectionPolicy.md)
 Creates a Backup protection policy.

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup/help/Get-AzureRmRecoveryServicesBackupStatus.md

@@ -1,6 +1,6 @@
 ---
 external help file: Microsoft.Azure.Commands.RecoveryServices.Backup.dll-Help.xml
-online version: 
+online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.recoveryservices.backup/get-azurermrecoveryservicesbackupstatus
 schema: 2.0.0
 ---
 
@@ -14,12 +14,13 @@ Checks whether your ARM resource is backed up or not.
 ### Name (Default)
 ```
 Get-AzureRmRecoveryServicesBackupStatus -Name <String> -ResourceGroupName <String> -Type <String>
- [-DefaultProfile <IAzureContextContainer>]
+ [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### Id
 ```
 Get-AzureRmRecoveryServicesBackupStatus -ResourceId <String> [-DefaultProfile <IAzureContextContainer>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -30,16 +31,14 @@ If it is protected, the relevant vault details will be returned.
 
 ### Example 1
 ```
-PS C:\> $isVMBackedUp = Get-AzureRmRecoveryServicesBackupStatus -Name “myAzureVM” -ResourceGroupName “myAzureVMRG” -ResourceType “AzureVM”
-PS C:\> If ($isVMBackedUp -eq “”) {
-Get-AzureRmRecoveryServicesVault -Name "testvault"  -ResourceGroupName "vaultResourceGroup" | Set-AzureRmRecoveryServicesVaultContext
-$defPolicy = Get-AzureRmRecoveryServicesBackupProtectionPolicy -WorkloadType "AzureVM"
-Enable-AzureRmRecoveryServicesBackupProtection -Policy $defpol -Name "myAzureVM" -ResourceGroupName "myAzureVMRG"
+PS C:\> $status = Get-AzureRmRecoveryServicesBackupStatus -Name "myAzureVM" -ResourceGroupName "myAzureVMRG" -ResourceType "AzureVM"
+PS C:\> If ($status.BackedUp -eq $false) {
+$vault = Get-AzureRmRecoveryServicesVault -Name "testvault" -ResourceGroupName "vaultResourceGroup"
+$defPolicy = Get-AzureRmRecoveryServicesBackupProtectionPolicy -Vault $vault -WorkloadType "AzureVM"
+Enable-AzureRmRecoveryServicesBackupProtection -Vault $vault -Policy $defpol -Name "myAzureVM" -ResourceGroupName "myAzureVMRG"
 }
 ```
 
-{{ Add example description here }}
-
 ## PARAMETERS
 
 ### -DefaultProfile
@@ -118,15 +117,16 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### System.String
 
-
 ## OUTPUTS
 
-### System.String
-
+### Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ResourceBackupStatus
 
 ## NOTES