Get-VETFile

Short Description

Returns files published in Microsoft Teams team channels.

Product: Veeam Backup for Microsoft 365

Product Edition: Community, Rental License, Subscription License

Syntax

This cmdlet provides the following parameter sets:

QueryByChannelParameterSet

Get-VETFile -Channel <VETChannel> [-Query <String>] [-Recurse] [<CommonParameters>]
QueryByFileParameterSet

Get-VETFile -Channel <VETChannel> -ParentFile <VETFile> [-Query <String>] [-Recurse] [<CommonParameters>]
QueryByOrganizationParameterSet

Get-VETFile [-Query <String>] -Organization <VETOrganization[]> [<CommonParameters>]
QueryByTeamParameterSet

Get-VETFile [-Query <String>] -Team <VETTeam> [<CommonParameters>]

Detailed Description

This cmdlet returns files published in Microsoft Teams team channels. You can get files from the following backed-up sources:

Microsoft Teams organization
Microsoft Teams team
Microsoft Teams channel

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Channel	Specifies a Microsoft Teams team channel. The cmdlet will return files from this channel. Accepts the `VETChannel` object. To get this object, run the `Get-VETChannel` cmdlet.	`VETChannel`	True	Named	True (ByValue)
Organization	Specifies an array of Microsoft Teams organizations. The cmdlet will return files from these organizations. Accepts the `VETOrganization[]` object. To get this object, run the `Get-VETOrganization` cmdlet.	`VETOrganization[]`	True	Named	True (ByValue)
ParentFile	Specifies a folder. The cmdlet will return files from this folder. Accepts the `VETFile` object. To get this object, run the `Get-VETFile` cmdlet.	`VETFile`	True	Named	True (ByValue)
Query	Specifies a query string for file search. The cmdlet will return files that match the search query from the specified organization, team, channel or folder. For more information, see the Appendix A. Item Search Parameters section of the Veeam Backup for Microsoft 365 User Guide.	`String`	False	Named	False
Recurse	Defines that the cmdlet will return the specified folder and all files in this folder. Default: False	`SwitchParameter`	False	Named	False
Team	Specifies a Microsoft Teams team. This cmdlet will return files from this team. Accepts the `VETTeam` object. To get this object, run the `Get-VETTeam` cmdlet.	`VETTeam`	True	Named	True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.

Output Object

The cmdlet returns the VETFile[] array that contains Microsoft Teams files.

Examples

Get-VETFile Example 1. Getting Files from Channel

This example shows how to get all files from the General channel.

$session = Get-VBOTeamsItemRestoreSession

$org = Get-VETOrganization -Session $session -Name "ABC*"

$team = Get-VETTeam -Organization $org -DisplayName "IT"

$channel = Get-VETChannel -Team $team -DisplayName "General"

Get-VETFile -Channel $channel

Perform the following steps:

Get the channel:
1. Run the Get-VBOTeamsItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VETOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $org variable.
3. Run the Get-VETTeam cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $team variable.
4. Run the Get-VETChannel cmdlet. Set the $team variable as the Team parameter value. Specify the DisplayName parameter value. Save the result to the $channel variable.
Run the Get-VETFile cmdlet. Set the $channel variable as the Channel parameter value.

Get-VETFile Example 2. Getting Files from Organization

This example shows how to get the report.txt file from the ABC organization.

$session = Get-VBOTeamsItemRestoreSession

$org = Get-VETOrganization -Session $session -Name "ABC*"

Get-VETFile -Organization $org -Query "filename: report"

Perform the following steps:

Get the organization:
1. Run the Get-VBOTeamsItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VETOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $org variable.
Run the Get-VETFile cmdlet. Set the $org variable as the Organization parameter value. Specify the Query parameter value.

Get-VETFile Example 3. Getting Files from Team

This example shows how to get files from the IT team.

$session = Get-VBOTeamsItemRestoreSession

$org = Get-VETOrganization -Session $session -Name "ABC*"

$team = Get-VETTeam -Organization $org -DisplayName "IT"

Get-VETFile -Team $team

Perform the following steps:

Get the team:
1. Run the Get-VBOTeamsItemRestoreSession cmdlet. Save the result to the $session variable.
2. Run the Get-VETOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $org variable.
3. Run the Get-VETTeam cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $team variable.
Run the Get-VETFile cmdlet. Set the $team variable as the Team parameter value.