Version 4

    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

     

    Prerequisites:

     

    4 Monitors (Site Name & Count, Site Status, Storage Used by Site, Storage Allocated to Site) use Powershell SharePoint Online Module.

     

    • Install PowerShell SharePoint Module, to install execute below command on your powershell console
      • “Install-Module -Name Microsoft.Online.SharePoint.PowerShell”
      • Check installation by typing command “Get-Module -ListAvailable -Name "*SharePoint*"
    • All 4 Monitors require Organization Name as Argument to run and get result

    orgName=<Value>

     

    2 Monitors (Number of Page View, Number of files on Site) use Microsoft Graph API to fetch Data and require psmsgraph to be configured. Use below steps to configure the same.

     

     

    • The details collected as part of above steps should be passed as Arguments to Monitors in below format/precedence

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

     

    Credentials:

    • The user should have SAM Administrator permissions

     

     

    MONITORED COMPONENTS

     

    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. The Monitor returns the Storage of all the sites, in case a User want the Storage of a particular site than “site name” can be passed as 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

     

     

    Troubleshooting steps

     

    Detail troubleshooting steps (common for template)

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

     

    Portions of this document were originally created by and are excerpted from the following sources:

    https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps

    https://docs.microsoft.com/en-us/graph/overview?toc=./toc.json&view=graph-rest-1.0

    https://docs.microsoft.com/en-us/graph/api/resources/report?view=graph-rest-1.0

     

    Last updated: <Date updated>