Risorsa Environment DSC

Si applica a: Windows PowerShell 4.0, Windows PowerShell 5.x

La risorsa Environment in Windows PowerShell DSC (Desired State Configuration) fornisce un meccanismo per gestire le variabili di ambiente di sistema.

Nota

Questa documentazione di questa risorsa DSC illustra la versione inclusa in PowerShell prima della versione 7.2. Il modulo PSDscResources contiene risorse DSC nuove e aggiornate supportate ufficialmente da Microsoft. Il modulo PSDscResources è disponibile da PowerShell Gallery.

Per altre informazioni e la documentazione aggiornata, vedere la documentazione di riferimento di PSDscResources.

Sintassi

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

Proprietà

Proprietà	Descrizione
Nome	Indica il nome della variabile di ambiente per cui si vuole specificare un determinato stato.
Path	Definisce la variabile di ambiente configurata. Impostare questa proprietà su $true se la variabile è Path. In caso contrario, impostarla su $false. Il valore predefinito è $false. Se la variabile configurata è Path, il valore specificato tramite la proprietà Value viene aggiunto al valore esistente.
valore	Valore da assegnare alla variabile di ambiente.

Proprietà comuni

Proprietà	Descrizione
DependsOn	Indica che prima di configurare la risorsa è necessario eseguire la configurazione di un'altra risorsa. Ad esempio, se il valore di ID del blocco script di configurazione della risorsa che si vuole eseguire per primo è ResourceName e il tipo è ResourceType, la sintassi per usare questa proprietà è DependsOn = "[ResourceType]ResourceName".
Ensure	Indica se una variabile esiste. Impostare questa proprietà su Present per creare una variabile di ambiente se non esiste o per specificare che il suo valore corrisponde a quello fornito tramite la proprietà Value se la variabile esiste già. Impostarla su Absent per eliminare la variabile, se esiste.
PsDscRunAsCredential	Imposta le credenziali per l'esecuzione dell'intera risorsa.

Nota

La proprietà comune PsDscRunAsCredential è stata aggiunta in WMF 5.0 per consentire l'esecuzione di qualsiasi risorsa DSC nel contesto di altre credenziali. Per altre informazioni, vedere Usare credenziali con risorse DSC.

Esempio

L'esempio seguente specifica che TestEnvironmentVariable è presente e ha il valore TestValue. Se la variabile non è presente, viene creata.

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