Merge pull request #8447 from vivlingaiah/vivekl/minorBugFixes

[GuestConfiguration] Fix error messages, fix redundant get all assign…

Author: markcowl

src/GuestConfiguration/GuestConfiguration.Test/ScenarioTests/GetVmGuestPolicyStatusHistoryTests.ps1

@@ -19,7 +19,7 @@ Get guest configuration policy status history by Vm name scope
 function Get-AzVMGuestPolicyStatusHistory-VmNameScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 
     $historicalStatuses = Get-AzVMGuestPolicyStatusHistory -ResourceGroupName $rgName -VMName $vmName
 	Assert-NotNull $historicalStatuses
@@ -33,7 +33,7 @@ Get guest configuration policy status history by Initiative id scope
 function Get-AzVMGuestPolicyStatusHistory-InitiativeIdScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 	$initiativeId = "/providers/Microsoft.Authorization/policySetDefinitions/25ef9b72-4af2-4501-acd1-fc814e73dde1"
 
     $historicalStatuses = Get-AzVMGuestPolicyStatusHistory -ResourceGroupName $rgName -VMName $vmName -InitiativeId $initiativeId
@@ -48,7 +48,7 @@ Get guest configuration policy status history by Initiative name scope
 function Get-AzVMGuestPolicyStatusHistory-InitiativeNameScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 	$initiativeName = "25ef9b72-4af2-4501-acd1-fc814e73dde1"
 
     $historicalStatuses = Get-AzVMGuestPolicyStatusHistory -ResourceGroupName $rgName -VMName $vmName -InitiativeName $initiativeName
@@ -63,7 +63,7 @@ Get guest configuration policy by vmName scope, using ShowOnlyChange switch
 function Get-AzVMGuestPolicyStatusHistory-ShowOnlyChangeSwitch-VmNameScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 
     $historicalStatuses = Get-AzVMGuestPolicyStatusHistory -ResourceGroupName $rgName -VMName $vmName -ShowOnlyChange
 	Assert-NotNull $historicalStatuses

src/GuestConfiguration/GuestConfiguration.Test/ScenarioTests/GetVmGuestPolicyReportTests.cs renamed to src/GuestConfiguration/GuestConfiguration.Test/ScenarioTests/GetVmGuestPolicyStatusTests.cs

@@ -21,11 +21,11 @@ namespace Microsoft.Azure.Commands.GuestConfiguration.Test.ScenarioTests
     using Xunit;
 
 
-    public class GetVmGuestPolicyReportTests
+    public class GetVmGuestPolicyStatusTests
     {
         private readonly XunitTracingInterceptor _logger;
 
-        public GetVmGuestPolicyReportTests(Xunit.Abstractions.ITestOutputHelper output)
+        public GetVmGuestPolicyStatusTests(Xunit.Abstractions.ITestOutputHelper output)
         {
             _logger = new XunitTracingInterceptor(output);
             XunitTracingInterceptor.AddToContext(_logger);
@@ -36,28 +36,28 @@ public GetVmGuestPolicyReportTests(Xunit.Abstractions.ITestOutputHelper output)
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void VmNameScope()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyReport-VmNameScope");
+            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyStatus-VmNameScope");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void InitiativeIdScope()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyReport-InitiativeIdScope");
+            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyStatus-InitiativeIdScope");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void InitiativeNameScope()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyReport-InitiativeNameScope");
+            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyStatus-InitiativeNameScope");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
-        public void ReportIdScope()
+        public void IdScope()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyReport-ReportIdScope");
+            TestController.NewInstance.RunPowerShellTest(_logger, "Get-AzVMGuestPolicyStatus-IdScope");
         }
     }
 }

src/GuestConfiguration/GuestConfiguration.Test/ScenarioTests/GetVmGuestPolicyReportTests.ps1 renamed to src/GuestConfiguration/GuestConfiguration.Test/ScenarioTests/GetVmGuestPolicyStatusTests.ps1

@@ -16,12 +16,12 @@
 .SYNOPSIS
 Get guest configuration policy report by Vm name scope
 #>
