Some cleanup and documentation added (dsccommunity#163)

* Added documentation * Cleanup * Added back reference configuration files * Cleanup
computedocean · Nov 29, 2023 · 8b68810 · 8b68810
1 parent b119d6b
commit 8b68810
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 48 deletions.
diff --git a/.work/Debug.ps1 b/.work/Debug.ps1
diff --git a/.work/GetComplianceState.ps1 b/.work/GetComplianceState.ps1
diff --git a/.work/cleanup.ps1 b/.work/cleanup.ps1
diff --git a/Lab Guest Configuration/10 Azure Guest Configuration Lab.ps1 b/Lab Guest Configuration/10 Azure Guest Configuration Lab.ps1
@@ -1,3 +1,23 @@
+<#
+.SYNOPSIS
+This script creates a lab environment for the Azure Guest Configuration lab.
+
+.PARAMETER LocationName
+Specifies the location where the lab environment will be created. Default is 'West Europe'.
+
+.PARAMETER SubscriptionName
+Specifies the name of the Azure subscription to use.
+
+.NOTES
+This script requires the Azure PowerShell module to be installed.
+
+.EXAMPLE
+.\10 Azure Guest Configuration Lab.ps1 -LocationName 'East US' -SubscriptionName 'MySubscription'
+
+This example creates a lab environment in the 'East US' location using the 'MySubscription' Azure subscription.
+
+#>
+
 param
 (
     [Parameter()]

diff --git a/Lab Guest Configuration/20 Azure Guest Configuration Lab Customizations.ps1 b/Lab Guest Configuration/20 Azure Guest Configuration Lab Customizations.ps1
@@ -1,5 +1,19 @@
 #Requires -Modules AutomatedLab, Az.Resources, Az.ManagedServiceIdentity
 
+<#
+.SYNOPSIS
+This script customizes the Azure Guest Configuration lab environment.
+
+.NOTES
+This script requires the AutomatedLab, Az.Resources, and Az.ManagedServiceIdentity PowerShell modules to be installed.
+
+.EXAMPLE
+.\20 Azure Guest Configuration Lab Customizations.ps1
+
+This example customizes the Azure Guest Configuration lab environment.
+
+#>
+
 if (-not $lab)
 {
     $lab = Import-Lab -Name GCLab1 -NoValidation -PassThru

diff --git a/Lab Guest Configuration/99 Get-MachineComplianceState.ps1 b/Lab Guest Configuration/99 Get-MachineComplianceState.ps1
@@ -0,0 +1,26 @@
+#Get-AzPolicyAssignment -Scope $resourceGroup.ResourceId
+$subscriptionId = '<SubscriptionId>'
+$resourceGroupName = '<ResourceGroupName>'
+$machineName = '<MachineName>'
+
+$uri = "https://management.azure.com/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.Compute/virtualMachines/$machineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments?api-version=2022-01-25"
+
+Invoke-AzRestMethod -Method GET -Uri $uri | Select-Object -ExpandProperty content | ConvertFrom-Json |
+    Select-Object -ExpandProperty value |
+        Format-Table Name,
+        @{
+            Name       = 'AssignmentType'
+            Expression = { $PSItem.properties.guestConfiguration.assignmentType }
+        },
+        @{
+            Name       = 'LastComplianceStatusChecked'
+            Expression = { $PSItem.properties.lastComplianceStatusChecked }
+        },
+        @{
+            Name       = 'ComplianceStatus'
+            Expression = { $PSItem.properties.complianceStatus }
+        },
+        @{
+            Name       = 'Version'
+            Expression = { $PSItem.properties.guestConfiguration.version }
+        }
diff --git a/source/GCPackages/UserAmyNotPresent/UserAmyNotPresent.config.ps1 b/source/GCPackages/UserAmyNotPresent/UserAmyNotPresent.config.ps1
diff --git a/source/GCPackages/UserAmyPresent/UserAmyPresent.config.ps1 b/source/GCPackages/UserAmyPresent/UserAmyPresent.config.ps1
diff --git a/...pReferences/ReferenceConfigurationDev.yml → ...pReferences/ReferenceConfigurationDev.yml b/...pReferences/ReferenceConfigurationDev.yml → ...pReferences/ReferenceConfigurationDev.yml
diff --git a/...References/ReferenceConfigurationProd.yml → ...References/ReferenceConfigurationProd.yml b/...References/ReferenceConfigurationProd.yml → ...References/ReferenceConfigurationProd.yml
diff --git a/...References/ReferenceConfigurationTest.yml → ...References/ReferenceConfigurationTest.yml b/...References/ReferenceConfigurationTest.yml → ...References/ReferenceConfigurationTest.yml