Set-LocalGroup

  • リファレンス
モジュール:
Microsoft.PowerShell.LocalAccounts

ローカル セキュリティ グループを変更します。

構文

Set-LocalGroup
   -Description <String>
   [-InputObject] <LocalGroup>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-LocalGroup
   -Description <String>
   [-Name] <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-LocalGroup
   -Description <String>
   [-SID] <SecurityIdentifier>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

このコマンドレットは Set-LocalGroup 、ローカル セキュリティ グループを変更します。

例

例 1: グループの説明を変更する

Set-LocalGroup -Name "SecurityGroup04" -Description "This is a sample description."

このコマンドは、ローカル グループの説明を変更します。

Note

Microsoft.PowerShell.LocalAccounts モジュールは、64 ビット システムの 32 ビット PowerShell では使用できません。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

グループのコメントを指定します。 最大長は 48 文字です。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

このコマンドレットが変更するセキュリティ グループを指定します。 セキュリティ グループを取得するには、Get-LocalGroup コマンドレットを使用します。

Type:Microsoft.PowerShell.Commands.LocalGroup
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

このコマンドレットが変更するセキュリティ グループの名前を指定します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SID

このコマンドレットが変更するセキュリティ グループのセキュリティ ID (SID) を指定します。

Type:SecurityIdentifier
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

System.Management.Automation.SecurityAccountsManager.LocalGroup

セキュリティ グループをこのコマンドレットにパイプできます。

String

このコマンドレットに文字列をパイプできます。

SecurityIdentifier

SID をこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。

メモ

Windows PowerShell には、次のエイリアスが Set-LocalGroup含まれています。

  • slg

PrincipalSource プロパティは、LocalUser、LocalGroup、および LocalPrincipal オブジェクトのプロパティで、オブジェクトのソースを記述します。 考えられるソースは次のとおりです。

  • ローカル
  • Active Directory
  • Microsoft Entra グループ
  • Microsoft アカウント

PrincipalSource は、Windows 10、Windows Server 2016、およびそれ以降のバージョンの Windows オペレーティング システムでのみサポートされています。 以前のバージョンの場合、プロパティは空白です。