Environnement
Synopsis
Gérer une variable d’environnement pour un ordinateur ou un processus.
Syntaxe
Environment [String] #ResourceName
{
Name = [string]
[DependsOn = [string[]]]
[Ensure = [string]{ Absent | Present }]
[Path = [bool]]
[PsDscRunAsCredential = [PSCredential]]
[Target = [string[]]{ Machine | Process }]
[Value = [string]]
}
Description
La Environment
ressource vous permet de créer, mettre à jour et supprimer des variables d’environnement dans les cibles et Process
les Machine
cibles. Il peut gérer les variables d’environnement de type de chemin, en veillant à ce qu’une valeur spécifique soit incluse ou supprimée de la variable d’environnement.
Configuration requise
Aucun.
Propriétés de la clé
Nom
Spécifiez le nom de la variable d’environnement.
Type: System.String
Propriétés facultatives
Ensure
Spécifiez si la variable d’environnement doit exister. Spécifiez cette propriété pour Absent
supprimer la variable d’environnement si elle existe. Spécifiez cette propriété pour Present
créer la variable d’environnement si elle n’existe pas et appliquer la propriété Value si elle est définie. La valeur par défaut est Present
.
Type: System.String
Accepted Values:
- Absent
- Present
Default Value: Present
Chemin d’accès
Spécifiez s’il faut traiter la variable d’environnement comme une variable de chemin d’accès. Cela modifie le comportement De garantir le comportement de la variable d’environnement :
- Lorsque path is
$true
, Ensure isPresent
, and the Value is not included in the current value of the environment variable, the resource append the Value to the current value of the environment variable. - Lorsque path is
$true
, Ensure isAbsent
, and the Value is included in the current value of the environment variable, the resource remove the Value from the current value of the environment variable. - Quand path is and
$false
Ensure isPresent
is, the resource définit la variable d’environnement sur Value. - Quand path is
$false
and Ensure isAbsent
is, the resource remove the environment variable.
La valeur par défaut est $false
.
Type: System.Boolean
Default Value: false
Cible
Spécifiez une ou plusieurs cibles dans laquelle configurer la variable d’environnement. Les valeurs valides sont les suivantes :
Process
Machine
Par défaut, la variable d’environnement est configurée à la fois dans les cibles et Machine
les Process
cibles.
Type: System.String[]
Accepted Values:
- Process
- Machine
Default Value: [Process, Machine]
Valeur
Spécifiez la valeur de la variable d’environnement en tant que chaîne. Indique si la valeur est une chaîne vide (''
) modifie le comportement Garantir le comportement de la variable d’environnement :
- Lorsque la valeur est une chaîne vide, Vérifiez qu’elle existe
Present
et que la variable d’environnement existe, la ressource ne met pas à jour la variable d’environnement. - Lorsque la valeur est une chaîne vide, Vérifiez qu’elle n’existe
Present
pas et que la variable d’environnement n’existe pas, la ressource lève une exception d’opération non valide. - Lorsque la valeur est une chaîne vide, Vérifiez qu’elle existe
Absent
et que la variable d’environnement existe, la ressource supprime la variable d’environnement.
La valeur par défaut est une chaîne vide.
Type: System.String
Default Value: ''
Exemples
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour