Get-PBIDataSet

NAME Get-PBIDataSet



SYNOPSIS

Gets all the PowerBI existing datasets and returns as an array of custom objects.

Or

Check if a dataset exists with the specified name and if exists returns it's metadata





SYNTAX

Get-PBIDataSet [[-authToken] <String>] [[-name] <String>] [[-id] <String>] [-includeDefinition] [-includeTables]

[[-groupId] <String>] [-admin] [<CommonParameters>]





DESCRIPTION

Gets all the PowerBI existing datasets and returns as an array of custom objects.

Or

Check if a dataset exists with the specified name and if exists returns it's metadata





PARAMETERS

-authToken <String>

The authorization token required to communicate with the PowerBI APIs

Use 'Get-PBIAuthToken' to get the authorization token string



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-name <String>

The dataset name



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-id <String>

The dataset id



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-includeDefinition [<SwitchParameter>]

If specified will include the dataset definition properties



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-includeTables [<SwitchParameter>]

If specified will include the dataset tables



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-groupId <String>

Id of the workspace where the reports will get pulled



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-admin [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-PBIDataSet -authToken $authToken



Get-PBIDataSet -authToken $authToken -name "DataSetName"

Get-PBIDataSet -authToken $authToken -name "DataSetName" -includeDefinition -includeTables











RELATED LINKS