Recurso Environment de DSCDSC Environment Resource

Aplica-se a: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

O recurso Environment na Configuração de Estado Desejado (DSC) do Windows PowerShell fornece um mecanismo para gerenciar as variáveis de ambiente do sistema.The Environment resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage system environment variables.

SintaxeSyntax

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

PropriedadesProperties

PropriedadeProperty DescriçãoDescription
NomeName Indica o nome da variável de ambiente para a qual você deseja garantir um estado específico.Indicates the name of the environment variable for which you want to ensure a specific state.
EnsureEnsure Indica se existe uma variável.Indicates if a variable exists. Defina essa propriedade como Present para criar a variável de ambiente caso ela não exista ou para garantir que seu valor corresponda ao que é fornecido por meio da propriedade Value se a variável já existir.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. Defina-a como Absent para excluir a variável se ela existir.Set it to Absent to delete the variable if it exists.
CaminhoPath Define a variável de ambiente que está sendo configurada.Defines the environment variable that is being configured. Defina essa propriedade como $true se a variável for a variável Path; caso contrário, defina-a como $false.Set this property to $true if the variable is the Path variable; otherwise, set it to $false. O padrão é $false.The default is $false. Se a variável que estiver sendo configurada for a variável Path, o valor fornecido por meio da propriedade Value será acrescentado ao valor existente.If the variable being configured is the Path variable, the value provided through the Value property will be appended to the existing value.
DependsOnDependsOn Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado.Indicates that the configuration of another resource must run before this resource is configured. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será 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".
ValorValue O valor que será atribuído à variável de ambiente.The value to assign to the environment variable.

ExemploExample

O exemplo a seguir assegura que TestEnvironmentVariable esteja presente e tenha o valor TestValue.The following example ensures that TestEnvironmentVariable is present and it has the value TestValue. Se não estiver presente, será criado.If it is not present, it creates it.

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