-function Get-AzVMGuestPolicyReport-VmNameScope
+function Get-AzVMGuestPolicyStatus-VmNameScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 
-    $reports = Get-AzVMGuestPolicyReport -ResourceGroupName $rgName -VMName $vmName
+    $reports = Get-AzVMGuestPolicyStatus -ResourceGroupName $rgName -VMName $vmName
 	Assert-NotNull $reports
 	Assert-True { $reports.Count -gt 0 }
 }
@@ -30,13 +30,13 @@ function Get-AzVMGuestPolicyReport-VmNameScope
 .SYNOPSIS
 Get guest configuration policy report by Initiative id scope
 #>
-function Get-AzVMGuestPolicyReport-InitiativeIdScope
+function Get-AzVMGuestPolicyStatus-InitiativeIdScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 	$initiativeId = "/providers/Microsoft.Authorization/policySetDefinitions/25ef9b72-4af2-4501-acd1-fc814e73dde1"
 
-    $reports = Get-AzVMGuestPolicyReport -ResourceGroupName $rgName -VMName $vmName -InitiativeId $initiativeId
+    $reports = Get-AzVMGuestPolicyStatus -ResourceGroupName $rgName -VMName $vmName -InitiativeId $initiativeId
 	Assert-NotNull $reports
 	Assert-True { $reports.Count -gt 0 }
 }
@@ -45,32 +45,32 @@ function Get-AzVMGuestPolicyReport-InitiativeIdScope
 .SYNOPSIS
 Get guest configuration policy report by Initiative name scope
 #>
-function Get-AzVMGuestPolicyReport-InitiativeNameScope
+function Get-AzVMGuestPolicyStatus-InitiativeNameScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 	$initiativeName = "25ef9b72-4af2-4501-acd1-fc814e73dde1"
 
-    $reports = Get-AzVMGuestPolicyReport -ResourceGroupName $rgName -VMName $vmName -InitiativeName $initiativeName
+    $reports = Get-AzVMGuestPolicyStatus -ResourceGroupName $rgName -VMName $vmName -InitiativeName $initiativeName
 	Assert-NotNull $reports
 	Assert-True { $reports.Count -gt 0 }
 }
 
 <#
 .SYNOPSIS
-Get guest configuration policy by reportId scope
+Get guest configuration policy by Id scope
 #>
-function Get-AzVMGuestPolicyReport-ReportIdScope
+function Get-AzVMGuestPolicyStatus-IdScope
 {
 	$rgName = "vivga"
-	$vmName = "vivga0"
+	$vmName = "Viv1809SDDC"
 	$initiativeName = "25ef9b72-4af2-4501-acd1-fc814e73dde1"
-	$reports = Get-AzVMGuestPolicyReport -ResourceGroupName $rgName -VMName $vmName -InitiativeName $initiativeName
+	$reports = Get-AzVMGuestPolicyStatus -ResourceGroupName $rgName -VMName $vmName -InitiativeName $initiativeName
 	Assert-NotNull $reports
 	Assert-True { $reports.Count -gt 0 }
 
-	$reportId= $reports[0].LatestReportId;
+	$Id= $reports[0].Id;
 
-    $report = Get-AzVMGuestPolicyReport -ReportId $reportId
+    $report = Get-AzVMGuestPolicyStatus -Id $Id
 	Assert-NotNull $report
 }

src/GuestConfiguration/GuestConfiguration.Test/SessionRecords/Microsoft.Azure.Commands.GuestConfiguration.Test.ScenarioTests.GetVmGuestPolicyReportTests/VmNameScope.json

@@ -12,7 +12,7 @@
 # RootModule = ''
 
 # Version number of this module.
-ModuleVersion = '0.10.1'
+ModuleVersion = '0.10.2'
 
 # Supported PSEditions
 CompatiblePSEditions = 'Core', 'Desktop'
@@ -30,7 +30,7 @@ CompanyName = 'Microsoft Corporation'
 Copyright = 'Microsoft Corporation. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'Microsoft Azure PowerShell - Guest Configuration service cmdlets for Azure Resource Manager. Allows querying VM compliance statuses for initiatives (part of Azure Policy) of category "Guest configuration", compliance reasons, compliance status history. For more information, please visit: https://aka.ms/guestconfigcmdlets'
