DSCResources/DSC_FSRMClassificationPropertyValue/DSC_FSRMClassificationPropertyValue.psm1
|
$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules' Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common') # Import Localization Strings $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' <# .SYNOPSIS Retrieves the FSRM Classification Property Value with the Name and PropertyName. .PARAMETER Name The FSRM Classification Property value Name. .PARAMETER PropertyName The name of the FSRM Classification Property the value applies to. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.String] $PropertyName ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingClassificationPropertyValueMessage) ` -f $PropertyName, $Name ) -join '' ) # Lookup the existing Classification Property $classificationProperty = Get-ClassificationProperty ` -PropertyName $PropertyName $classificationPropertyValue = $null foreach ($c in $classificationProperty.PossibleValue) { if ($c.Name -eq $Name) { $classificationPropertyValue = $c break } } $returnValue = @{ Name = $Name PropertyName = $PropertyName } if ($classificationPropertyValue) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueExistsMessage) ` -f $PropertyName, $Name ) -join '' ) $returnValue += @{ Ensure = 'Present' DisplayName = $classificationPropertyValue.DisplayName Description = $classificationPropertyValue.Description } } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueDoesNotExistMessage) ` -f $PropertyName, $Name ) -join '' ) $returnValue += @{ Ensure = 'Absent' } } return $returnValue } # Get-TargetResource <# .SYNOPSIS Sets the FSRM Classification Property Value with the Name and PropertyName. .PARAMETER Name The FSRM Classification Property value Name. .PARAMETER PropertyName The name of the FSRM Classification Property the value applies to. .PARAMETER Ensure Specifies whether the FSRM Classification Property value should exist. .PARAMETER Description The description of the FSRM Classification Property value. #> function Set-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '')] [CmdletBinding(SupportsShouldProcess = $true)] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.String] $PropertyName, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.String] $Description ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SettingClassificationPropertyValueMessage) ` -f $PropertyName, $Name ) -join '' ) # Remove any parameters that can't be splatted. $PSBoundParameters.Remove('Ensure') $PSBoundParameters.Remove('PropertyName') # Lookup the existing Classification Property $classificationProperty = Get-ClassificationProperty ` -PropertyName $PropertyName # Convert the CIMInstance array into an Array List so it can be worked with $classificationPropertyValues = ` [System.Collections.ArrayList]($classificationProperty.PossibleValue) # Find the index for the existing Value name (if it exists) $classificationPropertyValue = $null $classificationPropertyValueIndex = $null for ($c = 0; $c -ilt $classificationPropertyValues.Count; $c++) { if ($classificationPropertyValues[$c].Name -eq $Name) { $classificationPropertyValue = $classificationPropertyValues[$c] $classificationPropertyValueIndex = $c } } if ($Ensure -eq 'Present') { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.EnsureClassificationPropertyValueExistsMessage) ` -f $PropertyName, $Name ) -join '' ) $NewClassificationPropertyValue = New-FSRMClassificationPropertyValue ` @PSBoundParameters ` -ErrorAction Stop if ($null -eq $classificationPropertyValueIndex) { # Create the Classification Property Value Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueCreatedMessage) ` -f $PropertyName, $Name ) -join '' ) } else { # The Classification Property Value exists, remove it then update it $null = $classificationPropertyValues.RemoveAt($classificationPropertyValueIndex) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueUpdatedMessage) ` -f $PropertyName, $Name ) -join '' ) } $null = $classificationPropertyValues.Add($NewClassificationPropertyValue) } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.EnsureClassificationPropertyValueDoesNotExistMessage) ` -f $PropertyName, $Name ) -join '' ) if ($null -eq $classificationPropertyValueIndex) { # The Classification Property Value doesn't exist and should not Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueNoChangeMessage) ` -f $PropertyName, $Name ) -join '' ) return } else { # The Classification Property Value exists, but shouldn't remove it $null = $classificationPropertyValues.RemoveAt($classificationPropertyValueIndex) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueRemovedMessage) ` -f $PropertyName, $Name ) -join '' ) } # if } # if # Now write the actual change to the appropriate place Set-FSRMClassificationPropertyDefinition ` -Name $PropertyName ` -PossibleValue $classificationPropertyValues ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueWrittenMessage) ` -f $PropertyName, $Name ) -join '' ) } # Set-TargetResource <# .SYNOPSIS Tests the FSRM Classification Property Value with the Name and PropertyName. .PARAMETER Name The FSRM Classification Property value Name. .PARAMETER PropertyName The name of the FSRM Classification Property the value applies to. .PARAMETER Ensure Specifies whether the FSRM Classification Property value should exist. .PARAMETER Description The description of the FSRM Classification Property value. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.String] $PropertyName, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.String] $Description ) # Flag to signal whether settings are correct $desiredConfigurationMatch = $true Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestingClassificationPropertyValueMessage) ` -f $PropertyName, $Name ) -join '' ) # Lookup the existing Classification Property $classificationProperty = Get-ClassificationProperty ` -PropertyName $PropertyName # Convert the CIMInstance array into an Array List so it can be worked with $classificationPropertyValues = ` [System.Collections.ArrayList]($classificationProperty.PossibleValue) # Find the index for the existing Value name (if it exists) $classificationPropertyValue = $null $classificationPropertyValueIndex = $null for ($c = 0; $c -ilt $classificationPropertyValues.Count; $c++) { if ($classificationPropertyValues[$c].Name -eq $Name) { $classificationPropertyValue = $classificationPropertyValues[$c] $classificationPropertyValueIndex = $c } } if ($Ensure -eq 'Present') { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.EnsureClassificationPropertyValueExistsMessage) ` -f $PropertyName, $Name ) -join '' ) if ($null -eq $classificationPropertyValueIndex) { # The Classification Property Value does not exist but should Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueDoesNotExistButShouldMessage) ` -f $PropertyName, $Name ) -join '' ) $desiredConfigurationMatch = $false } else { # The Classification Property Value exists - check it #region Parameter Checks if (($PSBoundParameters.ContainsKey('Description')) ` -and ($classificationPropertyValue.Description -ne $Description)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValuePropertyNeedsUpdateMessage) ` -f $PropertyName, $Name, 'Description' ) -join '' ) $desiredConfigurationMatch = $false } #endregion } } else { if ($null -eq $classificationPropertyValueIndex) { # The ClassificationPropertyValue doesn't exist and should not Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueDoesNotExistAndShouldNotMessage) ` -f $PropertyName, $Name ) -join '' ) } else { # The ClassificationPropertyValue exists, but it should be removed Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ClassificationPropertyValueExistsAndShouldNotMessage) ` -f $PropertyName, $Name ) -join '' ) $desiredConfigurationMatch = $false } # if } # if return $desiredConfigurationMatch } # Test-TargetResource <# .SYNOPSIS Gets the FSRM Classification Property Value Object with the PropertyName. .PARAMETER Name The FSRM Classification Property value Name. #> function Get-ClassificationProperty { param ( [Parameter(Mandatory = $true)] [System.String] $PropertyName ) try { $classificationProperty = Get-FSRMClassificationPropertyDefinition ` -Name $PropertyName ` -ErrorAction Stop } catch [Microsoft.PowerShell.Cmdletization.Cim.CimJobException] { New-InvalidArgumentException ` -Message ($($script:localizedData.ClassificationPropertyNotFoundError) -f $PropertyName) ` -ArgumentName $PropertyName } catch { throw $_ } return $classificationProperty } Export-ModuleMember -Function *-TargetResource |