Zasób użytkownika DSCDSC User Resource

Dotyczy: Windows PowerShell 4,0, Windows PowerShell 5. xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób użytkownika w konfiguracji żądanego stanu (DSC) programu Windows PowerShell zapewnia mechanizm zarządzania kontami użytkowników lokalnych w węźle docelowym.The User resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local user accounts on the target node.

SkładniaSyntax

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

WłaściwościProperties

WłaściwośćProperty OpisDescription
Nazwa użytkownikaUserName Wskazuje nazwę konta, dla którego chcesz zapewnić określony stan.Indicates the account name for which you want to ensure a specific state.
OpisDescription Wskazuje opis, którego chcesz użyć dla konta użytkownika.Indicates the description you want to use for the user account.
DisabledDisabled Wskazuje, czy konto jest włączone.Indicates if the account is enabled. Ustaw tę właściwość na $true , aby upewnić się, że to konto jest wyłączone, i ustaw je tak, aby $false upewnić się, że jest włączone.Set this property to $true to ensure that this account is disabled, and set it to $false to ensure that it is enabled.
Pełna nazwaFullName Reprezentuje ciąg o pełnej nazwie, który ma być używany dla konta użytkownika.Represents a string with the full name you want to use for the user account.
HasłoPassword Wskazuje hasło, które ma być używane dla tego konta.Indicates the password you want to use for this account.
PasswordChangeNotAllowedPasswordChangeNotAllowed Wskazuje, czy użytkownik może zmienić hasło.Indicates if the user can change the password. Ustaw tę właściwość na $true , aby upewnić się, że użytkownik nie może zmienić hasła, i ustawi ją w $false celu zezwolenia użytkownikowi na zmianę hasła.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. Wartość domyślna to $false.The default value is $false.
PasswordChangeRequiredPasswordChangeRequired Wskazuje, czy użytkownik musi zmienić hasło przy następnym logowaniu.Indicates if the user must change the password at the next sign in. Ustaw tę właściwość na $true , jeśli użytkownik musi zmienić hasło.Set this property to $true if the user must change the password. Wartość domyślna to $true.The default value is $true.
PasswordNeverExpiresPasswordNeverExpires Wskazuje, czy hasło wygaśnie.Indicates if the password will expire. Aby upewnić się, że hasło dla tego konta nigdy nie wygasa, należy ustawić tę właściwość na $true .To ensure that the password for this account will never expire, set this property to $true. Ustaw tę wartość, $false Jeśli hasło wygaśnie.Set it to $false if the password will expire. Wartość domyślna to $false.The default value is $false.

Wspólne właściwościCommon properties

WłaściwośćProperty OpisDescription
DependsOnDependsOn Wskazuje, że konfiguracja innego zasobu musi być uruchomiona przed skonfigurowaniem tego zasobu.Indicates that the configuration of another resource must run before this resource is configured. Na przykład, jeśli identyfikator bloku skryptu konfiguracji zasobu, który ma zostać uruchomiony jako pierwszy jest resourceName, a jego typ to ResourceType, Składnia służąca do użycia tej właściwości to 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".
Upewnij się żeEnsure Wskazuje, czy konto istnieje.Indicates if the account exists. Ustaw tę właściwość na wartość tak , aby upewnić się, że konto istnieje, i ustaw je jako nieobecne , aby upewnić się, że konto nie istnieje.Set this property to Present to ensure that the account exists, and set it to Absent to ensure that the account does not exist. Wartość domyślna jest obecna.The default value is Present.
PsDscRunAsCredentialPsDscRunAsCredential Ustawia poświadczenia do uruchamiania całego zasobu jako.Sets the credential for running the entire resource as.

Uwaga

Właściwość PsDscRunAsCredential Common została dodana w programie WMF 5,0, aby umożliwić uruchamianie dowolnego zasobu DSC w kontekście innych poświadczeń.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Aby uzyskać więcej informacji, zobacz Korzystanie z poświadczeń z zasobami DSC.For more information, see Use Credentials with DSC Resources.

PrzykładExample

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
}