DSC-omgeving ResourceDSC Environment Resource

Van toepassing op: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

De omgeving in Windows PowerShell Desired State Configuration (DSC)-bron biedt een mechanisme voor het beheren van omgevingsvariabelen.The Environment resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage system environment variables.

SyntaxisSyntax

Environment [string] #ResourceName
{
    Name = [string]
    [ Ensure = [string] { Absent | Present }  ]
    [ Path = [bool] ]
    [ DependsOn = [string[]] ]
    [ Value = [string] ]
}

EigenschappenProperties

EigenschapProperty BeschrijvingDescription
NaamName Geeft de naam van de omgevingsvariabele waarvoor u wilt om te controleren of een specifieke status.Indicates the name of the environment variable for which you want to ensure a specific state.
Zorg ervoor datEnsure Hiermee wordt aangegeven of een variabele bestaat.Indicates if a variable exists. Deze eigenschap instellen op aanwezig te maken van de omgevingsvariabele als deze niet bestaat of om ervoor te zorgen dat de waarde overeenkomt met wat is opgegeven via de waarde eigenschap als de variabele al bestaat.Set this property to Present to create the environment variable if it does not exist or to ensure that its value matches what is provided through the Value property if the variable already exists. Stel deze in op afwezig verwijderen van de variabele als deze bestaat.Set it to Absent to delete the variable if it exists.
PadPath Hiermee definieert u de variabele die wordt geconfigureerd.Defines the environment variable that is being configured. Deze eigenschap instellen op $true als de variabele de pad variabele, anders wordt ingesteld op $false.Set this property to $true if the variable is the Path variable; otherwise, set it to $false. De standaardwaarde is $false.The default is $false. Als de variabele die wordt geconfigureerd de pad variabele, de waarde wordt opgegeven via de waarde eigenschap worden toegevoegd aan de bestaande waarde.If the variable being configured is the Path variable, the value provided through the Value property will be appended to the existing value.
dependsOnDependsOn Hiermee wordt aangegeven dat de configuratie van een andere resource uitvoeren moet voordat deze bron is geconfigureerd.Indicates that the configuration of another resource must run before this resource is configured. Bijvoorbeeld, als de ID van de resourceconfiguratie scriptblok die u wilt uitvoeren eerst is ResourceName en het type ResourceType, de syntaxis voor het gebruik van deze eigenschap is DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
ValueValue De waarde om toe te wijzen aan de omgevingsvariabele.The value to assign to the environment variable.

VoorbeeldExample

Het volgende voorbeeld zorgt ervoor dat TestEnvironmentVariable aanwezig is en of hieraan de waarde testwaarde.The following example ensures that TestEnvironmentVariable is present and it has the value TestValue. Als dit niet aanwezig is, maakt deze.If it is not present, it creates it.

Environment EnvironmentExample
{
    Ensure = "Present"  # You can also set Ensure to "Absent"
    Name = "TestEnvironmentVariable"
    Value = "TestValue"
}