Documentation forServer & Application Monitor

Microsoft Office 365 SharePoint Online

This template shows information about Office 365 SharePoint Online and includes the following component monitors:

  • Site Name & Count
  • Site Status
  • Storage Used by Site
  • Storage Allocated to Site
  • Number of Page View
  • Number of files on Site

Portions of this topic are based on What is the SharePoint Online Management Shell?, Overview of Microsoft Graph, and Working with Office 365 usage reports in Microsoft Graph (© 2019 Microsoft Corp., available at https://docs.microsoft.com, obtained on May 8, 2019).

Prerequisites

  • The following component monitors use the PowerShell SharePoint Online Module:
    • Site Name & Count
    • Site Status
    • Storage Used by Site
    • Storage Allocated to Site

    To install the PowerShell SharePoint Online Module, execute Install-Module -Name Microsoft.Online.SharePoint.PowerShell in your PowerShell console. To verify installation, run Get-Module -ListAvailable -Name "*SharePoint*.

    These four monitors require an Organization Name in script arguments. Use orgName=<Value> to get this result: orgName=<Value>.

Credentials

    User belongs to the SAM Administrator group

    Use UPN format (username@domain) and not domain\username format to enter credentials. Also, SolarWinds recommends using a service account for Exchange Web Services to avoid authentication issues when passwords are updated.

User has privileges to pass credentials as arguments to monitors, as described next in the Component monitors section.

Component monitors

Site Name & Count

Get the count of the sites and return all site names in message.

Arguments: Organization Name

Format: OrgName=<value>

Statistic Unit: Number

Site Status

Get the status of a particular site.

Argument: Organization Name, Site URL

Format: orgName=<value>, siteName=<value>

Output: 0 – In-active, 1 – Active

Statistic Unit: Boolean (0 or 1)

Storage Used by Site

Get the storage of the site used, in gigabytes. The monitor returns the storage of all the sites. To get the storage of a specific site, pass the site name in the argument.

Argument: Organization Name, Site URL (Optional)

Format: orgName=<value>, siteName=<value>

Statistic Unit: GB

Storage Allocated to Site

Get the storage allocated to a particular site.

Argument: Organization Name, Site URL

Format: orgName=<value>, siteName=<value>

Statistic Unit: GB

Number of Page View

Get the number of pages viewed across all sites.

Argument: Client ID, Tenant ID, Client Password

Format: client_id=<Value>, TenantID=<Value>, client_secret=<Value>

Statistic Unit: Number

Number of files on Site

Get the total number of files across all sites.

Argument: Client ID, Tenant ID, Client Password

Format: client_id=<Value>, TenantID=<Value>, client_secret=<Value>

Statistic Unit: Number