Merge pull request Azure#10971 from MabOneSdk/users/sarath/AFS-GA-Fix

Powershell Fix for AFS GA

Author: markcowl

src/RecoveryServices/RecoveryServices.Backup.Models/AzureFileShareModels/AzureFileShareItem.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using System;
+using System.Runtime.Versioning;
 using Microsoft.Azure.Management.RecoveryServices.Backup.Models;
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
@@ -27,6 +28,16 @@ public class AzureFileShareItem : AzureItem
         /// </summary>
         public string ParentContainerFabricId { get; set; }
 
+        /// <summary>
+        /// FriendlyName of the file share item
+        /// </summary>
+        public string FriendlyName { get; set; }
+
+        /// <summary>
+        /// Resource State of the FileShare
+        /// </summary>
+        public string ResourceState { get; set; }
+
         /// <summary>
         /// Constructor. Takes the service client object representing the protected item 
         /// and converts it in to the PS protected item model
@@ -45,6 +56,12 @@ public AzureFileShareItem(ProtectedItemResource protectedItemResource,
             ProtectionState =
                 EnumUtils.GetEnum<ItemProtectionState>(protectedItem.ProtectionState.ToString());
             ProtectionStatus = EnumUtils.GetEnum<ItemProtectionStatus>(protectedItem.ProtectionStatus);
+            FriendlyName = protectedItem.FriendlyName;
+            ResourceState = "";
+            if(protectedItem.ExtendedInfo != null && protectedItem.ExtendedInfo.ResourceState != null)
+            {
+                ResourceState = protectedItem.ExtendedInfo.ResourceState;
+            }
         }
     }
 

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

@@ -116,7 +116,8 @@ public enum ItemParams
         StorageAccountName,
         BackupType,
         EnableCompression,
-        DeleteState
+        DeleteState,
+        FriendlyName
     }
 
     public enum ProtectionCheckParams

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

@@ -580,4 +580,7 @@ Please contact Microsoft for further assistance.</value>
   <data name="AFSDiscoveryFailure" xml:space="preserve">
     <value>Failed to discover FileShare {0} under {1}. Please make sure names are correct and FileShare is not deleted</value>
   </data>
+  <data name="FriendlyNamePassedWarning" xml:space="preserve">
+    <value>A friendly name might return multiple items since it is not unique. To get a unique item, please use the -name parameter. Pass the value displayed under the name column when displayed as a table or use the name field in the PS object</value>
+  </data>
 </root>

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

