Ambiente

Artigo
05/05/2023

Sinopse

Gerenciar uma variável de ambiente para um computador ou processo.

Sintaxe

Environment [String] #ResourceName
{
    Name = [string]
    [DependsOn = [string[]]]
    [Ensure = [string]{ Absent | Present }]
    [Path = [bool]]
    [PsDscRunAsCredential = [PSCredential]]
    [Target = [string[]]{ Machine | Process }]
    [Value = [string]]
}

Descrição

O Environment recurso permite que você crie, atualize e remova variáveis de Machine ambiente nos destinos e Process destinos. Ele pode gerenciar variáveis de ambiente do tipo caminho, garantindo que um valor específico seja incluído ou removido da variável de ambiente.

Requisitos

Nenhum.

Propriedades da chave

Nome

Especifique o nome da variável de ambiente.

Type: System.String

Propriedades opcionais

Ensure

Especifique se a variável de ambiente deve existir. Especifique essa propriedade Absent para remover a variável de ambiente se ela existir. Especifique essa propriedade Present para criar a variável de ambiente se ela não existir e impor a propriedade Value se ela estiver definida. O valor padrão é Present.

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

Caminho

Especifique se a variável de ambiente deve ser tratada como uma variável de caminho. Isso modifica o comportamento De garantir para a variável de ambiente:

Quando Path é $true, Ensure is Present, e o Valor não está incluído no valor atual da variável de ambiente, o recurso acrescenta o Valor ao valor atual da variável de ambiente.
Quando Path é $true, Ensure é Absent, e o Valor é incluído no valor atual da variável de ambiente, o recurso remove o valor do valor atual da variável de ambiente.
Quando Path é $false e Ensure é Present, o recurso define a variável de ambiente como Valor.
Quando Path é $false e Ensure é Absent, o recurso remove a variável de ambiente.

O valor padrão é $false.

Type: System.Boolean
Default Value: false

Destino

Especifique um ou mais destinos para configurar a variável de ambiente. Os valores válidos incluem:

Process
Machine

Por padrão, a variável de ambiente é configurada nos destinos e Machine nos Process destinos.

Type: System.String[]
Accepted Values:
  - Process
  - Machine
Default Value: [Process, Machine]

Valor

Especifique o valor da variável de ambiente como uma cadeia de caracteres. Se Value é uma cadeia de caracteres vazia ('') modifica o comportamento Ensure para a variável de ambiente:

Quando Value é uma cadeia de caracteres vazia, Ensure é Present, e a variável de ambiente existe, o recurso não atualiza a variável de ambiente.
Quando Value é uma cadeia de caracteres vazia, Ensure é Present, e a variável de ambiente não existe, o recurso gera uma exceção de operação inválida.
Quando Value é uma cadeia de caracteres vazia, Ensure é Absent, e a variável de ambiente existe, o recurso remove a variável de ambiente.

O valor padrão é uma cadeia de caracteres vazia.

Type: System.String
Default Value: ''

Share via