Get-AzureADMSDeletedGroup
This cmdlet is used to retrieve the soft deleted groups in a directory.
Syntax
Get-AzureADMSDeletedGroup
[-All <Boolean>]
[-Top <Int32>]
[-Filter <String>]
[<CommonParameters>]
Get-AzureADMSDeletedGroup
[-SearchString <String>]
[-All <Boolean>]
[<CommonParameters>]
Get-AzureADMSDeletedGroup
-Id <String>
[-All <Boolean>]
[<CommonParameters>]
Description
This cmdlet is used to retrieve the soft deleted groups in a directory. When a group is deleted it is initially soft deleted and can be recovered during the first 30 days after deletion. After 30 days the group is permanently deleted and can no longer be recovered. Note that soft delete is currently only implemented for Unified Groups (a.k.a. Office 365 Groups).
Examples
Example 1
Get-AzureAdMSDeletedGroup
This cmdlet will retrieve all recoverable deleted groups in the directory.
Parameters
-All
If true, return all group members. If false, return the number of objects specified by the Top parameter
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Filter
Specifies an oData v3.0 filter statement. This parameter controls which objects are returned.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
The Id of the deleted group to be retrieved
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SearchString
Specifies a search string.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Top
Specifies the maximum number of records to return.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Outputs
Notes
See the migration guide for Get-AzureADMSDeletedGroup to the Microsoft Graph PowerShell.