Remove-MgGroupFavorite
Remove the group from the list of the current user's favorite groups. Supported for Microsoft 365 groups only.
Note
To view the beta release of this cmdlet, view Remove-MgBetaGroupFavorite
Syntax
Remove (Default)
Remove-MgGroupFavorite
-GroupId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RemoveViaIdentity
Remove-MgGroupFavorite
-InputObject <IGroupsIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Remove the group from the list of the current user's favorite groups. Supported for Microsoft 365 groups only.
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Groups
Remove-MgGroupFavorite -GroupId $groupId
This example shows how to use the Remove-MgGroupFavorite Cmdlet.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-GroupId
The unique identifier of group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Remove
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | IDictionary |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IGroupsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RemoveViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns true when the command succeeds
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.PowerShell.Models.IGroupsIdentity
System.Collections.IDictionary
Outputs
System.Boolean
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IGroupsIdentity>: Identity Parameter
[AttachmentId <String>]: The unique identifier of attachment[ConversationId <String>]: The unique identifier of conversation[ConversationThreadId <String>]: The unique identifier of conversationThread[DirectoryObjectId <String>]: The unique identifier of directoryObject[EndDateTime <String>]: Usage: endDateTime='{endDateTime}'[ExtensionId <String>]: The unique identifier of extension[GroupId <String>]: The unique identifier of group[GroupLifecyclePolicyId <String>]: The unique identifier of groupLifecyclePolicy[GroupSettingId <String>]: The unique identifier of groupSetting[GroupSettingTemplateId <String>]: The unique identifier of groupSettingTemplate[Interval <String>]: Usage: interval='{interval}'[ListId <String>]: Usage: listId='{listId}'[Path <String>]: Usage: path='{path}'[PostId <String>]: The unique identifier of post[ProfilePhotoId <String>]: The unique identifier of profilePhoto[ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant[SiteId <String>]: The unique identifier of site[StartDateTime <String>]: Usage: startDateTime='{startDateTime}'[UniqueName <String>]: Alternate key of group