|
| 1 | +--- |
| 2 | +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml |
| 3 | +Locale: en-US |
| 4 | +Module Name: MicrosoftTeams |
| 5 | +title: Get-TeamsArtifacts |
| 6 | +author: lutingzhao |
| 7 | +ms.author: lutingzhao |
| 8 | +ms.date: 10/20/2025 |
| 9 | +manager: bashe |
| 10 | +online version: |
| 11 | +schema: 2.0.0 |
| 12 | +--- |
| 13 | + |
| 14 | +# Get-TeamsArtifacts |
| 15 | + |
| 16 | +## SYNOPSIS |
| 17 | +The `Get-TeamsArtifacts` is available only to tenant administrators and is designed to export Recordings, Transcripts, Notes and Whiteboard artifacts of Teams Meetings. |
| 18 | + |
| 19 | +## SYNTAX |
| 20 | +``` |
| 21 | +Get-TeamsArtifacts [-OneDrive <String>] [-SharePoint] [-ArtifactType <String>] [-StartTime <String>] [-EndTime <String>] |
| 22 | +``` |
| 23 | + |
| 24 | +## DESCRIPTION |
| 25 | +This cmdlet exports Recordings, Transcripts, Notes and Whiteboard artifacts of Teams Meetings. |
| 26 | + |
| 27 | +## EXAMPLES |
| 28 | + |
| 29 | +### Example 1 |
| 30 | +```powershell |
| 31 | +PS C:\> Get-TeamsArtifacts -OneDrive [email protected] -StartTime "2025-06-20" -EndTime "2025-06-26" |
| 32 | +``` |
| 33 | + |
| 34 | +## PARAMETERS |
| 35 | +All parameters are optional. If no parameters are specified, artifact metadata is returned for Teams artifacts in all standard OneDrive for Business and SharePoint locations. The actual artifacts themselves can then be downloaded from the URLs in the metadata returned. Output is written to artifacts.json in the current directory. |
| 36 | + |
| 37 | +### -OneDrive |
| 38 | +Returns only artifacts that are hosted in the standard locations of that user's OneDrive for Business. |
| 39 | + |
| 40 | +```yaml |
| 41 | +Type: String |
| 42 | +Parameter Sets: (All) |
| 43 | +Aliases: |
| 44 | + |
| 45 | +Required: False |
| 46 | +Position: Named |
| 47 | +Default value: None |
| 48 | +Accept pipeline input: False |
| 49 | +Accept wildcard characters: False |
| 50 | +``` |
| 51 | +
|
| 52 | +### -SharePoint |
| 53 | +Returns only the artifacts that are hosted in SharePoint sites (typically from channel meetings). |
| 54 | +
|
| 55 | +```yaml |
| 56 | +Type: String |
| 57 | +Parameter Sets: (All) |
| 58 | +Aliases: |
| 59 | + |
| 60 | +Required: False |
| 61 | +Position: Named |
| 62 | +Default value: None |
| 63 | +Accept pipeline input: False |
| 64 | +Accept wildcard characters: False |
| 65 | +``` |
| 66 | +
|
| 67 | +### -ArtifactType |
| 68 | +Filters the results to a single artifact type. It's s Enum containing only three values: RecordingTranscript | Notes | Whiteboard. |
| 69 | +
|
| 70 | +```yaml |
| 71 | +Type: String |
| 72 | +Parameter Sets: (All) |
| 73 | +Aliases: |
| 74 | + |
| 75 | +Required: False |
| 76 | +Position: Named |
| 77 | +Default value: RecordingTranscript | Notes | Whiteboard |
| 78 | +Accept pipeline input: False |
| 79 | +Accept wildcard characters: False |
| 80 | +``` |
| 81 | +
|
| 82 | +### -StartTime |
| 83 | +Omits artifacts that are last modified prior to this date and time. |
| 84 | +
|
| 85 | +```yaml |
| 86 | +Type: String |
| 87 | +Parameter Sets: (All) |
| 88 | +Aliases: |
| 89 | + |
| 90 | +Required: False |
| 91 | +Position: Named |
| 92 | +Default value: None |
| 93 | +Accept pipeline input: False |
| 94 | +Accept wildcard characters: False |
| 95 | +``` |
| 96 | +
|
| 97 | +### -EndTime |
| 98 | +Omits artifacts that are last modified after this date and time. |
| 99 | +
|
| 100 | +```yaml |
| 101 | +Type: String |
| 102 | +Parameter Sets: (All) |
| 103 | +Aliases: |
| 104 | + |
| 105 | +Required: False |
| 106 | +Position: Named |
| 107 | +Default value: None |
| 108 | +Accept pipeline input: False |
| 109 | +Accept wildcard characters: False |
| 110 | +``` |
| 111 | +
|
| 112 | +### CommonParameters |
| 113 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). |
| 114 | +
|
| 115 | +## INPUTS |
| 116 | +
|
| 117 | +## OUTPUTS |
| 118 | +
|
| 119 | +## NOTES |
| 120 | +
|
| 121 | +## RELATED LINKS |
0 commit comments