Share via


Ambiente

Riepilogo

Gestire una variabile di ambiente per un computer o un processo.

Sintassi

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

Descrizione

La Environment risorsa consente di creare, aggiornare e rimuovere variabili di ambiente nelle Machine destinazioni e Process . Può gestire le variabili di ambiente di tipo percorso, assicurandosi che un valore specifico venga incluso o rimosso dalla variabile di ambiente.

Requisiti

No.

Proprietà della chiave

Nome

Specificare il nome della variabile di ambiente.

Type: System.String

Proprietà facoltative

Ensure

Specificare se la variabile di ambiente deve esistere. Specificare questa proprietà per Absent rimuovere la variabile di ambiente, se esistente. Specificare questa proprietà come Present per creare la variabile di ambiente, se non esiste e applicare la proprietà Value , se impostata. Il valore predefinito è Present.

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

Percorso

Specificare se considerare la variabile di ambiente come variabile di percorso. In questo modo viene modificato il comportamento Di verifica per la variabile di ambiente:

  • Quando Path è $true, Assicurarsi che sia Presente value non sia incluso nel valore corrente della variabile di ambiente, la risorsa aggiunge value al valore corrente della variabile di ambiente.
  • Quando Path è $true, assicurarsi che sia Absente il valore Value sia incluso nel valore corrente della variabile di ambiente, la risorsa rimuove il valore value dalla variabile di ambiente corrente.
  • Quando Path è $false e Ensure è Present, la risorsa imposta la variabile di ambiente su Value.
  • Quando Path è $false e Assicurarsi che sia Absent, la risorsa rimuove la variabile di ambiente.

Il valore predefinito è $false.

Type: System.Boolean
Default Value: false

Destinazione

Specificare una o più entità di destinazione in cui configurare la variabile di ambiente. I valori validi includono:

  • Process
  • Machine

Per impostazione predefinita, la variabile di ambiente è configurata sia nelle destinazioni che ProcessMachine in .

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

valore

Specificare il valore della variabile di ambiente come stringa. Indica se Value è una stringa vuota ('') modifica il comportamento Di verifica per la variabile di ambiente:

  • Quando Value è una stringa vuota, Assicurarsi che sia Presente la variabile di ambiente esista, la risorsa non aggiorna la variabile di ambiente.
  • Quando Value è una stringa vuota, Assicurarsi che sia Presente la variabile di ambiente non esiste, la risorsa genera un'eccezione di operazione non valida.
  • Quando Value è una stringa vuota, Assicurarsi che sia Absente la variabile di ambiente esista, la risorsa rimuove la variabile di ambiente.

Il valore predefinito è una stringa vuota.

Type: System.String
Default Value: ''

Esempi