DSC-användar resursDSC User Resource

Gäller för: Windows PowerShell 4,0, Windows PowerShell 5. xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

Användar resursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att hantera lokala användar konton på målnoden.The User resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local user accounts on the target node.

Anteckning

Den här dokumentationen av DSC-resursen omfattar den version som ingår i PowerShell.This documentation of this DSC resource covers the version that is included with PowerShell. PSDscResources -modulen innehåller nya och uppdaterade som officiellt stöds av Microsoft.The PSDscResources module contains new and updated that are officially supported by Microsoft. PSDscResources -modulen är tillgänglig från PowerShell-galleriet.The PSDscResources module is available from the PowerShell Gallery.

Mer information och uppdaterad dokumentation finns i README i GitHub-lagringsplatsen.For more information and updated documentation, see the README in the GitHub repository.

SyntaxSyntax

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] ]
}

EgenskaperProperties

EgenskapProperty BeskrivningDescription
AnvändarnamnUserName Anger det konto namn som du vill säkerställa ett speciellt tillstånd för.Indicates the account name for which you want to ensure a specific state.
BeskrivningDescription Anger beskrivningen som du vill använda för användar kontot.Indicates the description you want to use for the user account.
InaktiveradDisabled Anger om kontot är aktiverat.Indicates if the account is enabled. Ange den här egenskapen till $true för att säkerställa att det här kontot är inaktiverat och ange det för att $false säkerställa att det är aktiverat.Set this property to $true to ensure that this account is disabled, and set it to $false to ensure that it is enabled.
FullNameFullName Representerar en sträng med det fullständiga namn som du vill använda för användar kontot.Represents a string with the full name you want to use for the user account.
LösenordPassword Anger det lösen ord som du vill använda för det här kontot.Indicates the password you want to use for this account.
PasswordChangeNotAllowedPasswordChangeNotAllowed Anger om användaren kan ändra lösen ordet.Indicates if the user can change the password. Ange den här egenskapen till $true om du vill se till att användaren inte kan ändra lösen ordet och ange det som $false tillåter användaren att ändra lösen ordet.Set this property to $true to ensure that the user cannot change the password, and set it to $false to allow the user to change the password. Standardvärdet är $false.The default value is $false.
PasswordChangeRequiredPasswordChangeRequired Anger om användaren måste ändra lösen ordet vid nästa inloggning.Indicates if the user must change the password at the next sign in. Ange den här egenskapen till $true om användaren måste ändra lösen ordet.Set this property to $true if the user must change the password. Standardvärdet är $true.The default value is $true.
PasswordNeverExpiresPasswordNeverExpires Anger om lösen ordet upphör att gälla.Indicates if the password will expire. För att se till att lösen ordet för det här kontot aldrig upphör att gälla, anger du egenskapen till $true .To ensure that the password for this account will never expire, set this property to $true. Ange det som $false om lösen ordet upphör att gälla.Set it to $false if the password will expire. Standardvärdet är $false.The default value is $false.

Gemensamma egenskaperCommon properties

EgenskapProperty BeskrivningDescription
DependsOnDependsOn Anger att konfigurationen av en annan resurs måste köras innan den här resursen har kon figurer ATS.Indicates that the configuration of another resource must run before this resource is configured. Exempel: om ID: t för skript blocket för resurs konfigurationen som du vill köra först är ResourceName och dess typ är ResourceType, är syntaxen för att använda den här egenskapen DependsOn = "[ResourceType]ResourceName" .For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
KontrolEnsure Anger om kontot finns.Indicates if the account exists. Ange att den här egenskapen finns för att se till att kontot finns och att det inte finns något att se till att kontot inte finns.Set this property to Present to ensure that the account exists, and set it to Absent to ensure that the account does not exist. Standardvärdet finns .The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Anger autentiseringsuppgifter för att köra hela resursen som.Sets the credential for running the entire resource as.

Anteckning

Den gemensamma egenskapen PsDscRunAsCredential har lagts till i WMF 5,0 för att tillåta körning av DSC-resurser i kontexten för andra autentiseringsuppgifter.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Mer information finns i använda autentiseringsuppgifter med DSC-resurser.For more information, see Use Credentials with DSC Resources.

ExempelExample

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
}