Zasób zestawu grup DSC

Dotyczy: Windows PowerShell 5.x

Zasób GroupSet w Windows PowerShell Desired State Configuration (DSC) udostępnia mechanizm zarządzania grupami lokalnymi w węźle docelowym. Ten zasób jest zasobem złożonym , który wywołuje zasób grupy dla każdej grupy określonej w parametrze GroupName .

Użyj tego zasobu, jeśli chcesz dodać i/lub usunąć tę samą listę członków do więcej niż jednej grupy, usunąć więcej niż jedną grupę lub dodać więcej niż jedną grupę z tą samą listą członków.

Uwaga

Ta dokumentacja tego zasobu DSC obejmuje wersję dołączoną do programu PowerShell w wersji 7.2. Moduł PSDscResources zawiera nowe i zaktualizowane zasoby DSC, które są oficjalnie obsługiwane przez firmę Microsoft. Moduł PSDscResources jest dostępny w Galeria programu PowerShell.

Aby uzyskać więcej informacji i zaktualizować dokumentację, zobacz dokumentację referencyjną usługi PSDscResources.

Składnia

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

Właściwości

Właściwość	Opis
Groupname	Nazwy grup, dla których chcesz zapewnić określony stan.
Elementy członkowskie	Użyj tej właściwości, aby zastąpić bieżące członkostwo w grupie określonymi członkami. Wartość tej właściwości to tablica ciągów formularza Domain\UserName. Jeśli ta właściwość zostanie ustawiona w konfiguracji, nie należy używać właściwości MembersToExclude lub MembersToInclude . Spowoduje to wygenerowanie błędu.
CzłonkowieToInclude	Użyj tej właściwości, aby dodać członków do istniejącego członkostwa w grupie. Wartość tej właściwości to tablica ciągów formularza Domain\UserName. Jeśli ta właściwość zostanie ustawiona w konfiguracji, nie należy używać właściwości Członkowie . Spowoduje to wygenerowanie błędu.
CzłonkowieToExclude	Użyj tej właściwości, aby usunąć członków z istniejącego członkostwa w grupach. Wartość tej właściwości to tablica ciągów formularza Domain\UserName. Jeśli ta właściwość zostanie ustawiona w konfiguracji, nie należy używać właściwości Członkowie . Spowoduje to wygenerowanie błędu.
Poświadczenie	Poświadczenia wymagane do uzyskiwania dostępu do zasobów zdalnych. To konto musi mieć odpowiednie uprawnienia usługi Active Directory, aby dodać wszystkie konta inne niż lokalne do grupy; w przeciwnym razie wystąpi błąd.

Wspólne właściwości

Właściwość	Opis
Dependson	Wskazuje, że konfiguracja innego zasobu musi zostać uruchomiona przed skonfigurowaniem tego zasobu. Jeśli na przykład identyfikator bloku skryptu konfiguracji zasobu, który chcesz uruchomić jako pierwszy, to ResourceName, a jego typ to ResourceType, składnia użycia tej właściwości to DependsOn = "[ResourceType]ResourceName".
Zapewnić	Wskazuje, czy grupy istnieją. Ustaw tę właściwość na Nieobecny , aby upewnić się, że grupy nie istnieją. Ustawienie go na Wartość Prezent gwarantuje, że grupy istnieją. Wartość domyślna to Obecny.
PsDscRunAsCredential	Ustawia poświadczenie na potrzeby uruchamiania całego zasobu jako.

Uwaga

Właściwość pospolita PsDscRunAsCredential została dodana w programie WMF 5.0, aby umożliwić uruchamianie dowolnego zasobu DSC w kontekście innych poświadczeń. Aby uzyskać więcej informacji, zobacz Use Credentials with DSC Resources (Używanie poświadczeń z zasobami DSC).

Przykład 1. Zapewnianie obecności grup

W poniższym przykładzie pokazano, jak upewnić się, że istnieją dwie grupy o nazwie "myGroup" i "myOtherGroup".

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ń zwykłego tekstu dla uproszczenia. Aby uzyskać informacje o sposobie szyfrowania poświadczeń w pliku MOF konfiguracji, zobacz Zabezpieczanie pliku MOF.