Redigera en DSC-resurs med en instans

Anteckning

I den här artikeln beskrivs bästa praxis för att definiera en DSC-resurs som endast tillåter en enda instans i en DSC-konfiguration. Det finns ingen inbyggd DSC-funktion för att göra detta. Det kan förändras i framtiden.

Det finns situationer där du inte vill tillåta att en DSC-resurs används flera gånger i en DSC-konfiguration. I en tidigare implementering av xTimeZone DSC-resursen kan en DSC-konfiguration till exempel anropa DSC-resursen flera gånger och ställa in tidszonen på en annan inställning i varje DSC-resursblock:

Configuration SetTimeZone {
    param (
        [String[]]$NodeName = $env:COMPUTERNAME
    )

    Import-DSCResource -ModuleName xTimeZone

    Node $NodeName {
         xTimeZone TimeZoneExample {
            TimeZone = 'Eastern Standard Time'
         }

         xTimeZone TimeZoneExample2 {
            TimeZone = 'Pacific Standard Time'
         }
    }
}

Detta beror på hur egenskaper för DSC-resursnyckeln fungerar. En DSC-resurs måste ha minst en nyckelegenskap . En DSC-resursinstans anses vara unik om kombinationen av alla dess nyckelegenskapers värden är unik.

I den tidigare implementeringen hade xTimeZone DSC-resursen bara en egenskap – TimeZone, som var en nyckel. Därför kompilerade och kördes DSC-exempelkonfigurationen utan förvarning. Var och en av DSC-resursblocken xTimeZone ansågs vara unika. Detta gjorde att DSC-konfigurationen upprepade gånger tillämpades på systemet och cyklade tidszonen fram och tillbaka.

För att säkerställa att en DSC-konfiguration endast kunde ange tidszonen för ett system en gång uppdaterades DSC-resursen för att lägga till en andra egenskap, IsSingleInstance, som blev egenskapen Nyckel . IsSingleInstance begränsades till ett enda värde, Yes. Det gamla MOF-schemat för DSC-resursen var:

[ClassVersion("1.0.0.0"), FriendlyName("xTimeZone")]
class xTimeZone : OMI_BaseResource
{
    [Key, Description("Specifies the TimeZone.")] String TimeZone;
};

Det uppdaterade MOF-schemat för DSC-resursen är:

[ClassVersion("1.0.0.0"), FriendlyName("xTimeZone")]
class xTimeZone : OMI_BaseResource
{
    [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'"), ValueMap{"Yes"}, Values{"Yes"}] String IsSingleInstance;
    [Required, Description("Specifies the TimeZone.")] String TimeZone;
};

DSC-resursens implementering uppdaterades för att använda den nya parametern. Så här ändrades det:

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [String]
        $IsSingleInstance,

        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [String]
        $TimeZone
    )

    #Get the current TimeZone
    $CurrentTimeZone = Get-TimeZone

    $returnValue = @{
        TimeZone = $CurrentTimeZone
        IsSingleInstance = 'Yes'
    }

    #Output the target resource
    $returnValue
}

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [String]
        $IsSingleInstance,

        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [String]
        $TimeZone
    )

    #Output the result of Get-TargetResource function.
    $CurrentTimeZone = Get-TimeZone

    Write-Verbose -Message "Replace the System Time Zone to $TimeZone"

    try
    {
        if($CurrentTimeZone -ne $TimeZone)
        {
            Write-Verbose -Verbose "Setting the TimeZone"
            Set-TimeZone -TimeZone $TimeZone
        }
        else
        {
            Write-Verbose -Verbose "TimeZone already set to $TimeZone"
        }
    }
    catch
    {
        $ErrorMsg = $_.Exception.Message
        Write-Verbose -Verbose $ErrorMsg
    }
}


function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [String]
        $IsSingleInstance,

        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [String]
        $TimeZone
    )

    #Output from Get-TargetResource
    $CurrentTimeZone = Get-TimeZone

    if($TimeZone -eq $CurrentTimeZone)
    {
        return $true
    }
    else
    {
        return $false
    }
}

Function Get-TimeZone {
    [CmdletBinding()]
    param()

    & tzutil.exe /g
}

Function Set-TimeZone {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$true)]
        [System.String]
        $TimeZone
    )

    try
    {
        & tzutil.exe /s $TimeZone
    }
    catch
    {
        $ErrorMsg = $_.Exception.Message
        Write-Verbose $ErrorMsg
    }
}

Export-ModuleMember -Function *-TargetResource

Observera att egenskapen TimeZone inte längre är en nyckelegenskap . Om en DSC-konfiguration nu försöker ställa in tidszonen två gånger (med två olika xTimeZone block med olika TimeZone-värden ) orsakar försök att kompilera DSC-konfigurationen ett fel:

Write-Error:
Line |
 289 |          Test-ConflictingResources $keywordName $canonicalizedValue $k …
     |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | A conflict was detected between resources '[xTimeZone]TimeZoneExample (C:\code\dsc\DscExample.ps1::9::10::xTimeZone)' and '[xTimeZone]TimeZoneExample2 (C:\code\dsc\DscExample.ps1::14::10::xTimeZone)' in node 'DESKTOP-KFLGVVP'. Resources have identical key properties but there are differences in the following non-key properties: 'TimeZone'. Values 'Eastern Standard Time' don't match values 'Pacific Standard Time'. Please update these property values so that they are identical in both cases.
InvalidOperation: Errors occurred while processing configuration 'SetTimeZone'.