Zasób zasób groupset DSCDSC GroupSet Resource

Dotyczy: Windows PowerShell 5. xApplies To: Windows PowerShell 5.x

Zasób zasób groupset w konfiguracji żądanego stanu (DSC) programu Windows PowerShell udostępnia mechanizm zarządzania grupami lokalnymi w węźle docelowym.The GroupSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local groups on the target node. Ten zasób jest zasobem złożonym , który wywołuje zasób grupy dla każdej grupy określonej w GroupName parametrze.This resource is a composite resource that calls the Group resource for each group specified in the GroupName parameter.

Użyj tego zasobu, jeśli chcesz dodać i/lub usunąć tę samą listę elementów członkowskich w więcej niż jednej grupie, usunąć więcej niż jedną grupę lub dodać więcej niż jedną grupę z tą samą listą członków.Use this resource when you want to add and/or remove the same list of members to more than one group, remove more than one group, or add more than one group with the same list of members.

SkładniaSyntax

Group [string] #ResourceName
{
    GroupName = [string[]]
    [ MembersToInclude = [string[]] ]
    [ MembersToExclude = [string[]] ]
    [ Credential = [PSCredential] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

WłaściwościProperties

WłaściwośćProperty OpisDescription
GroupNameGroupName Nazwy grup, dla których chcesz zapewnić określony stan.The names of the groups for which you want to ensure a specific state.
Elementy członkowskieMembers Ta właściwość służy do zastępowania bieżącego członkostwa w grupie określonym członkom.Use this property to replace the current group membership with the specified members. Wartość tej właściwości jest tablicą ciągów w formularzu Domain\UserName .The value of this property is an array of strings of the form Domain\UserName. W przypadku ustawienia tej właściwości w konfiguracji nie należy używać właściwości MembersToExclude ani MembersToInclude .If you set this property in a configuration, do not use either the MembersToExclude or MembersToInclude property. Wykonanie tej czynności spowoduje wygenerowanie błędu.Doing so will generate an error.
MembersToIncludeMembersToInclude Użyj tej właściwości, aby dodać członków do istniejącego członkostwa w grupie.Use this property to add members to the existing membership of the group. Wartość tej właściwości jest tablicą ciągów w formularzu Domain\UserName .The value of this property is an array of strings of the form Domain\UserName. W przypadku ustawienia tej właściwości w konfiguracji nie należy używać właściwości Members .If you set this property in a configuration, do not use the Members property. Wykonanie tej czynności spowoduje wygenerowanie błędu.Doing so will generate an error.
MembersToExcludeMembersToExclude Ta właściwość służy do usuwania członków z istniejących członkostw w grupach.Use this property to remove members from the existing membership of the groups. Wartość tej właściwości jest tablicą ciągów w formularzu Domain\UserName .The value of this property is an array of strings of the form Domain\UserName. W przypadku ustawienia tej właściwości w konfiguracji nie należy używać właściwości Members .If you set this property in a configuration, do not use the Members property. Wykonanie tej czynności spowoduje wygenerowanie błędu.Doing so will generate an error.
PoświadczenieCredential Poświadczenia wymagane do uzyskania dostępu do zdalnych zasobów.The credentials required to access remote resources. To konto musi mieć odpowiednie uprawnienia Active Directory, aby dodać do grupy wszystkie konta nielokalne; w przeciwnym razie wystąpi błąd.This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error will occur.

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 grupy istnieją.Indicates whether the groups exist. Ustaw tę właściwość na Brak , aby upewnić się, że grupy nie istnieją.Set this property to Absent to ensure that the groups do not exist. Ustawienie tej opcji na obecność gwarantuje, że grupy istnieją.Setting it to Present ensures that the groups 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ład 1: zapewnianie, że grupy są obecneExample 1: Ensuring Groups are present

Poniższy przykład pokazuje, jak upewnić się, że istnieją dwie grupy o nazwie "Rozgrupuj" i "Moja inna grupa".The following example shows how to ensure that two groups called "myGroup" and "myOtherGroup" are present.

configuration GroupSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    Node localhost
    {
        GroupSet GroupSetTest
        {
            GroupName        = @("myGroup", "myOtherGroup")
            Ensure           = "Present"
            MembersToInclude = @("contoso\alice", "contoso\bob")
            MembersToExclude = $("contoso\john")
            Credential       = Get-Credential
        }
    }
}
$cd = @{
    AllNodes = @(
        @{
            NodeName                    = 'localhost'
            PSDscAllowPlainTextPassword = $true
            PSDscAllowDomainUser        = $true
        }
    )
}

GroupSetTest -ConfigurationData $cd

Uwaga

W tym przykładzie użyto poświadczeń w postaci zwykłego tekstu dla uproszczenia.This example uses plaintext credentials for simplicity. Informacje o sposobie szyfrowania poświadczeń w pliku MOF konfiguracji znajdują się w temacie Zabezpieczanie pliku MOF.For information about how to encrypt credentials in the configuration MOF file, see Securing the MOF File.