DSC-csoport erőforrásaDSC Group Resource

A következőkre vonatkozik: Windows PowerShell 4,0, Windows PowerShell 5. xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

A Windows PowerShell desired State Configuration (DSC) csoport erőforrásai a helyi csoportok kezelésére szolgáló mechanizmust biztosítanak a célként megadott csomóponton.The Group resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local groups on the target node.

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

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

TulajdonságokProperties

TulajdonságProperty LeírásDescription
GroupNameGroupName Annak a csoportnak a neve, amelynek egy adott állapotát biztosítani kívánja.The name of the group for which you want to ensure a specific state.
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, amikor a rendszer végrehajtja a konfigurációt a cél csomóponton.This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error occurs when the configuration is executed on the target node.
LeírásDescription A csoport leírása.The description of the group.
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 generál.Doing so generates an error.
MembersToExcludeMembersToExclude Ezzel a tulajdonsággal távolíthatja el a tagokat a csoport meglévő tagjaiból.Use this property to remove members from 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 generál.Doing so generates 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.

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 létezik-e a csoport.Indicates if the group exists. Állítsa a tulajdonságot hiányzó értékre, és győződjön meg arról, hogy a csoport nem létezik.Set this property to Absent to ensure that the group does not exist. A beállítás bejelölése biztosítja, hogy a csoport létezik.Setting it to Present ensures that the group exists. 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: Ügyeljen rá, hogy a csoport ne legyen jelenExample 1: Ensure group is not present

Az alábbi példa bemutatja, hogyan biztosítható a "TestGroup" nevű csoport hiánya.The following example shows how to ensure that a group called "TestGroup" is absent.

Group GroupExample
{
    # This removes TestGroup, if present
    # To create a new group, set Ensure to "Present"
    Ensure = "Absent"
    GroupName = "TestGroup"
}

2. példa: tartományi felhasználó hozzáadása a helyi csoporthozExample 2: Add domain user to local group

Az alábbi példa bemutatja, hogyan adhat hozzá egy Active Directory felhasználót a helyi Rendszergazdák csoporthoz egy többszámítógépes labor-összeállítás részeként, ahol már használ PSCredential a helyi rendszergazdai fiókhoz.The following example shows how to add an Active Directory User to the local administrators group as part of a Multi-Machine Lab build where you are already using a PSCredential for the Local Administrator account. Mivel ez a tartományi rendszergazdai fiókhoz is használatos (a tartomány előléptetése után), ezt követően át kell alakítania a meglévő PSCredential egy tartomány-barát hitelesítő adatra.As this is also used for the Domain Admin Account (after Domain promotion), we then need to convert this existing PSCredential to a Domain Friendly credential. Ezután hozzáadhat egy tartományi felhasználót a helyi Rendszergazdák csoporthoz a tagkiszolgálón.Then we can add a Domain User to the Local Administrators Group on the Member server.

@{
    AllNodes = @(
        @{
            NodeName = '*';
            DomainName = 'SubTest.contoso.com';
         }
        @{
            NodeName = 'Box2';
            AdminAccount = 'Admin-Dave_Alexanderson'
        }
    )
}

$domain = $node.DomainName.split('.')[0]
$DCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList ("$domain\$($credential.Username)", $Credential.Password)

Group AddADUserToLocalAdminGroup {
    GroupName='Administrators'
    Ensure= 'Present'
    MembersToInclude= "$domain\$($Node.AdminAccount)"
    Credential = $dCredential
    PsDscRunAsCredential = $DCredential
}

3. példaExample 3

Az alábbi példa azt szemlélteti, hogyan biztosítható, hogy egy helyi csoport, a TigerTeamAdmins, a TigerTeamSource.Contoso.Com-kiszolgáló ne tartalmazzon egy adott tartományi fiókot, Contoso\JerryG.The following example shows how to ensure a local group, TigerTeamAdmins, on the server TigerTeamSource.Contoso.Com does not contain a particular domain account, Contoso\JerryG.

Configuration SecureTigerTeamSource {
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

    Node TigerTeamSource.Contoso.Com {
        Group TigerTeamAdmins {
            GroupName        = 'TigerTeamAdmins'
            Ensure           = 'Present'
            MembersToExclude = "Contoso\JerryG"
        }
    }
}