+Description = 'Microsoft Azure PowerShell - Guest Configuration service cmdlets for Azure Resource Manager. Allows querying VM compliance statuses for initiatives (part of Azure Policy) of category "Guest configuration", compliance reasons, compliance status history. For more information, please visit: https://aka.ms/guestconfigcmdlets '
 
 # Minimum version of the Windows PowerShell engine required by this module
 PowerShellVersion = '5.1'
@@ -72,7 +72,7 @@ NestedModules = @('.\Microsoft.Azure.PowerShell.Cmdlets.GuestConfiguration.dll')
 FunctionsToExport = @()
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-CmdletsToExport = 'Get-AzVMGuestPolicyReport', 'Get-AzVMGuestPolicyStatusHistory'
+CmdletsToExport = 'Get-AzVMGuestPolicyStatus', 'Get-AzVMGuestPolicyStatusHistory'
 
 # Variables to export from this module
 # VariablesToExport = @()
@@ -104,14 +104,10 @@ PrivateData = @{
         # IconUri = ''
 
         # ReleaseNotes of this module
-        ReleaseNotes = '* Initial release of Az.GuestConfiguration module. Provides these two cmdlets.
-  * Get-AzVMGuestPolicyReport
-    * Provides compliance status of a VM in a resource group, compliance reasons.
-  * Get-AzVMGuestPolicyStatusHistory:
-    * Provides historical compliance statuses of a VM in a resource group, for a maximum of past 14 days.'
+        ReleaseNotes = 'General bug fixes and Cmdlet Get-AzVMGuestPolicyReport renamed to Get-AzVMGuestPolicyStatus to keep it consistent with the Azure portal and to avoid user confusion.'
 
         # Prerelease string of this module
-        # Prerelease = ''
+        #Prerelease = ''
 
         # Flag to indicate whether the module requires explicit user acceptance for install/update/save
         # RequireLicenseAcceptance = $false
@@ -129,5 +125,4 @@ PrivateData = @{
 # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
 # DefaultCommandPrefix = ''
 
-}
-
+}

src/GuestConfiguration/GuestConfiguration.Test/SessionRecords/Microsoft.Azure.Commands.GuestConfiguration.Test.ScenarioTests.GetVmGuestPolicyStatusHistoryTests/InitiativeIdScope.json

@@ -19,9 +19,13 @@
 -->
 ## Upcoming Release
 
+## Version 0.10.2
+- General bug fixes.
+- Rename cmdlet Get-AzVMGuestPolicyReport to Get-AzVMGuestPolicyStatus to keep it consistent with the Azure portal and to avoid user confusion.
+
 ## Version 0.10.1
 * Initial release of Az.GuestConfiguration module. Provides these two cmdlets.
-  * Get-AzVMGuestPolicyReport
+  * Get-AzVMGuestPolicyStatus
     * Provides compliance status of a VM in a resource group, compliance reasons.
   * Get-AzVMGuestPolicyStatusHistory:
     * Provides historical compliance statuses of a VM in a resource group, for a maximum of past 14 days.

src/GuestConfiguration/GuestConfiguration.Test/SessionRecords/Microsoft.Azure.Commands.GuestConfiguration.Test.ScenarioTests.GetVmGuestPolicyStatusHistoryTests/InitiativeNameScope.json

@@ -20,14 +20,13 @@ namespace Microsoft.Azure.Commands.GuestConfiguration.Cmdlets
     using Microsoft.Azure.Commands.GuestConfiguration.Common;
     using Microsoft.Azure.Commands.GuestConfiguration.Models;
     using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
-    using Microsoft.Azure.Management.GuestConfiguration.Models;
 
     /// <summary>
     /// Gets Vm Guest Policy reports (GuestConfiguration policy reports)
     /// </summary>
