Merge pull request Azure#6495 from MabOneSdk/get-status-2

Adding Get-AzureRmRecoveryServicesBackupStatus cmdlet

Author: cormacpayne

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Models/CmdletParamEnums.cs

@@ -84,4 +84,10 @@ public enum ItemParams
         BackupManagementType,
         ExpiryDateTimeUTC,
     }
+
+    public enum ProtectionCheckParams
+    {
+        Name,
+        ResourceGroupName,
+    }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Models/Commands.RecoveryServices.Backup.Models.csproj

@@ -57,6 +57,7 @@
     <Compile Include="AzureVmModels\AzureVmRecoveryPoint.cs" />
     <Compile Include="BaseObjects.cs" />
     <Compile Include="CmdletParamEnums.cs" />
+    <Compile Include="CommonModels\ResourceBackupStatus.cs" />
     <Compile Include="CommonModels\Utils.cs" />
     <Compile Include="CommonModels\Enums.cs" />
     <Compile Include="CommonModels\PolicyRetentionObjects.cs" />

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Models/CommonModels/ResourceBackupStatus.cs

@@ -0,0 +1,58 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
+
+namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
+{
+    /// <summary>
+    /// Backup status of a resource.
+    /// </summary>
+    public class ResourceBackupStatus
+    {
+        /// <summary>
+        /// The Resource Name.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The Resource Group Name.
+        /// </summary>
+        public string ResourceGroupName { get; set; }
+
+        /// <summary>
+        /// If the resource is protected by some vault in the subscription, this contains the resource ID of that vault.
+        /// </summary>
+        public string VaultId { get; set; }
+
+        /// <summary>
+        /// Specifies whether the resource is protected by some vault in the subscription.
+        /// </summary>
+        public bool BackedUp { get; set; }
+
+        public ResourceBackupStatus(string name, string resourceGroupName, string vaultId, bool backedUp)
+        {
+            if (backedUp && string.IsNullOrEmpty(vaultId) ||
+                !backedUp && !string.IsNullOrEmpty(vaultId))
+            {
+                throw new ArgumentException($"Inconsistent parameters specified. backedUp: {backedUp} and vaultId: {vaultId}.");
+            }
+
+            Name = name;
+            ResourceGroupName = resourceGroupName;
+            VaultId = vaultId;
+            BackedUp = backedUp;
+        }
+    }
+}

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Models/Properties/Resources.Designer.cs

@@ -501,4 +501,7 @@ Path of the file along with filename: {0}
 
 Password to run the file: {1}</value>
   </data>
+  <data name="UnsupportedResourceTypeException" xml:space="preserve">
+    <value>The resource type {0} is currently not supported.</value>
+  </data>
 </root>

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Models/Properties/Resources.resx

@@ -61,5 +61,7 @@ public interface IPsBackupProvider
         RPMountScriptDetails ProvisionItemLevelRecoveryAccess();
 
         void RevokeItemLevelRecoveryAccess();
+
+        ResourceBackupStatus CheckBackupStatus();
     }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Providers/IPsBackupProvider.cs

@@ -479,6 +479,11 @@ public List<ItemBase> ListProtectedItems()
             return itemModels;
         }
 
+        public ResourceBackupStatus CheckBackupStatus()
+        {
+            throw new NotImplementedException();
+        }
+
         #region private
         private void ValidateAzureSqlWorkloadType(CmdletModel.WorkloadType type)
         {

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Providers/Providers/AzureSqlPsBackupProvider.cs

@@ -153,5 +153,10 @@ public List<ItemBase> ListProtectedItems()
         {
             throw new NotImplementedException();
         }
+
+        public ResourceBackupStatus CheckBackupStatus()
+        {
+            throw new NotImplementedException();
+        }
     }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Providers/Providers/DpmPsBackupProvider.cs

@@ -31,6 +31,7 @@
 using System.Text;
 using System.Text.RegularExpressions;
 using Microsoft.Azure.Commands.Common.Authentication;
