Show-DBXUserDrives

SYNOPSIS

Use the Show-DBXUserDrives cmdlet to list the contents of multiple Dropbox user drives.

SYNTAX

Help

Show-DBXUserDrives
  [-ShowPrereqs]
  [<CommonParameters>]

Action

Show-DBXUserDrives
  -Csv <String>
  [-SourceFolder <String>]
  [-IncludePattern <String>]
  [-ExcludePattern <String>]
  [-MaxAge <String>]
  [-MinAge <String>]
  [-NoCache]
  [-Verbosity <String>]
  [<CommonParameters>]

DESCRIPTION

Use this cmdlet to list the contents of a list of user drives.

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: List contents

Description

This example lists the contents of user drives.

Provider configuration

Provider	Direction	APIs	Scopes
Dropbox	Source	N/A	account_info.read files.content.read files.content.write files.metadata.read sharing.read members.read team_info.read team_data.member team_data.governance.read team_data.governance.write

CSV format

SourceId

TMCTools

@{
  Source = @{
    DBXAdmin            = 'dbmid:<ADMIN_ID>'
    DBXClientId         = '<CLIENT_ID>'
    DBXClientSecret     = '<CLIENT_SECRET>'
  }
  Target = @{}
}

Show-DBXUserDrives -Csv 'user_drives.csv'

PARAMETERS

-Csv

The path to a CSV file containing drives to process. See the examples for the required CSV format.

Type: String
Parameter Sets: Action
Aliases:

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

-ExcludePattern

A matching pattern to determine which folders and files to exclude. Syntax details can be found here.

Type: String
Parameter Sets: Action
Aliases:

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

-IncludePattern

A matching pattern to determine which folders and files to include. Syntax details can be found here.

Type: String
Parameter Sets: Action
Aliases:

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

-MaxAge

The maximum age (modified time) of files to include. Syntax details can be found here.

Type: String
Parameter Sets: Action
Aliases:

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

-MinAge

The minimum age (modified time) of files to include. Syntax details can be found here.

Type: String
Parameter Sets: Action
Aliases:

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

-NoCache

Refresh tokens obtained from a prior authentication will be used by default. If you are running different tools that require different permissions or want to log in as a different user, use the -NoCache option to bypass an existing refresh token.

Type: SwitchParameter
Parameter Sets: Action
Aliases:

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

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

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

-SourceFolder

Restrict the source-side listing to the specified folder.

Note that this parameter is a global option that applies to all drives listed in the CSV file.

This parameter has no effect if the SourceFolder CSV field is set.

Type: String
Parameter Sets: Action
Aliases:

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

-Verbosity

The amount of detail logged during processing.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: None, Normal, Detailed, Diagnostic

Required: False
Position: Named
Default value: Detailed
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Void

NOTES

Required config.psd1 keys

These configuration keys are scoped to the Source node in config.psd1.

DBXAdmin: The ID of your tenant’s administrator. This must be in dbmid:Q7mX2vK9cR4nT8zLp5aW3yF6uJ1sHdB0eNg format.
DBXClientId: The client ID of your tenant’s app.
DBXClientSecret: The client secret of your tenant’s app.

Required APIs

See the Examples section for details.

Required scopes