.png)
Get-SPOTenantLogEntry
Published: July 16, 2012
Applies to: Office 365 | SharePoint Online
Retrieves SharePoint Online company logs.
Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>]
Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>] -CorrelationId <Guid>
Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>] -Source <Int32>
Get-SPOTenantLogEntry [[-StartTimeInUtc] <DateTime>] [[-EndTimeInUtc] <DateTime>] [[-MaxRows] <UInt32>] -User <String>
Parameters
1| Parameter | Required | Type | Description |
| StartTimeInUtc | Optional | System.DateTime | Specifies the start time in Coordinated Universal Time (UTC) to search for the logs — for example, 01032011:12:00. |
| EndTimeInUtc | Optional | System.DateTime | Specifies the end time in UTC to search for logs. |
| MaxRows | Optional | System.UInt32 | Specifies the maximum number of rows in the descending order of timestamp. The value must be less than 5000. The default value is 1000. |
| Parameter | Required | Type | Description |
| StartTimeInUtc | Optional | System.DateTime | Specifies the start time in Coordinated Universal Time (UTC) to search for the logs — for example, 01032011:12:00. |
| EndTimeInUtc | Optional | System.DateTime | Specifies the end time in UTC to search for logs. |
| MaxRows | Optional | System.UInt32 | Specifies the maximum number of rows in the descending order of timestamp. The value must be less than 5000. The default value is 1000. |
| CorrelationId | Optional | System.Guid | Specifies the Correlation ID as a filter. |
| Parameter | Required | Type | Description |
| StartTimeInUtc | Optional | System.DateTime | Specifies the start time in Coordinated Universal Time (UTC) to search for the logs — for example, 01032011:12:00. |
| EndTimeInUtc | Optional | System.DateTime | Specifies the end time in UTC to search for logs. |
| MaxRows | Optional | System.UInt32 | Specifies the maximum number of rows in the descending order of timestamp. The value must be less than 5000. The default value is 1000. |
| Source | Optional | System.Int32 | Specifies the component that logs the errors. |
| Parameter | Required | Type | Description |
| StartTimeInUtc | Optional | System.DateTime | Specifies the start time in Coordinated Universal Time (UTC) to search for the logs — for example, 01032011:12:00. |
| EndTimeInUtc | Optional | System.DateTime | Specifies the end time in UTC to search for logs. |
| MaxRows | Optional | System.UInt32 | Specifies the maximum number of rows in the descending order of timestamp. The value must be less than 5000. The default value is 1000. |
| User | Optional | System.String | Specifies the log-on identity as a filter. |
Detailed Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.
The Get-SPOTenantLogEntry cmdlet cannot retrieve all SharePoint Online errors. This cmdlet retrieves a subset of errors that happen due to external systems.
For Beta 2, the only company logs available are for Business Connectivity Services (BCS).
 Note: |
|---|
| If you do not use any parameter, the first 1000 rows in descending time range are returned. |
You must be a SharePoint Online global administrator to run the cmdlet.
Input Types
Return Types
--------EXAMPLE--------
$endtime = Get-SPOTenantLogLastAvailableTimeInUtc$starttime = $endTimeinUTC.AddMinutes(-1200000)$tenantlogs = Get-SPOTenantLogEntry -StartTimeinUtc $startTimeinUTC.Date -EndTimeinUTC $endTimeinUTC.Date
This example retrieves logs from a time span that SharePoint Online company logs are available.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
