DSC GroupSet-erőforrásDSC GroupSet Resource

A következőkre vonatkozik: Windows PowerShell 5. xApplies To: Windows PowerShell 5.x

A Windows PowerShell desired State Configuration (DSC) GroupSet erőforrása lehetővé teszi a helyi csoportok kezelésére szolgáló mechanizmust a cél csomóponton.The GroupSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local groups on the target node. Ez az erőforrás egy összetett erőforrás , amely meghívja a csoport erőforrását a paraméterben megadott egyes csoportok esetében GroupName .This resource is a composite resource that calls the Group resource for each group specified in the GroupName parameter.

Ezt az erőforrást akkor használja, ha egynél több csoportba kívánja felvenni és/vagy eltávolítani a tagok listáját, több csoportot is eltávolíthat, vagy több csoportot is hozzáadhat ugyanahhoz a listához.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.

Megjegyzés

A DSC-erőforrás ezen dokumentációja a PowerShell részét képező verziót fedi le.This documentation of this DSC resource covers the version that is included with PowerShell. A PSDscResources modul olyan új és frissített frissítést tartalmaz, amelyet a Microsoft hivatalosan támogat.The PSDscResources module contains new and updated that are officially supported by Microsoft. A PSDscResources modul a PowerShell-Galéria érhető el.The PSDscResources module is available from the PowerShell Gallery.

További információért és a frissített dokumentációért tekintse meg a következő témakört: readme a GitHub-tárházban.For more information and updated documentation, see the README in the GitHub repository.

SyntaxSyntax

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

TulajdonságokProperties

TulajdonságProperty LeírásDescription
GroupNameGroupName Azoknak a csoportoknak a neve, amelyeknek biztosítani kívánja egy adott állapotot.The names of the groups for which you want to ensure a specific state.
TagokMembers Ezzel a tulajdonsággal lecserélheti a jelenlegi csoporttagság értékét a megadott tagokkal.Use this property to replace the current group membership with the specified members. Ennek a tulajdonságnak az értéke az űrlap karakterláncának tömbje Domain\UserName .The value of this property is an array of strings of the form Domain\UserName. Ha ezt a tulajdonságot egy konfigurációban állítja be, ne használja a MembersToExclude vagy a MembersToInclude tulajdonságot.If you set this property in a configuration, do not use either the MembersToExclude or MembersToInclude property. Ezzel hibát fog eredményezni.Doing so will generate an error.
MembersToIncludeMembersToInclude Ezzel a tulajdonsággal adhat hozzá tagokat a csoport meglévő tagjaihoz.Use this property to add members to the existing membership of the group. Ennek a tulajdonságnak az értéke az űrlap karakterláncának tömbje Domain\UserName .The value of this property is an array of strings of the form Domain\UserName. Ha ezt a tulajdonságot egy konfigurációban állítja be, ne használja a Members tulajdonságot.If you set this property in a configuration, do not use the Members property. Ezzel hibát fog eredményezni.Doing so will generate an error.
MembersToExcludeMembersToExclude Ezzel a tulajdonsággal távolíthatja el a tagokat a csoportok meglévő tagságáról.Use this property to remove members from the existing membership of the groups. Ennek a tulajdonságnak az értéke az űrlap karakterláncának tömbje Domain\UserName .The value of this property is an array of strings of the form Domain\UserName. Ha ezt a tulajdonságot egy konfigurációban állítja be, ne használja a Members tulajdonságot.If you set this property in a configuration, do not use the Members property. Ezzel hibát fog eredményezni.Doing so will generate an error.
Hitelesítő adatCredential A távoli erőforrások eléréséhez szükséges hitelesítő adatok.The credentials required to access remote resources. Ennek a fióknak a megfelelő Active Directory engedélyekkel kell rendelkeznie az összes nem helyi fiók hozzáadásához a csoportba; Ellenkező esetben hiba történik.This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error will occur.

Közös tulajdonságokCommon properties

TulajdonságProperty LeírásDescription
DependsOnDependsOn Azt jelzi, hogy egy másik erőforrás konfigurációjának futnia kell az erőforrás konfigurálása előtt.Indicates that the configuration of another resource must run before this resource is configured. Ha például az az erőforrás-konfigurációs parancsfájl blokkja, amelyet először szeretne futtatni, ResourceName, és a típusa ResourceType, a tulajdonság használatának szintaxisa a következő: 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".
BiztosításaEnsure Azt jelzi, hogy a csoportok léteznek-e.Indicates whether the groups exist. Állítsa a tulajdonságot hiányzó értékre, és győződjön meg arról, hogy a csoportok nem léteznek.Set this property to Absent to ensure that the groups do not exist. A beállítás bejelölése biztosítja, hogy a csoportok léteznek.Setting it to Present ensures that the groups exist. Az alapértelmezett érték jelen van.The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Beállítja a teljes erőforrás futtatásához használt hitelesítő adatokat.Sets the credential for running the entire resource as.

Megjegyzés

A PsDscRunAsCredential Common tulajdonsága a WMF 5,0-ben lett hozzáadva, hogy bármely DSC-erőforrást más hitelesítő adatok kontextusában futtasson.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. További információ: a hitelesítő adatok használata a DSC-erőforrásokkal.For more information, see Use Credentials with DSC Resources.

1. példa: csoportok biztosításaExample 1: Ensuring Groups are present

Az alábbi példa bemutatja, hogyan biztosítható a "myGroup" és a "myOtherGroup" nevű csoport.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

Megjegyzés

Ez a példa egyszerű szöveges hitelesítő adatokat használ az egyszerűség kedvéért.This example uses plaintext credentials for simplicity. További információ a hitelesítő adatoknak a konfigurációs MOF-fájlban való titkosításáról: a MOF-fájl biztonságossá tétele.For information about how to encrypt credentials in the configuration MOF file, see Securing the MOF File.