-    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VMGuestPolicyReport", DefaultParameterSetName = ParameterSetNames.VmNameScope), 
-        OutputType(typeof(IList<GuestConfigurationAssignmentReport>))]
-    public class GetAzureRmVMGuestPolicyReport : GuestConfigurationCmdletBase
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzurePrefix + "VMGuestPolicyStatus", DefaultParameterSetName = ParameterSetNames.VmNameScope)]
+    [OutputType(typeof(PolicyStatusDetailed))]
+    public class GetAzVMGuestPolicyStatus : GuestConfigurationCmdletBase
     {
         [Parameter(ParameterSetName = ParameterSetNames.VmNameScope, Mandatory = true, Position = 0, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
         [Parameter(ParameterSetName = ParameterSetNames.InitiativeIdScope, Mandatory = true, Position = 0, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
@@ -50,46 +49,55 @@ public class GetAzureRmVMGuestPolicyReport : GuestConfigurationCmdletBase
         [ValidateNotNullOrEmpty]
         public string InitiativeId { get; set; }
 
-        [Parameter(ParameterSetName = ParameterSetNames.ReportIdScope, Mandatory = true, Position = 0, HelpMessage = ParameterHelpMessages.ReportId)]
+        [Parameter(ParameterSetName = ParameterSetNames.IdScope, Mandatory = true, Position = 0, HelpMessage = ParameterHelpMessages.Id)]
         [ValidateNotNullOrEmpty]
-        public string ReportId { get; set; }
+        public string Id { get; set; }
 
         /// <summary>
         /// Executes the cmdlet
         /// </summary>
         public override void ExecuteCmdlet()
         {
-            IEnumerable<GuestConfigurationPolicyAssignmentReport> gcPolicyAssignmentReports = null;
-
+            IEnumerable<PolicyStatusDetailed> gcPolicyAssignmentReports = null;
             switch (ParameterSetName)
             {
+                // Process results for cmdlet
                 case ParameterSetNames.InitiativeNameScope:
-                    gcPolicyAssignmentReports = GetAllGuestConfigurationAssignmentReportsByInitiativeName(ResourceGroupName, VMName, InitiativeName, false);
+                    // get all gcrp assignments first
+                    var gcrpAssignments = GetAllGCRPAssignments(ResourceGroupName, VMName);
+
+                    gcPolicyAssignmentReports = GetPolicyStatusesDetailedByInitiativeName(ResourceGroupName, VMName, InitiativeName, gcrpAssignments);
                     if(gcPolicyAssignmentReports == null || gcPolicyAssignmentReports.Count() > 0)
                     {
                         WriteObject(gcPolicyAssignmentReports, true);
                     }                        
                     break;
 
                 case ParameterSetNames.InitiativeIdScope:
-                    gcPolicyAssignmentReports = GetAllGuestConfigurationAssignmentReportsByInitiativeId(ResourceGroupName, VMName, InitiativeId, false);
+                    // get all gcrp assignments first
+                    gcrpAssignments = GetAllGCRPAssignments(ResourceGroupName, VMName);
+
+                    gcPolicyAssignmentReports = GetPolicyStatusesDetailedByInitiativeId(ResourceGroupName, VMName, InitiativeId, false, gcrpAssignments);
 
                     if (gcPolicyAssignmentReports == null || gcPolicyAssignmentReports.Count() > 0)
                     {
                         WriteObject(gcPolicyAssignmentReports, true);
                     }                   
                     break;
 
-                case ParameterSetNames.ReportIdScope:
-                    var policyReport = GetGuestConfigurationAssignmentReportById(ReportId);
+                case ParameterSetNames.IdScope:
+                    var policyReport = GetPolicyStatusDetailedByReportId(Id);
                     if (policyReport != null)
                     {
                         WriteObject(policyReport);
                     }
                     break;
 
                 case ParameterSetNames.VmNameScope:
-                    gcPolicyAssignmentReports = GetAllGuestConfigurationAssignmentReports(ResourceGroupName, VMName, false);
+                    // get all gcrp assignments first
+                    gcrpAssignments = GetAllGCRPAssignments(ResourceGroupName, VMName);
+
+                    gcPolicyAssignmentReports = GetPolicyStatusesDetailed(ResourceGroupName, VMName, gcrpAssignments, false);
                     if (gcPolicyAssignmentReports == null || gcPolicyAssignmentReports.Count() > 0)
                     {
                         WriteObject(gcPolicyAssignmentReports, true);

src/GuestConfiguration/GuestConfiguration.Test/SessionRecords/Microsoft.Azure.Commands.GuestConfiguration.Test.ScenarioTests.GetVmGuestPolicyStatusHistoryTests/ShowOnlyChangeSwitchVmNameScope.json

@@ -20,14 +20,13 @@ namespace Microsoft.Azure.Commands.GuestConfiguration.Cmdlets
     using Microsoft.Azure.Commands.GuestConfiguration.Common;
     using Microsoft.Azure.Commands.GuestConfiguration.Models;
     using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
-    using Microsoft.Azure.Management.GuestConfiguration.Models;
 
     /// <summary>
     /// Gets Vm Guest Policy reports (GuestConfiguration policy reports)
     /// </summary>
-    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VMGuestPolicyStatusHistory", DefaultParameterSetName = ParameterSetNames.VmNameScope),
-        OutputType(typeof(IList<GuestConfigurationAssignmentReport>))]
-    public class GetAzureRmVMGuestPolicyStatusHistory : GuestConfigurationCmdletBase
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzurePrefix + "VMGuestPolicyStatusHistory", DefaultParameterSetName = ParameterSetNames.VmNameScope)]
+    [OutputType(typeof(PolicyStatus))]
+    public class GetAzVMGuestPolicyStatusHistory : GuestConfigurationCmdletBase
     {
         [Parameter(ParameterSetName = ParameterSetNames.VmNameScope, Mandatory = true, Position = 0, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
         [Parameter(ParameterSetName = ParameterSetNames.InitiativeIdScope, Mandatory = true, Position = 0, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
@@ -60,32 +59,36 @@ public class GetAzureRmVMGuestPolicyStatusHistory : GuestConfigurationCmdletBase
         /// </summary>
         public override void ExecuteCmdlet()
         {
-            IEnumerable<GuestConfigurationPolicyAssignmentReport> gcPolicyAssignmentReports = null;
+            IEnumerable<PolicyStatus> policyStatuses = null;
+
+            // get all gcrp assignments first
+            var gcrpAssignments = GetAllGCRPAssignments(ResourceGroupName, VMName);
 
             switch (ParameterSetName)
             {
-                case ParameterSetNames.InitiativeNameScope:
-                    gcPolicyAssignmentReports = GetAllGuestConfigurationAssignmentReportsByInitiativeName(ResourceGroupName, VMName, InitiativeName, true, ShowOnlyChange.IsPresent);
-                    if (gcPolicyAssignmentReports == null || gcPolicyAssignmentReports.Count() > 0)
+                // Process results for cmdlet
+                case ParameterSetNames.InitiativeNameScope:                 
+                    policyStatuses = GetPolicyStatusHistory(ResourceGroupName, VMName, gcrpAssignments, InitiativeName, ShowOnlyChange.IsPresent);
+                    if (policyStatuses == null || policyStatuses.Count() > 0)
                     {
-                        WriteObject(gcPolicyAssignmentReports, true);
+                        WriteObject(policyStatuses, true);
                     }
                     break;
 
                 case ParameterSetNames.InitiativeIdScope:
-                    gcPolicyAssignmentReports = GetAllGuestConfigurationAssignmentReportsByInitiativeId(ResourceGroupName, VMName, InitiativeId, true, ShowOnlyChange.IsPresent);
+                    policyStatuses = GetPolicyStatusHistoryByInitiativeId(ResourceGroupName, VMName, InitiativeId, gcrpAssignments, ShowOnlyChange.IsPresent);
 
-                    if (gcPolicyAssignmentReports == null || gcPolicyAssignmentReports.Count() > 0)
+                    if (policyStatuses == null || policyStatuses.Count() > 0)
                     {
-                        WriteObject(gcPolicyAssignmentReports, true);
+                        WriteObject(policyStatuses, true);
                     }
                     break;
 
                 case ParameterSetNames.VmNameScope:
-                    gcPolicyAssignmentReports = GetAllGuestConfigurationAssignmentReports(ResourceGroupName, VMName, true, ShowOnlyChange.IsPresent);
-                    if (gcPolicyAssignmentReports == null || gcPolicyAssignmentReports.Count() > 0)
+                    policyStatuses = GetPolicyStatusHistory(ResourceGroupName, VMName, gcrpAssignments, null, ShowOnlyChange.IsPresent);
+                    if (policyStatuses == null || policyStatuses.Count() > 0)
                     {
-                        WriteObject(gcPolicyAssignmentReports, true);
+                        WriteObject(policyStatuses, true);
                     }
                     break;
             }