グループ

構文

ローカル グループを管理します。

構文

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

説明

この Group リソースを使用すると、ローカル グループを管理できます。 グループを作成、更新、削除できます。 このリソースを使用して、グループ メンバーシップを強制し、グループの説明を設定できます。

要件

[なし] :

キーのプロパティ

GroupName

グループの名前を指定します。

Type: System.String

省略可能なプロパティ

資格情報

必要に応じて、ローカル以外のグループ メンバーを解決するアクセス許可を持つアカウントの資格情報を指定します。

Type: System.Management.Automation.PSCredential
Default Value: None

説明

グループの説明を指定します。

Type: System.String
Default Value: None

Ensure

グループを存在させるかどうかを指定します。 グループを追加または更新するには、このプロパティを Present. グループを削除するには、このプロパティを Absent. 既定値は Present です。

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

メンバー

グループのメンバーの完全なリストを文字列の配列として指定します。 このプロパティを指定すると、リソースによってグループのメンバー リストがこの値に設定されます。 各メンバーを次のいずれかとして書式設定します。

• ドメイン修飾名: <domain>\<username>
• Upn： <username>@<domain>
• 識別名: CN=<username>,DC=...
• ユーザー名: <username>

MembersToExclude プロパティまたは MembersToInclude プロパティでは、このプロパティを使用しないでください。 その場合、リソースは例外をスローします。

Type: System.String[]
Default Value: None

MembersToExclude

グループから除外する 1 つ以上のメンバーを文字列の配列として指定します。 このプロパティを指定すると、リソースにメンバーが含まれている場合、グループからこれらのメンバーが削除されます。 各メンバーを次のいずれかとして書式設定します。

• ドメイン修飾名: <domain>\<username>
• Upn： <username>@<domain>
• 識別名: CN=<username>,DC=...
• ユーザー名: <username>

Members プロパティでは、このプロパティを使用しないでください。 その場合、リソースは例外をスローします。

Type: System.String[]
Default Value: None

MembersToInclude

文字列の配列としてグループに含める 1 つ以上のメンバーを指定します。 このプロパティを指定すると、リソースにメンバーが含まれていない場合は、グループからこれらのメンバーが追加されます。 各メンバーを次のいずれかとして書式設定します。

• ドメイン修飾名: <domain>\<username>
• Upn： <username>@<domain>
• 識別名: CN=<username>,DC=...
• ユーザー名: <username>

Members プロパティでは、このプロパティを使用しないでください。 その場合、リソースは例外をスローします。

Type: System.String[]
Default Value: None

例

• グループのメンバーを設定する
• グループのメンバーを削除する