-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from MicrosoftDocs/vsts/Release-45
Updates for release 1.0.830
- Loading branch information
Showing
2 changed files
with
135 additions
and
0 deletions.
There are no files selected for viewing
132 changes: 132 additions & 0 deletions
132
powerbi-ps/MicrosoftPowerBIMgmt.Admin/Get-PowerBIActivityEvent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
--- | ||
external help file: Microsoft.PowerBI.Commands.Admin.dll-Help.xml | ||
Module Name: MicrosoftPowerBIMgmt.Admin | ||
online version: https://docs.microsoft.com/en-us/powershell/module/microsoftpowerbimgmt.admin/get-powerbiactivityevent?view=powerbi-ps | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-PowerBIActivityEvent | ||
|
||
## SYNOPSIS | ||
Retrieves the audit activity events for a Power BI tenant. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-PowerBIActivityEvent -StartDateTime <String> -EndDateTime <String> [-ActivityType <String>] | ||
[-User <String>] [-ResultType <OutputType>] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
Retrieves the audit activity events for the calling user's tenant. | ||
Before you run this command, make sure you log in using Connect-PowerBIServiceAccount. | ||
This cmdlet requires the calling user to be a tenant administrator of the Power BI service. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
```powershell | ||
PS C:\> Get-PowerBIActivityEvent -StartDateTime 2019-08-10T14:35:20 -EndDateTime 2019-08-10T18:25:50 | ||
``` | ||
|
||
Retrieves Power BI activity events between 08-10-19 14:35:20 UTC and 08-10-2019 18:25:50 UTC | ||
|
||
### Example 2 | ||
```powershell | ||
PS C:\> Get-PowerBIActivityEvent -StartDateTime 2019-08-10T14:35:20 -EndDateTime 2019-08-10T18:25:50 -ActivityType viewreport -User [email protected] -ResultType JsonObject | ||
``` | ||
|
||
Retrieves Power BI activity events between 08-10-19 14:35:20 UTC and 08-10-2019 18:25:50 UTC with the activity type of viewreport for user [email protected]. Output will be JSON objects. | ||
|
||
## PARAMETERS | ||
|
||
### -ActivityType | ||
Filters the activity records based on this activity type. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -EndDateTime | ||
Specifies the end of a timespan to retrieve audit activity events. It should be in UTC format and ISO 8601 compliant. Both StartDateTime and EndDateTime should be within the same UTC day. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -ResultType | ||
Specifies the type of result that is returned by the cmdlet. | ||
```yaml | ||
Type: OutputType | ||
Parameter Sets: (All) | ||
Aliases: | ||
Accepted values: JsonString, JsonObject | ||
|
||
Required: False | ||
Position: Named | ||
Default value: JsonString | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -StartDateTime | ||
Specifies the start of a timespan to retrieve audit activity events. It should be in UTC format and ISO 8601 compliant. Both StartDateTime and EndDateTime should be within the same UTC day. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -User | ||
Filters the activity records based on this user email. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
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 (http://go.microsoft.com/fwlink/?LinkID=113216). | ||
## INPUTS | ||
### None | ||
## OUTPUTS | ||
### System.Collections.Generic.IList`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] | ||
|
||
## NOTES | ||
|
||
## RELATED LINKS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters