Share via


Miljö

Synopsis

Hantera en miljövariabel för en dator eller process.

Syntax

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

Description

Med resursen Environment kan du skapa, uppdatera och ta bort miljövariabler i Machine målen och Process . Den kan hantera miljövariabler av sökvägstyp, så att ett visst värde inkluderas eller tas bort från miljövariabeln.

Krav

Inga.

Nyckelegenskaper

Name

Ange namnet på miljövariabeln.

Type: System.String

Valfria egenskaper

Säkerställa

Ange om miljövariabeln ska finnas. Ange den här egenskapen för Absent att ta bort miljövariabeln om den finns. Ange den här egenskapen för Present att skapa miljövariabeln om den inte finns och framtvinga egenskapen Value om den har angetts. Standardvärdet är Present.

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

Sökväg

Ange om miljövariabeln ska behandlas som en sökvägsvariabel. Detta ändrar miljövariabeln Se till att den fungerar:

  • När Sökväg är $true, Se till är Presentoch värdet inte ingår i det aktuella värdet för miljövariabeln lägger resursen till värdet till det aktuella värdet för miljövariabeln.
  • När Sökvägen är $true, Se till är Absentoch värdet ingår i det aktuella värdet för miljövariabeln, tar resursen bort värdet från det aktuella värdet för miljövariabeln.
  • När Sökväg är $false och Kontrollera är Presentanger resursen miljövariabeln till Värde.
  • När Sökväg är $false och Kontrollera är Absenttar resursen bort miljövariabeln.

Standardvärdet är $false.

Type: System.Boolean
Default Value: false

Mål

Ange ett eller flera mål för att konfigurera miljövariabeln i. Giltiga värden är:

  • Process
  • Machine

Som standard konfigureras miljövariabeln i både Process målen och Machine .

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

Värde

Ange miljövariabelns värde som en sträng. Om Värdet är en tom sträng ('') ändrar miljövariabeln Kontrollera beteende:

  • När Värdet är en tom sträng, Kontrollera är Presentoch miljövariabeln finns, uppdaterar resursen inte miljövariabeln.
  • När Värdet är en tom sträng, Kontrollera är Present, och miljövariabeln inte finns, genererar resursen ett ogiltigt åtgärdsfel.
  • När Värdet är en tom sträng, Kontrollera är Absentoch miljövariabeln finns, tar resursen bort miljövariabeln.

Standardvärdet är en tom sträng.

Type: System.String
Default Value: ''

Exempel