Fixed some typos. (#765)

* Fix Powershell typos.

* Typos.

* Delete custom-words.txt

* Delete fix.txt

* Delete cspell.config.yaml

Docs/operational-scripts.md

@@ -46,7 +46,7 @@ Parameters:
 
 * **OutputFolder**: Output Folder. Defaults to the path 'Output'.
 
-* **AutoCreateParameters**: Automatically create parameters for Azure Policy Sets and Assginment Files.
+* **AutoCreateParameters**: Automatically create parameters for Azure Policy Sets and Assignment Files.
 
 * **UseBuiltIn**: Default to using builtin policies rather than local versions.
 

Scripts/Helpers/Build-AssignmentDefinitionAtLeaf.ps1

@@ -159,7 +159,7 @@ function Build-AssignmentDefinitionAtLeaf {
             continue
         }
         elseif (-not (Confirm-ValidPolicyResourceName -Name $name)) {
-            Write-Error "    Leaf Node $($nodeName): Assignment name '$name' contains invalid charachters <>*%&:?.+/ or ends with a space."
+            Write-Error "    Leaf Node $($nodeName): Assignment name '$name' contains invalid characters <>*%&:?.+/ or ends with a space."
             $hasErrors = $true
             continue
         }

Scripts/Helpers/Build-AssignmentPlan.ps1

@@ -33,7 +33,7 @@ function Build-AssignmentPlan {
         Write-Warning "No Policy Assignment files found! Deleting any Policy Assignments."
     }
 
-    # Cache role assognments and definitions
+    # Cache role assignments and definitions
     $deployedPolicyAssignments = $deployedPolicyResources.policyassignments.managed
     $deployedRoleAssignmentsByPrincipalId = $DeployedPolicyResources.roleAssignmentsByPrincipalId
     $deleteCandidates = $deployedPolicyAssignments.Clone()
@@ -330,12 +330,12 @@ function Build-AssignmentPlan {
                     }
                     otherPaC {
                         if ($VerbosePreference -eq "Continue") {
-                            Write-AssignmentDetails -DisplayName $displayName -Scope $shortScope -Prefix "Skipping delete (owened by other PaC):" -IdentityStatus $identityStatus
+                            Write-AssignmentDetails -DisplayName $displayName -Scope $shortScope -Prefix "Skipping delete (owned by other PaC):" -IdentityStatus $identityStatus
                         }
                     }
                     unknownOwner {
                         if ($VerbosePreference -eq "Continue") {
-                            Write-AssignmentDetails -DisplayName $displayName -Scope $shortScope -Prefix "Skipping delete owmed by unknown (strategy $strategy):" -IdentityStatus $identityStatus
+                            Write-AssignmentDetails -DisplayName $displayName -Scope $shortScope -Prefix "Skipping delete owned by unknown (strategy $strategy):" -IdentityStatus $identityStatus
                         }
                     }
                     managedByDfcSecurityPolicies {

Scripts/Helpers/Build-ExemptionsPlan.ps1

@@ -106,7 +106,7 @@ function Build-ExemptionsPlan {
                 $errorInfo.hasLocalErrors = $false
                 $entryNumber++
 
-                #region read row values andd skip empty rows on CSV files
+                #region read row values and skip empty rows on CSV files
                 $name = $row.name
                 $displayName = $row.displayName
                 $exemptionCategory = $row.exemptionCategory
@@ -141,11 +141,11 @@ function Build-ExemptionsPlan {
                         continue
                     }
                 }
-                #endregion read row values andd skip empty rows on CSV files
+                #endregion read row values and skip empty rows on CSV files
 
                 if ($isCsvFile) {
 
-                    #region CSV files can define the assignment with assignmentReferenceId or the leagcy policyAssignmentId
+                    #region CSV files can define the assignment with assignmentReferenceId or the legacy policyAssignmentId
                     if ([string]::IsNullOrWhitespace($assignmentReferenceId) -xor [string]::IsNullOrWhitespace($policyAssignmentId)) {
                         if (-not [string]::IsNullOrWhitespace($assignmentReferenceId)) {
                             if ($assignmentReferenceId.StartsWith("policyDefinitions/")) {
@@ -173,7 +173,7 @@ function Build-ExemptionsPlan {
                     else {
                         Add-ErrorMessage -ErrorInfo $errorInfo -ErrorString "exactly one of the columns policyAssignmentId or assignmentReferenceId must have a non-empty cell" -EntryNumber $entryNumber
                     }
-                    #endregion CSV files can define the assignment with assignmentReferenceId or the leagcy policyAssignmentId
+                    #endregion CSV files can define the assignment with assignmentReferenceId or the legacy policyAssignmentId
 
                     #region Convert referenceIds into array (if cell empty, set to empty array)
                     $final = @()
@@ -202,7 +202,7 @@ function Build-ExemptionsPlan {
                     }
                     #endregion table must contain scope or scopes column
 
-                    #region Convert resourceSelectors into array (if cell empty, set to Snull)
+                    #region Convert resourceSelectors into array (if cell empty, set to $null)
                     $resourceSelectors = $null
                     $step1 = $row.resourceSelectors
                     if (-not [string]::IsNullOrWhiteSpace($step1)) {
@@ -219,7 +219,7 @@ function Build-ExemptionsPlan {
                             }
                         }
                     }
-                    #endregion Convert resourceSelectors into array (if cell empty, set to Snull)
+                    #endregion Convert resourceSelectors into array (if cell empty, set to $null)
 
                     #region convert metadata JSON to object
                     $step1 = $row.metadata
@@ -420,7 +420,7 @@ function Build-ExemptionsPlan {
                 }
                 else {
                     if (-not (Confirm-ValidPolicyResourceName -Name $name)) {
-                        Add-ErrorMessage -ErrorInfo $errorInfo -ErrorString "name '$($name.Substring(0, 32))...' contains invalid charachters <>*%&:?.+/ or ends with a space." -EntryNumber $entryNumber
+                        Add-ErrorMessage -ErrorInfo $errorInfo -ErrorString "name '$($name.Substring(0, 32))...' contains invalid characters <>*%&:?.+/ or ends with a space." -EntryNumber $entryNumber
                     }
                     elseif ($name.Length -gt 64) {
                         Add-ErrorMessage -ErrorInfo $errorInfo -ErrorString "name too long (max 64 characters)" -EntryNumber $entryNumber

Scripts/Helpers/Build-PolicyPlan.ps1

@@ -77,7 +77,7 @@ function Build-PolicyPlan {
             Write-Error "Policy from file '$($file.Name)' requires a name" -ErrorAction Stop
         }
         if (-not (Confirm-ValidPolicyResourceName -Name $name)) {
-            Write-Error "Policy from file '$($file.Name) has a name '$name' containing invalid charachters <>*%&:?.+/ or ends with a space." -ErrorAction Stop
+            Write-Error "Policy from file '$($file.Name) has a name '$name' containing invalid characters <>*%&:?.+/ or ends with a space." -ErrorAction Stop
         }
         if ($null -eq $displayName) {
             Write-Error "Policy '$name' from file '$($file.Name)' requires a displayName" -ErrorAction Stop

Scripts/Helpers/Build-PolicySetPlan.ps1

@@ -74,7 +74,7 @@ function Build-PolicySetPlan {
             Write-Error "Policy Set from file '$($file.Name)' requires a name" -ErrorAction Stop
         }
         if (-not (Confirm-ValidPolicyResourceName -Name $name)) {
-            Write-Error "Policy Set from file '$($file.Name) has a name '$name' containing invalid charachters <>*%&:?.+/ or ends with a space." -ErrorAction Stop
+            Write-Error "Policy Set from file '$($file.Name) has a name '$name' containing invalid characters <>*%&:?.+/ or ends with a space." -ErrorAction Stop
         }
         if ($null -eq $displayName) {
             Write-Error "Policy Set '$name' from file '$($file.Name)' requires a displayName" -ErrorAction Stop

Scripts/Helpers/Build-ScopeTableForManagementGroup.ps1

@@ -118,7 +118,7 @@ function Build-ScopeTableForManagementGroup {
     }
     #endregion recurse down the tree
 
-    #region augment this parents scope's details with this mangement group's details
+    #region augment this parents scope's details with this management group's details
     if ($null -ne $ParentScopeDetails) {
         $parentScopeChildrenTable = $ParentScopeDetails.childrenTable
         $parentScopeResourceGroupsTable = $ParentScopeDetails.resourceGroupsTable
@@ -144,7 +144,7 @@ function Build-ScopeTableForManagementGroup {
             $null = $parentScopeExcludedScopesTable.Add($excludedScope, $excludedScopesTable.$excludedScope)
         }
     }
-    #endregion augment this parents scope's details with this mangement group's details
+    #endregion augment this parents scope's details with this management group's details
 
     return $scopeDetails
 }

Scripts/Helpers/Build-ScopeTableForSubscription.ps1

@@ -105,7 +105,7 @@ function Build-ScopeTableForSubscription {
     }
     #endregion augment resource groups scope details
 
-    #region augemnt this parents scope's details with this subscription's details
+    #region augment this parents scope's details with this subscription's details
     if ($null -ne $ParentScopeDetails) {
         $parentScopeChildrenTable = $ParentScopeDetails.childrenTable
         $parentScopeResourceGroupsTable = $ParentScopeDetails.resourceGroupsTable
@@ -131,7 +131,7 @@ function Build-ScopeTableForSubscription {
             $null = $parentScopeExcludedScopesTable.Add($excludedScope, $excludedScopesTable.$excludedScope)
         }
     }
-    #endregion augemnt this parents scope's details with this subscription's details
+    #endregion augment this parents scope's details with this subscription's details
 
     return $scopeDetails
 }

Scripts/Helpers/Confirm-ActiveAzExemptions.ps1

@@ -80,7 +80,7 @@ function Confirm-ActiveAzExemptions {
         all           = $allExemptions
         active        = $activeExemptions
         expiresInDays = $expiringExemptions # Subset of active
-        orphaned      = $orphanedExemptions # Orpahned trumps expired
+        orphaned      = $orphanedExemptions # Orphaned trumps expired
         expired       = $expiredExemptions
     }
 

Scripts/Helpers/Confirm-ObjectValueEqualityDeep.ps1

@@ -14,7 +14,7 @@ function Confirm-ObjectValueEqualityDeep {
             return $true
         }
         if ($null -eq $Object1) {
-            # $Object1 is $null, swap $Object1 and $Object2 to ensure that Object1 (the old Object2) is not $null and Object2 (the old Object1) is $null (setting it to $null is ommited because it is not used in the subsequent code)
+            # $Object1 is $null, swap $Object1 and $Object2 to ensure that Object1 (the old Object2) is not $null and Object2 (the old Object1) is $null (setting it to $null is omitted because it is not used in the subsequent code)
             $Object1 = $Object2
             $Object2 = $null
         }

Scripts/Helpers/Confirm-PacOwner.ps1

@@ -24,10 +24,10 @@ function Confirm-PacOwner {
                 $definitionIdParts = Split-AzPolicyResourceId -Id $properties.policyDefinitionId
                 if ($definitionIdParts.scopeType -eq "builtin") {
                     # Check if the owner is a special case, either managed by DfC's "Security Policies" or one of the "Defender Plans"
-                    # This didcult due to inconsistent naming and createdBy users.
+                    # This is difficult due to inconsistent naming and createdBy users.
                     # At present, the only way to identify these is by string comparing the description field. This is not ideal.
                     #   "Security Policies" (e.g., MCSB, NIST, ...) use a description "This object has been generated by Microsoft Defender for Cloud. To make changes, navigate to the security policies management page.",
-                    #   "Defender Plans" (e.g., Servers, App Service, Databases, ...) use a description srtaing with "This policy assignment was automatically created by "
+                    #   "Defender Plans" (e.g., Servers, App Service, Databases, ...) use a description starting with "This policy assignment was automatically created by "
                     if ($description.StartsWith("This object has been generated by ")) {
                         $ManagedByCounters.dfcSecurityPolicies += 1
                         return "managedByDfcSecurityPolicies"

Scripts/Helpers/Confirm-ParametersDefinitionMatch.ps1

@@ -24,7 +24,7 @@ function Confirm-ParametersDefinitionMatch {
         }
     }
     foreach ($existingParameterName in $existingParameters.Keys) {
-        # ignore paramer name case
+        # ignore parameter name case
         $definedParameterNameArray = $definedParameters.Keys -eq $existingParameterName
         if ($definedParameterNameArray.Count -gt 0) {
             # found a matching parameter name (case insensitive)

Scripts/Helpers/Confirm-PolicyResourceExclusions.ps1

@@ -22,7 +22,7 @@ function Confirm-PolicyResourceExclusions {
         return $true, $resourceIdParts
     }
     if (-not $ScopeTable.ContainsKey($scope)) {
-        Write-Verbose "Unmanged scope '$scope', resource '$($ResourceId)'"
+        Write-Verbose "Unmanaged scope '$scope', resource '$($ResourceId)'"
         if ($null -ne $PolicyResourceTable) {
             $PolicyResourceTable.counters.unmanagedScopes += 1
         }

Scripts/Helpers/Confirm-ValidPolicyResourceName.ps1

@@ -5,7 +5,7 @@ function Confirm-ValidPolicyResourceName {
         $Name
     )
 
-    # Test is the Name has any charcters from thisn string of characters "<>*%&:?.+/" in it or ends with a space
+    # Test is the Name has any characters from this string of characters "<>*%&:?.+/" in it or ends with a space
     if ($Name -match "[\<\>\*\%\&\:\?\+\/\\]" -or $Name.EndsWith(" ")) {
         return $false
     }

Scripts/Helpers/Convert-AllowedEffectsToCsvString.ps1

@@ -30,7 +30,7 @@ function Convert-AllowedEffectsToCsvString {
 
     $effectArray = @()
     foreach ($effectValue in @( "Modify", "Append", "DenyAction", "Deny", "Audit", "Manual", "DeployIfNotExists", "AuditIfNotExists", "Disabled" )) {
-        # sorted logicaly
+        # sorted logically
         if ($allowedList -contains $effectValue) {
             $effectArray += $effectValue
         }

Scripts/Helpers/Convert-PolicyResourcesDetailsToFlatList.ps1

@@ -260,7 +260,7 @@ function Convert-PolicyResourcesDetailsToFlatList {
                     }
                     else {
                         $null = $parametersAlreadyCovered.Add($parameterName, $true)
-                        $parameter.multiUse = $false # Redo multi-use based on sorted liist of Policies
+                        $parameter.multiUse = $false # Redo multi-use based on sorted list of Policies
 
                         $parameterValue = $null
                         if ($null -ne $assignmentId) {

Scripts/Helpers/Find-AzNonCompliantResources.ps1

@@ -13,7 +13,7 @@ function Find-AzNonCompliantResources {
     )
 
     Write-Information "==================================================================================================="
-    Write-Information "Retrieve Policy Commpliance List"
+    Write-Information "Retrieve Policy Compliance List"
     Write-Information "==================================================================================================="
     $effectFilter = ""
     if ($PolicyEffectFilter -and $ExcludeManualPolicyEffect) {

Scripts/Helpers/Get-CalculatedPolicyAssignmentsAndReferenceIds.ps1

@@ -19,8 +19,8 @@ function Get-CalculatedPolicyAssignmentsAndReferenceIds {
     $index = 0
     foreach ($assignment in $Assignments) {
         $assignmentId = $assignment.id
-        $assignmentPoperties = Get-PolicyResourceProperties $assignment
-        $assignedPolicyDefinitionId = $assignmentPoperties.policyDefinitionId
+        $assignmentProperties = Get-PolicyResourceProperties $assignment
+        $assignedPolicyDefinitionId = $assignmentProperties.policyDefinitionId
 
         if ($assignedPolicyDefinitionId.Contains("/providers/Microsoft.Authorization/policyDefinitions/", [StringComparison]::InvariantCultureIgnoreCase)) {
 
@@ -29,10 +29,10 @@ function Get-CalculatedPolicyAssignmentsAndReferenceIds {
                 id                             = $assignmentId
                 scope                          = $assignment.scope
                 name                           = $assignment.name
-                displayName                    = $assignmentPoperties.displayName
+                displayName                    = $assignmentProperties.displayName
                 assignedPolicyDefinitionId     = $assignedPolicyDefinitionId
                 policyDefinitionId             = $assignedPolicyDefinitionId
-                notScopes                      = $assignmentPoperties.notScopes
+                notScopes                      = $assignmentProperties.notScopes
                 isPolicyAssignment             = $true
                 allowReferenceIdsInRow         = $false
                 policyDefinitionReferenceIds   = $null
@@ -58,7 +58,7 @@ function Get-CalculatedPolicyAssignmentsAndReferenceIds {
         elseif ($assignedPolicyDefinitionId.Contains("/providers/Microsoft.Authorization/policySetDefinitions/", [StringComparison]::InvariantCultureIgnoreCase)) {
             $thisPolicySetReferences = $null
 
-            #region caclculate referenceId values for this Policy Set
+            #region calculate referenceId values for this Policy Set
             if ($byPolicySetIdPolicyDefinitionReferences.ContainsKey($assignedPolicyDefinitionId)) {
                 # use previously calculated values
                 $thisPolicySetReferences = $byPolicySetIdPolicyDefinitionReferences.$assignedPolicyDefinitionId
@@ -101,17 +101,17 @@ function Get-CalculatedPolicyAssignmentsAndReferenceIds {
                     $policyIndex++
                 }
             }
-            #endregion caclculate referenceId values for this Policy Set
+            #endregion calculate referenceId values for this Policy Set
 
             #region calculated assignment for this policyAssignment AND for this policySetId
             $calculatedPolicyAssignment = @{
                 id                             = $assignmentId
                 scope                          = $assignment.scope
                 name                           = $assignment.name
-                displayName                    = $assignmentPoperties.displayName
+                displayName                    = $assignmentProperties.displayName
                 assignedPolicyDefinitionId     = $assignedPolicyDefinitionId
                 policyDefinitionId             = $null
-                notScopes                      = $assignmentPoperties.notScopes
+                notScopes                      = $assignmentProperties.notScopes
                 isPolicyAssignment             = $false
                 allowReferenceIdsInRow         = $true
                 policyDefinitionReferenceIds   = $thisPolicySetReferences.policyDefinitionReferenceIds
@@ -141,10 +141,10 @@ function Get-CalculatedPolicyAssignmentsAndReferenceIds {
                     id                             = $assignmentId
                     scope                          = $assignment.scope
                     name                           = $assignment.name
-                    displayName                    = $assignmentPoperties.displayName
+                    displayName                    = $assignmentProperties.displayName
                     assignedPolicyDefinitionId     = $assignedPolicyDefinitionId
                     policyDefinitionId             = $policyDefinitionId
-                    notScopes                      = $assignmentPoperties.notScopes
+                    notScopes                      = $assignmentProperties.notScopes
                     isPolicyAssignment             = $false
                     allowReferenceIdsInRow         = $false
                     policyDefinitionReferenceIds   = $thisPolicyReferences.referenceIds

Scripts/Helpers/Get-HydrationChildManagementGroupNameList.ps1

@@ -1,4 +1,4 @@
-function Get-HydrrationChildManagementGroupNameList {
+function Get-HydrationChildManagementGroupNameList {
     <#
     .SYNOPSIS
         This function retrieves a list of all child management groups of a given management group.