Edit

Share via

Set-MsolGroup

  • Reference
Module:
MSOnline

Updates a security group.

Syntax

Set-MsolGroup
   [-ObjectId <Guid>]
   [-DisplayName <String>]
   [-Description <String>]
   [-ManagedBy <String>]
   [-TenantId <Guid>]
   [<CommonParameters>]

Description

The Set-MsolGroup cmdlet updates the properties of a security group.

Examples

Example 1: Modify a group

PS C:\> $GroupId = Get-MsolGroup -SearchString "MyGroup"
PS C:\> Set-MsolGroup -ObjectId $GroupId -Description "My Group"

The first command gets the security group that matches the string MyGroup, and then stores it in the $GroupId variable. The second command modifies the group in $GroupId.

Parameters

-Description

Specifies a description of the group.

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

-DisplayName

Specifies a display name of the group.

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

-ManagedBy

Specifies the owner of the group.

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

-ObjectId

Specifies the unique object ID of the group to update.

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

-TenantId

Specifies the unique ID of the tenant on which to perform the operation. The default value is the tenant of the current user. This parameter applies only to partner users.

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