+using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.ProviderModel
 {
@@ -923,6 +924,55 @@ public RetentionPolicyBase GetDefaultRetentionPolicyObject()
 
         }
 
+        public ResourceBackupStatus CheckBackupStatus()
+        {
+            string azureVmName = (string)ProviderData[ProtectionCheckParams.Name];
+            string azureVmResourceGroupName =
+                (string)ProviderData[ProtectionCheckParams.ResourceGroupName];
+
+            ODataQuery<ProtectedItemQueryObject> queryParams =
+                new ODataQuery<ProtectedItemQueryObject>(
+                    q => q.BackupManagementType
+                            == ServiceClientModel.BackupManagementType.AzureIaasVM &&
+                         q.ItemType == DataSourceType.VM);
+
+            var vaultIds = ServiceClientAdapter.ListVaults();
+            foreach (var vaultId in vaultIds)
+            {
+                ResourceIdentifier vaultIdentifier = new ResourceIdentifier(vaultId);
+
+                var items = ServiceClientAdapter.ListProtectedItem(
+                    queryParams,
+                    vaultName: vaultIdentifier.ResourceName,
+                    resourceGroupName: vaultIdentifier.ResourceGroupName);
+
+                if (items.Any(
+                    item =>
+                    {
+                        ResourceIdentifier vmIdentifier =
+                            new ResourceIdentifier(item.Properties.SourceResourceId);
+                        var itemVmName = vmIdentifier.ResourceName;
+                        var itemVmRgName = vmIdentifier.ResourceGroupName;
+
+                        return itemVmName.ToLower() == azureVmName.ToLower() &&
+                            itemVmRgName.ToLower() == azureVmResourceGroupName.ToLower();
+                    }))
+                {
+                    return new ResourceBackupStatus(
+                        azureVmName,
+                        azureVmResourceGroupName,
+                        vaultId,
+                        true);
+                }
+            }
+
+            return new ResourceBackupStatus(
+                azureVmName,
+                azureVmResourceGroupName,
+                null,
+                false);
+        }
+
         #region private
 
         private static CmdletModel.DailyRetentionFormat GetDailyRetentionFormat()
@@ -1286,8 +1336,6 @@ private void CopyScheduleTimeToRetentionTimes(CmdletModel.LongTermRetentionPolic
             }
         }
 
-        #endregion
-
         /// <summary>
         /// Generates ILR Response object for Windows VMs
         /// </summary>
@@ -1443,5 +1491,7 @@ private string ReplacePasswordInScriptContentAndReturn(ref string content)
 
             return password;
         }
+
+        #endregion
     }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Providers/Providers/IaasVmPsBackupProvider.cs

@@ -156,5 +156,10 @@ public List<ItemBase> ListProtectedItems()
         {
             throw new NotImplementedException();
         }
+
+        public ResourceBackupStatus CheckBackupStatus()
+        {
+            throw new NotImplementedException();
+        }
     }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Providers/Providers/MabPsBackupProvider.cs

@@ -226,5 +226,21 @@ public IPsBackupProvider GetProviderInstance(PsBackupProviderTypes providerType)
 
             return psBackupProvider;
         }
+
+        public IPsBackupProvider GetProviderInstance(string resourceType)
+        {
+            if (resourceType == "Microsoft.Compute/virtualMachines" ||
+                resourceType == "Microsoft.ClassicCompute/virtualMachines" ||
+                resourceType == "AzureVM")
+            {
+                return GetProviderInstance(PsBackupProviderTypes.IaasVm);
+            }
+            else
+            {
+                throw new ArgumentException(
+                    string.Format(Resources.UnsupportedResourceTypeException,
+                    resourceType));
+            }
+        }
     }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Providers/PsBackupProviderManager.cs

@@ -14,17 +14,16 @@
 
 using System.Collections.Generic;
 using System.Linq;
