Adding support for fetching MAB agent jobs (#12308)

* Fetch MAB Agent jobs

* Adding MabJob PS Object
* Adding support for BackupManagemenType 'MAB' in
  Get-AzRecoveryServicesBackupJob cmdlet

* updating help text and ChangeLog.md

* removing new line as per review comment

Author: hiaga

src/RecoveryServices/RecoveryServices.Backup.Helpers/Conversions/JobConversions.cs

@@ -51,6 +51,10 @@ public static CmdletModel.JobBase GetPSJob(JobResource serviceClientJob)
             {
                 response = GetPSAzureWorkloadJob(serviceClientJob);
             }
+            else if (serviceClientJob.Properties.GetType() == typeof(MabJob)) 
+            {
+                response = GetPSMabJob(serviceClientJob);
+            }            
 
             return response;
         }
@@ -156,6 +160,90 @@ private static CmdletModel.AzureVmJob GetPSAzureVmJob(JobResource serviceClientJ
             return response;
         }
 
+        /// <summary>
+        /// Creates the powershell MabJob object from service response.
+        /// </summary>
+        private static CmdletModel.JobBase GetPSMabJob(JobResource serviceClientJob)
+        {
+            CmdletModel.MabJob response;
+
+            MabJob mabJob = serviceClientJob.Properties as MabJob;
+
+            if (mabJob.ExtendedInfo != null)
+            {
+                response = new CmdletModel.MabJobDetails();
+            }
+            else
+            {
+                response = new CmdletModel.MabJob();
+            }
+            
+            // Transfer values from service job object to powershell job object. 
+            response.JobId = GetLastIdFromFullId(serviceClientJob.Id);
+            response.StartTime = GetJobStartTime(mabJob.StartTime);
+            response.EndTime = mabJob.EndTime;
+            response.Duration = GetJobDuration(mabJob.Duration);
+            response.Status = mabJob.Status;
+            response.WorkloadName = mabJob.EntityFriendlyName;
+            response.ActivityId = mabJob.ActivityId;
+            response.BackupManagementType =
+                CmdletModel.ConversionUtils.GetPsBackupManagementType(mabJob.BackupManagementType);
+            response.Operation = mabJob.Operation;
+
+            if (mabJob.ErrorDetails != null)
+            {
+                response.ErrorDetails = new List<CmdletModel.AzureJobErrorInfo>();
+                foreach (var mabError in mabJob.ErrorDetails)
+                {
+                    response.ErrorDetails.Add(GetPSMabErrorInfo(mabError));
+                }
+            }
+
+            // fill extended info if present
+            if (mabJob.ExtendedInfo != null)
+            {
+                CmdletModel.MabJobDetails detailedResponse = response as CmdletModel.MabJobDetails;
+
+                detailedResponse.DynamicErrorMessage = mabJob.ExtendedInfo.DynamicErrorMessage;
+                if (mabJob.ExtendedInfo.PropertyBag != null)
+                {
+                    detailedResponse.Properties = new Dictionary<string, string>();
+                    foreach (var key in mabJob.ExtendedInfo.PropertyBag.Keys)
+                    {
+                        detailedResponse.Properties.Add(key, mabJob.ExtendedInfo.PropertyBag[key]);
+                    }
+                }
+
+                if (mabJob.ExtendedInfo.TasksList != null)
+                {
+                    detailedResponse.SubTasks = new List<CmdletModel.MabJobSubTask>();
+                    foreach (var mabJobTask in mabJob.ExtendedInfo.TasksList)
+                    {
+                        detailedResponse.SubTasks.Add(new CmdletModel.MabJobSubTask()
+                        {
+                            Name = mabJobTask.TaskId,
+                            Status = mabJobTask.Status
+                        });
+                    }
+                }
+            }
+
+            return response;
+        }
+
+        private static CmdletModel.AzureJobErrorInfo GetPSMabErrorInfo(MabErrorInfo mabError)
+        {
+            CmdletModel.MabJobErrorInfo psErrorInfo = new CmdletModel.MabJobErrorInfo();
+            psErrorInfo.ErrorMessage = mabError.ErrorString;
+            if (mabError.Recommendations != null)
+            {
+                psErrorInfo.Recommendations = new List<string>();
+                psErrorInfo.Recommendations.AddRange(mabError.Recommendations);
+            }
+
+            return psErrorInfo;
+        }
+
         private static CmdletModel.JobBase GetPSAzureFileShareJob(JobResource serviceClientJob)
         {
             CmdletModel.AzureFileShareJob response;

src/RecoveryServices/RecoveryServices.Backup.Helpers/ServiceClientHelpers.cs

@@ -110,6 +110,9 @@ public static string
                 case CmdletModel.BackupManagementType.AzureStorage:
                     providerType = ServiceClientModel.BackupManagementType.AzureStorage.ToString();
                     break;
+                case CmdletModel.BackupManagementType.MAB:
+                    providerType = ServiceClientModel.BackupManagementType.MAB.ToString();
+                    break;
                 default:
                     break;
             }

