DSC-användarresurs

Gäller för: Windows PowerShell 4.0 Windows PowerShell 5.x

Användarresursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att hantera lokala användarkonton på målnoden.

Anteckning

Den här dokumentationen för den här DSC-resursen omfattar den version som ingår i PowerShell före version 7.2. Modulen PSDscResources innehåller nya och uppdaterade DSC-resurser som stöds officiellt av Microsoft. Modulen PSDscResources är tillgänglig från PowerShell-galleriet.

Mer information och uppdaterad dokumentation finns i referensdokumentationen för PSDscResources.

Syntax

User [string] #ResourceName
{
    UserName = [string]
    [ Description = [string] ]
    [ Disabled = [bool] ]
    [ FullName = [string] ]
    [ Password = [PSCredential] ]
    [ PasswordChangeNotAllowed = [bool] ]
    [ PasswordChangeRequired = [bool] ]
    [ PasswordNeverExpires = [bool] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Egenskaper

Egenskap	Beskrivning
Användarnamn	Anger det kontonamn som du vill säkerställa ett visst tillstånd för.
Description	Anger den beskrivning som du vill använda för användarkontot.
Inaktiverad	Anger om kontot är aktiverat. Ange den här egenskapen till $true för att säkerställa att det här kontot är inaktiverat och ange det till $false för att säkerställa att det är aktiverat.
FullName	Representerar en sträng med det fullständiga namn som du vill använda för användarkontot.
Lösenord	Anger det lösenord som du vill använda för det här kontot.
PasswordChangeNotAllowed	Anger om användaren kan ändra lösenordet. Ange den här egenskapen till $true för att säkerställa att användaren inte kan ändra lösenordet och ange det till $false så att användaren kan ändra lösenordet. Standardvärdet är $false.
PasswordChangeRequired	Anger om användaren måste ändra lösenordet vid nästa inloggning. Ange den här egenskapen till $true om användaren måste ändra lösenordet. Standardvärdet är $true.
PasswordNeverExpires	Anger om lösenordet upphör att gälla. För att säkerställa att lösenordet för det här kontot aldrig upphör att gälla anger du den här egenskapen till $true. Ange det till $false om lösenordet upphör att gälla. Standardvärdet är $false.

Gemensamma egenskaper

Egenskap	Beskrivning
DependsOn	Anger att konfigurationen av en annan resurs måste köras innan den här resursen har konfigurerats. Om till exempel ID:t för resurskonfigurationsskriptblocket som du vill köra först är ResourceName och dess typ är ResourceType är DependsOn = "[ResourceType]ResourceName"syntaxen för att använda den här egenskapen .
Säkerställa	Anger om kontot finns. Ställ in den här egenskapen på Presentera för att säkerställa att kontot finns och ställ in det på Frånvarande för att säkerställa att kontot inte finns. Standardvärdet är Present.
PsDscRunAsCredential	Anger autentiseringsuppgifterna för att köra hela resursen som.

Anteckning

Den vanliga egenskapen PsDscRunAsCredential lades till i WMF 5.0 för att tillåta körning av valfri DSC-resurs i kontexten för andra autentiseringsuppgifter. Mer information finns i Använda autentiseringsuppgifter med DSC-resurser.

Exempel

User UserExample
{
    Ensure = "Present"  # To ensure the user account does not exist, set Ensure to "Absent"
    UserName = "SomeName"
    Password = $passwordCred # This needs to be a credential object
    DependsOn = "[Group]GroupExample" # Configures GroupExample first
}