-using Microsoft.Azure.Management.RecoveryServices.Models;
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.ServiceClientAdapterNS
 {
     public partial class ServiceClientAdapter
     {
-        public List<Vault> ListVaults()
+        public List<string> ListVaults()
         {
             var response = RSAdapter.Client.Vaults.ListBySubscriptionIdWithHttpMessagesAsync(
                 cancellationToken: RSAdapter.CmdletCancellationToken).Result;
-            return response.Body.ToList();
+            return response.Body.Select(vault => vault.Id).ToList();
         }
     }
 }

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.ServiceClientAdapter/BMSAPIs/VaultAPIs.cs

@@ -146,6 +146,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="ScenarioTests\IaasVm\ProtectionCheckTests.cs" />
     <Compile Include="TestConstants.cs" />
     <None Include="packages.config">
       <SubType>Designer</SubType>
@@ -187,6 +188,9 @@
     <None Include="ScenarioTests\IaasVm\PolicyTests.ps1">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Include="ScenarioTests\IaasVm\ProtectionCheckTests.ps1">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Include="ScenarioTests\Mab\ContainerTests.ps1">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
@@ -259,6 +263,9 @@
     <None Include="SessionRecords\Microsoft.Azure.Commands.RecoveryServices.Backup.Test.ScenarioTests.PolicyTests\TestAzureVMPolicy.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Include="SessionRecords\Microsoft.Azure.Commands.RecoveryServices.Backup.Test.ScenarioTests.ProtectionCheckTests\TestAzureVMProtectionCheck.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
   <ItemGroup />
   <ItemGroup>

src/ResourceManager/RecoveryServices/Commands.RecoveryServices.Backup.Test/Commands.RecoveryServices.Backup.Test.csproj

@@ -14,18 +14,12 @@
 
 function Get-ResourceGroupLocation
 {
-    $namespace = "Microsoft.RecoveryServices"
-    $type = "vaults"
-    $resourceProvider = Get-AzureRmResourceProvider -ProviderNamespace $namespace | where {$_.ResourceTypes[0].ResourceTypeName -eq $type}
-  
-    if ($resourceProvider -eq $null)
-    {
-        return "westus";
-    }
-	else
-    {
-		return $resourceProvider.Locations[0]
-    }
+	$location = Get-Location "Microsoft.RecoveryServices" "vaults" "West US";
+	$outputLocation = $location.ToLower()
+	$outputLocation = $outputLocation -replace '\s', ''
+	$outputLocation = $outputLocation -replace '-', ''
+	$outputLocation = $outputLocation -replace '_', ''
+	return $outputLocation;
 }
 
 function Get-RandomSuffix(
@@ -189,6 +183,44 @@ function Create-VM(
 	return $vm
 }
 
+function Create-GalleryVM(
+	[string] $resourceGroupName, 
+	[string] $location, 
+	[int] $nick = 0)
+{
+	$suffix = $(Get-RandomSuffix 5) + $nick
+	$vmName = "PSTestGVM" + $suffix
+
+	$vm = Get-AzureRmVM -ResourceGroupName $resourceGroupName -Name $vmName -ErrorAction Ignore
+
+	if ($vm -eq $null)
+	{
+		$subnetConfigName = "PSTestSNC" + $suffix
+		$vnetName = "PSTestVNET" + $suffix
+		$pipName = "pstestpublicdns" + $suffix
+		$nsgName = "PSTestNSG" + $suffix
+		$dnsLabel = "pstestdnslabel" + "-" + $suffix
+
+		$UserName='demouser'
+		$PasswordString = $(Get-RandomSuffix 12)
+		$Password=$PasswordString| ConvertTo-SecureString -Force -AsPlainText
+		$Credential=New-Object PSCredential($UserName,$Password)
+
+		$vm = New-AzureRmVm `
+			-ResourceGroupName $resourceGroupName `
+			-Name $vmName `
+			-Location $location `
+			-SubnetName $subnetConfigName `
+			-SecurityGroupName $nsgName `
+			-PublicIpAddressName $pipName `
+			-ImageName "MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest" `
+			-Credential $Credential `
+			-DomainNameLabel $dnsLabel
+	}
+
+	return $vm
+}
+
 function Create-SA(
 	[string] $resourceGroupName, 
 	[string] $location)