src/RecoveryServices/RecoveryServices.Backup.Models/MabModels/MabJob.cs

@@ -0,0 +1,54 @@
+// ----------------------------------------------------------------------------------
+//
+// 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.Collections.Generic;
+
+namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
+{
+    /// <summary>
+    /// Represents MAB specific job class.
+    /// </summary>
+    public class MabJob : AzureJob { }
+
+    /// <summary>
+    /// MAB specific job details class.
+    /// </summary>
+    public class MabJobDetails : MabJob
+    {
+        /// <summary>
+        /// Context sensitive error message that might be helpful in debugging the issue. 
+        /// </summary>
+        public string DynamicErrorMessage { get; set; }
+
+        /// <summary>
+        /// Property bag consisting of the some MAB specific job details.
+        /// </summary>
+        public Dictionary<string, string> Properties { get; set; }
+
+        /// <summary>
+        /// List of sub tasks triggered as part of this job's operation.
+        /// </summary>
+        public List<MabJobSubTask> SubTasks { get; set; }
+    }
+
+    /// <summary>
+    /// MAB specific job error info class.
+    /// </summary>
+    public class MabJobErrorInfo : AzureJobErrorInfo { }
+
+    /// <summary>
+    /// MAB specific job sub-task class.
+    /// </summary>
+    public class MabJobSubTask : AzureJobSubTask { }
+}

src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Jobs/GetAzureRmRecoveryServicesBackupJob.cs

@@ -32,7 +32,7 @@ public class GetAzureRmRecoveryServicesBackupJob : RSBackupVaultCmdletBase
         /// <summary>
         /// List of supported BackupManagementTypes for this cmdlet. Used in help text creation.
         /// </summary>
-        private const string validBackupManagementTypes = "AzureVM, AzureStorage, AzureWorkload";
+        private const string validBackupManagementTypes = "AzureVM, AzureStorage, AzureWorkload, MAB";
 
         /// <summary>
         /// Filter value for status of job.

src/RecoveryServices/RecoveryServices/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 ## Upcoming Release
 * Azure Backup tuned cmdlets help text to be more accurate.
+* Azure Backup added support for fetching MAB agent jobs using `Get-AzRecoveryServicesBackupJob` cmdlet.
 
 ## Version 2.10.0
 * Azure Backup added support for fetching MAB items.

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

@@ -77,17 +77,25 @@ This script polls the first job that is currently in progress until the job has
 
 Note: You can use **Wait-AzRecoveryServicesBackupJob** cmdlet to wait for an Azure Backup job to finish instead of While loop.
 
+### Example 4: Get all AzureVM jobs in last 2 days which finished successfully
+
+```powershell
+$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
+$Jobs = Get-AzRecoveryServicesBackupJob  -VaultId $vault.ID  -Status Completed -From (Get-Date).AddDays(-2).ToUniversalTime() -BackupManagementType AzureVM
+```
+First cmdlet fetches the vault object. Second cmdlet stores all the AzureVM jobs in the given vault which completed in last 2 days to $jobs. Change the value of BackupManagementType parameter to MAB in order to fetch MAB agent jobs.
+
 ## PARAMETERS
 
 ### -BackupManagementType
 
-The class of resources being protected. Currently the values supported for this cmdlet are AzureVM, AzureStorage, AzureWorkload.
+The class of resources being protected. Currently the values supported for this cmdlet are AzureVM, AzureStorage, AzureWorkload, MAB.
 
 ```yaml
 Type: System.Nullable`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.BackupManagementType]
 Parameter Sets: (All)
 Aliases:
-Accepted values: AzureVM, AzureStorage, AzureWorkload
+Accepted values: AzureVM, AzureStorage, AzureWorkload, MAB
 
 Required: False
 Position: Named