DSC-GroupSet ResourceDSC GroupSet Resource

Van toepassing op: Windows Windows PowerShell 5.0Applies To: Windows Windows PowerShell 5.0

De GroupSet in Windows PowerShell Desired State Configuration (DSC)-bron biedt een mechanisme voor het beheren van lokale groepen in het doelknooppunt.The GroupSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local groups on the target node. Deze bron is een samengestelde bron die roept de groep resource voor elke groep die is opgegeven in de GroupName parameter.This resource is a composite resource that calls the Group resource for each group specified in the GroupName parameter.

Gebruik deze bron als u wilt toevoegen en/of verwijderen van dezelfde lijst met leden aan meer dan één groep, meer dan één groep te verwijderen of toevoegen van meer dan één groep met dezelfde lijst met leden.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.

Syntaxis ##Syntax##

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

EigenschappenProperties

EigenschapProperty BeschrijvingDescription
GroepsnaamGroupName De namen van de groepen waarvoor u wilt om te controleren of een specifieke status.The names of the groups for which you want to ensure a specific state.
MembersToExcludeMembersToExclude Gebruik deze eigenschap leden verwijderen uit het bestaande lidmaatschap van de groepen.Use this property to remove members from the existing membership of the groups. De waarde van deze eigenschap is een matrix met tekenreeksen van het formulier domein\gebruikersnaam.The value of this property is an array of strings of the form Domain\UserName. Als u deze eigenschap in een configuratie instellen, gebruikt u niet de leden eigenschap.If you set this property in a configuration, do not use the Members property. Hierdoor wordt een fout gegenereerd.Doing so will generate an error.
referentieCredential De referenties die zijn vereist voor toegang tot externe bronnen.The credentials required to access remote resources. Opmerking: dit account de juiste Active Directory-machtigingen voor alle niet-lokale accounts toevoegen aan de groep moet hebben; anders wordt een fout optreedt.Note: This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error will occur.
Zorg ervoor datEnsure Hiermee wordt aangegeven of de groepen bestaan.Indicates whether the groups exist. Deze eigenschap instellen op 'Ontbreekt' om ervoor te zorgen dat de groepen bestaan niet.Set this property to "Absent" to ensure that the groups do not exist. Instellen om "" (de standaardwaarde), zorgt u ervoor dat de groepen bestaan.Setting it to "Present" (the default value) ensures that the groups exist.
LedenMembers Gebruik deze eigenschap het lidmaatschap van de huidige vervangt door de opgegeven leden.Use this property to replace the current group membership with the specified members. De waarde van deze eigenschap is een matrix met tekenreeksen van het formulier domein\gebruikersnaam.The value of this property is an array of strings of the form Domain\UserName. Als u deze eigenschap in een configuratie hebt ingesteld, geen gebruik van ofwel de MembersToExclude of MembersToInclude eigenschap.If you set this property in a configuration, do not use either the MembersToExclude or MembersToInclude property. Hierdoor wordt een fout gegenereerd.Doing so will generate an error.
MembersToIncludeMembersToInclude Gebruik deze eigenschap leden toevoegen aan het bestaande lidmaatschap van de groep.Use this property to add members to the existing membership of the group. De waarde van deze eigenschap is een matrix met tekenreeksen van het formulier domein\gebruikersnaam.The value of this property is an array of strings of the form Domain\UserName. Als u deze eigenschap in een configuratie instellen, gebruikt u niet de leden eigenschap.If you set this property in a configuration, do not use the Members property. Hierdoor wordt een fout gegenereerd.Doing so will generate an error.
dependsOnDependsOn Hiermee wordt aangegeven dat de configuratie van een andere resource uitvoeren moet voordat deze bron is geconfigureerd.Indicates that the configuration of another resource must run before this resource is configured. Bijvoorbeeld, als de ID van de resourceconfiguratie scriptblok die u wilt uitvoeren eerst is ResourceName en het type ResourceType, de syntaxis voor het gebruik van deze eigenschap is ' 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"``.

Voorbeeld 1Example 1

Het volgende voorbeeld laat zien hoe om ervoor te zorgen dat er twee groepen genaamd 'myGroup' en 'myOtherGroup' aanwezig zijn.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

Opmerking: in dit voorbeeld gebruikt de referenties van de tekst zonder opmaak voor eenvoud.Note: This example uses plaintext credentials for simplicity. Zie voor meer informatie over het coderen van referenties in het MOF-bestand voor configuratie beveiligen van het MOF-bestand.For information about how to encrypt credentials in the configuration MOF file, see Securing the MOF File.