Recurso de GroupSet DSCDSC GroupSet Resource

Aplica-se a: Windows Windows PowerShell 5.0Applies To: Windows Windows PowerShell 5.0

O recurso GroupSet na DSC (Configuração de Estado Desejado) do Windows PowerShell oferece um mecanismo para gerenciar grupos locais no nó de destino.The GroupSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local groups on the target node. Esse recurso é um recurso composto que chama o Recurso de grupo para cada grupo especificado no parâmetro GroupName.This resource is a composite resource that calls the Group resource for each group specified in the GroupName parameter.

Use esse recurso quando desejar adicionar e/ou remover a mesma lista de membros para mais de um grupo, remova mais de um grupo ou adicionar mais de um grupo com a mesma lista de membros.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.

Sintaxe##Syntax##

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

PropriedadesProperties

PropriedadeProperty DescriçãoDescription
GroupNameGroupName Os nomes dos grupos para os quais você deseja garantir um estado específico.The names of the groups for which you want to ensure a specific state.
MembersToExcludeMembersToExclude Use essa propriedade para remover membros da associação existente dos grupos.Use this property to remove members from the existing membership of the groups. O valor dessa propriedade é uma matriz de cadeias de caracteres do formulário Domínio\NomeDoUsuário.The value of this property is an array of strings of the form Domain\UserName. Se você definir essa propriedade em uma configuração, não use a propriedade Membros.If you set this property in a configuration, do not use the Members property. Isso vai gerar um erro.Doing so will generate an error.
CredentialCredential As credenciais necessárias para acessar recursos remotos.The credentials required to access remote resources. Observação: essa conta deve ter as permissões apropriadas do Active Directory para adicionar todas as contas não locais ao grupo; caso contrário, ocorrerá um erro.Note: This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error will occur.
EnsureEnsure Indica se os grupos existem.Indicates whether the groups exist. Defina essa propriedade como "Ausente" para garantir que os grupos não existam.Set this property to "Absent" to ensure that the groups do not exist. Configurá-la como "Present" (o valor padrão) garante que os grupos existam.Setting it to "Present" (the default value) ensures that the groups exist.
MembrosMembers Use essa propriedade para substituir a associação ao grupo pelos membros especificados.Use this property to replace the current group membership with the specified members. O valor dessa propriedade é uma matriz de cadeias de caracteres do formulário Domínio\NomeDoUsuário.The value of this property is an array of strings of the form Domain\UserName. Se você definir essa propriedade em uma configuração, não use a propriedade MembersToExclude ou MembersToInclude.If you set this property in a configuration, do not use either the MembersToExclude or MembersToInclude property. Isso vai gerar um erro.Doing so will generate an error.
MembersToIncludeMembersToInclude Use essa propriedade para adicionar membros à associação existente do grupo.Use this property to add members to the existing membership of the group. O valor dessa propriedade é uma matriz de cadeias de caracteres do formulário Domínio\NomeDoUsuário.The value of this property is an array of strings of the form Domain\UserName. Se você definir essa propriedade em uma configuração, não use a propriedade Membros.If you set this property in a configuration, do not use the Members property. Isso vai gerar um erro.Doing so will generate an error.
DependsOnDependsOn Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado.Indicates that the configuration of another resource must run before this resource is configured. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será 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"`.

Exemplo 1Example 1

O exemplo a seguir mostra como garantir que dois grupos chamados "myGroup" e "myOtherGroup" estejam presentes.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

Observação: este exemplo usa as credenciais de texto sem formatação para manter a simplicidade.Note: This example uses plaintext credentials for simplicity. Para obter informações sobre como criptografar credenciais no arquivo MOF de configuração, consulte Protegendo o Arquivo MOF.For information about how to encrypt credentials in the configuration MOF file, see Securing the MOF File.