@@ -152,18 +152,31 @@ public List<ProtectedItemResource> ListProtectedItemsByContainer(
             string itemName,
             string vaultName,
             string resourceGroupName,
-            Action<CmdletModel.ItemBase, ProtectedItemResource> extendedInfoProcessor)
+            Action<CmdletModel.ItemBase, ProtectedItemResource> extendedInfoProcessor, string friendlyName = null)
         {
             List<ProtectedItemResource> protectedItemGetResponses =
                 new List<ProtectedItemResource>();
 
-            if (!string.IsNullOrEmpty(itemName))
+            if (!string.IsNullOrEmpty(itemName) || !string.IsNullOrEmpty(friendlyName))
             {
                 protectedItems = protectedItems.Where(protectedItem =>
                 {
                     Dictionary<CmdletModel.UriEnums, string> dictionary = HelperUtils.ParseUri(protectedItem.Id);
+
                     string protectedItemUri = HelperUtils.GetProtectedItemUri(dictionary, protectedItem.Id);
-                    return protectedItemUri.ToLower().Contains(itemName.ToLower());
+
+                    bool filteredByUniqueName = itemName != null && (protectedItemUri.ToLower().Contains(itemName.ToLower()) );
+                    bool filteredByFriendlyName = false;
+
+                    if (protectedItem.Properties.BackupManagementType == "AzureStorage" && protectedItem.Properties.WorkloadType == "AzureFileShare")
+                    {
+
+                        string protectedItemFriendlyName = (protectedItem.Properties as AzureFileshareProtectedItem).FriendlyName;
+                        filteredByUniqueName = filteredByUniqueName || ( itemName != null && protectedItemFriendlyName.ToLower() == itemName.ToLower() );
+                        filteredByFriendlyName = friendlyName != null && protectedItemFriendlyName.ToLower() == friendlyName.ToLower();
+                    }
+
+                    return filteredByUniqueName || filteredByFriendlyName;
                 }).ToList();
 
                 ODataQuery<GetProtectedItemQueryObject> getItemQueryParams =
@@ -185,6 +198,7 @@ public List<ProtectedItemResource> ListProtectedItemsByContainer(
                 }
             }
 
+
             List<CmdletModel.ItemBase> itemModels = ConversionHelpers.GetItemModelList(protectedItems);
 
             if (!string.IsNullOrEmpty(itemName))

src/RecoveryServices/RecoveryServices.Backup.Providers/AzureWorkloadProviderHelper.cs

@@ -618,6 +618,12 @@ public List<ItemBase> ListProtectedItems()
             CmdletModel.WorkloadType workloadType =
                 (CmdletModel.WorkloadType)ProviderData[ItemParams.WorkloadType];
             PolicyBase policy = (PolicyBase)ProviderData[PolicyParams.ProtectionPolicy];
+            string friendlyName = (string)ProviderData[ItemParams.FriendlyName];
+
+            if( itemName != null && isFriendlyName(itemName) )
+            {
+                Logger.Instance.WriteWarning(Resources.FriendlyNamePassedWarning);
+            }
 
             // 1. Filter by container
             List<ProtectedItemResource> protectedItems = AzureWorkloadProviderHelper.ListProtectedItemsByContainer(
@@ -650,7 +656,7 @@ public List<ItemBase> ListProtectedItems()
                         (int)(serviceClientExtendedInfo.RecoveryPointCount.HasValue ?
                             serviceClientExtendedInfo.RecoveryPointCount : 0);
                     ((AzureFileShareItem)itemModel).ExtendedInfo = extendedInfo;
-                });
+                }, friendlyName);
 
             // 3. Filter by item's Protection Status
             if (protectionStatus != 0)
@@ -906,5 +912,12 @@ public List<PointInTimeBase> GetLogChains()
         {
             throw new NotImplementedException();
         }
+
+        private bool isFriendlyName(string name)
+        {
+            if (name.Contains(";"))
+                return false;
+            return true;
+        }
     }
 }

src/RecoveryServices/RecoveryServices.Backup.Providers/Providers/AzureFilesPsBackupProvider.cs

@@ -98,6 +98,13 @@ public class GetAzureRmRecoveryServicesBackupItem : RSBackupVaultCmdletBase
         [ValidateNotNullOrEmpty]
         public ItemDeleteState DeleteState { get; set; }
 
+        /// <summary>
+        /// Friendly Name of the item, Applicable only in case of Azure File Share item.
+        /// </summary>
+        [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Item.FriendlyName)]
+        [ValidateNotNullOrEmpty]
+        public string FriendlyName { get; set; }
+
         public override void ExecuteCmdlet()
         {
             ExecutionBlock(() =>
@@ -121,6 +128,7 @@ public override void ExecuteCmdlet()
                         { ItemParams.ProtectionStatus, ProtectionStatus },
                         { ItemParams.ProtectionState, ProtectionState },
                         { ItemParams.WorkloadType, WorkloadType },
+                        { ItemParams.FriendlyName, FriendlyName }
                     }, ServiceClientAdapter);
 
                 IPsBackupProvider psBackupProvider = null;

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

@@ -69,7 +69,7 @@ internal static class Job
 
         internal static class Item
         {
-            public const string ItemName = "Name of the item.";
+            public const string ItemName = "UniqueName of the backed up 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.";
@@ -91,6 +91,7 @@ internal static class Item
             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.";
+            public const string FriendlyName = "FriendlyName of the backed up item";
         }
 
         internal static class ProtectableItem

src/RecoveryServices/RecoveryServices.Backup/ParamHelpMsgs.cs

@@ -566,6 +566,10 @@
             <Label>Name</Label>
             <Width>40</Width>
           </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>FriendlyName</Label>
+            <Width>20</Width>
+          </TableColumnHeader>
           <TableColumnHeader>
             <Label>ContainerType</Label>
             <Width>20</Width>
@@ -582,13 +586,24 @@
             <Label>ProtectionStatus</Label>
             <Width>20</Width>
           </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>LastBackupStatus</Label>
+            <Width>20</Width>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>ResourceState</Label>
+            <Width>20</Width>
+          </TableColumnHeader>
         </TableHeaders>
         <TableRowEntries>
           <TableRowEntry>
             <TableColumnItems>
               <TableColumnItem>
                 <PropertyName>Name</PropertyName>
               </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>FriendlyName</PropertyName>
+              </TableColumnItem>
               <TableColumnItem>
                 <PropertyName>ContainerType</PropertyName>
               </TableColumnItem>
@@ -601,6 +616,12 @@
               <TableColumnItem>
                 <PropertyName>ProtectionStatus</PropertyName>
               </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>LastBackupStatus</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ResourceState</PropertyName>
+              </TableColumnItem>
             </TableColumnItems>
           </TableRowEntry>
         </TableRowEntries>

src/RecoveryServices/RecoveryServices.Backup/RecoveryServices.Backup.format.ps1xml

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Azure Backup Added filtering of backup item based on friendly name.
 
 ## Version 2.5.0
 * Azure Site Recovery support for removing a replicated disk.

src/RecoveryServices/RecoveryServices/ChangeLog.md

@@ -18,24 +18,24 @@ Gets the items from a container in Backup.
 ```
 Get-AzRecoveryServicesBackupItem [-Container] <ContainerBase> [[-Name] <String>]
  [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>]
- [-WorkloadType] <WorkloadType> [[-DeleteState] <ItemDeleteState>] [-VaultId <String>]
+ [-WorkloadType] <WorkloadType> [[-DeleteState] <ItemDeleteState>] [-FriendlyName <String>] [-VaultId <String>]
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### GetItemsForVault
 ```
 Get-AzRecoveryServicesBackupItem [-BackupManagementType] <BackupManagementType> [[-Name] <String>]
  [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>]
- [-WorkloadType] <WorkloadType> [[-DeleteState] <ItemDeleteState>] [-VaultId <String>]
+ [-WorkloadType] <WorkloadType> [[-DeleteState] <ItemDeleteState>] [-FriendlyName <String>] [-VaultId <String>]
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### GetItemsForPolicy
 ```
 Get-AzRecoveryServicesBackupItem [-Policy] <PolicyBase> [[-Name] <String>]
  [[-ProtectionStatus] <ItemProtectionStatus>] [[-ProtectionState] <ItemProtectionState>]
- [[-DeleteState] <ItemDeleteState>] [-VaultId <String>] [-DefaultProfile <IAzureContextContainer>]
- [<CommonParameters>]
+ [[-DeleteState] <ItemDeleteState>] [-FriendlyName <String>] [-VaultId <String>]
+ [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -58,6 +58,18 @@ PS C:\> $BackupItem = Get-AzRecoveryServicesBackupItem -Container $Container -Wo
 The first command gets the container of type AzureVM, and then stores it in the $Container variable.
 The second command gets the Backup item named V2VM in $Container, and then stores it in the $BackupItem variable.
 
+### Example 2: Get an Azure File Share Item from FriendlyName
+
+```powershell
+PS C:\> $vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
+PS C:\> $Container = Get-AzRecoveryServicesBackupContainer -ContainerType AzureStorage -Status Registered -Name "StorageAccount1" -VaultId $vault.ID
+PS C:\> $BackupItem = Get-AzRecoveryServicesBackupItem -Container $Container -WorkloadType AzureFiles -VaultId $vault.ID -FriendlyName "FileShareName"
+```
+
+The first command gets the container of type AzureStorage, and then stores it in the $Container variable.
+The second command gets the Backup item whose friendlyName matches the value passed in FriendlyName Parameter, and then stores it in the $BackupItem variable.
+Using FriendlyName parameter can result in returning more than one Azure File Share. In such cases use -Name parameter with parameter value as the Name property returned in $BackupItem variable.
+
 ## PARAMETERS
 
 ### -BackupManagementType
@@ -139,6 +151,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -FriendlyName
+FriendlyName of the backed up item
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Name
 
 Specifies the name of the container.