diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md new file mode 100644 index 000000000..8010f5931 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-SPOM365AgentAccessInsightsReport +applicable: SharePoint Online +title: Get-SPOM365AgentAccessInsightsReport +schema: 2.0.0 +author: starringGTM +ms.author: gchaudhary +ms.reviewer: +--- + +# Get-SPOM365AgentAccessInsightsReport + +## SYNOPSIS + +This cmdlet enables the administrator to check status of all active and available analytics reports when no report ID is present and to view or download a report if report ID is present. + +> [!NOTE] +> The feature associated with this cmdlet will be rolling out soon. + +## SYNTAX + +``` +Get-SPOM365AgentAccessInsightsReport [-ReportId ] [-Action ] + [-Content ] [] +``` + +## DESCRIPTION + +If this cmdlet is executed without any parameters, it displays the status of all active and completed reports. +> [!NOTE] +> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-SPOM365AgentAccessInsightsReport +``` + +Example 1 enables administrator to view the status of all active and completed analytics reports. + +### EXAMPLE 2 + +```powershell +Get-SPOM365AgentAccessInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b +``` + +Example 2 enables administrator to view the Microsoft 365 agent insight report of the given report ID. + +### EXAMPLE 3 + +```powershell +Get-SPOM365AgentAccessInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download +``` + +Example 3 enables administrator to download the Microsoft 365 agent insight report of the given report ID to the same path from where the command was run. + +## PARAMETERS + +### -Action + +> Applicable: SharePoint Online + +It determines whether a report would be viewed or downloaded. If the value of `-Action` is set as `View`, it will display the output on the PowerShell screen. Else if the value of `-Action` is set as `Download`, it will download the full report in CSV format to the same path from where the command was run. + +```yaml +Type: ActionType +Parameter Sets: (All) +Aliases: +Accepted values: View, Download + +Required: False +Position: Named +Default value: View +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Content + +> Applicable: SharePoint Online + +It specifies the kind of report to view or download. + +If this cmdlet is executed with `-Content` as `M365AgentsOnSites`, a report with list of all sites on which a agent is created along with the names of the agent created in the specified number of days will be displayed. + +If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Microsoft 365 agents distribution across sites in the specified number of days will be displayed. + +```yaml +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType +Parameter Sets: (All) +Aliases: +Accepted values: M365AgentsOnSites, SiteDistribution + +Required: False +Position: Named +Default value: M365AgentsOnSites +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportId + +> Applicable: SharePoint Online + +It specifies the unique ID of the report to be viewed or downloaded. + +```yaml +Type: System.Guid +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index 7bd120a40..eaf85bd41 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -240,6 +240,9 @@ Gets the status for a file version expiration report generation job for a docume ### [Get-SPOListVersionPolicy](Get-SPOListVersionPolicy.md) Gets the version policy setting on the document library. +### [Get-SPOM365AgentAccessInsightsReport](Get-SPOM365AgentAccessInsightsReport.md) +This cmdlet enables the administrator to check status of all active and available Microsoft 365 Agent Insights reports when no report ID is present and to view or download a report if report ID is present. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon. + ### [Get-SPOMalwareFile](Get-SPOMalwareFile.md) Extracts and displays the malware-related information of an infected file stored in SharePoint. @@ -804,6 +807,9 @@ This cmdlet enables administrator to trigger the build of a new enterprise appli ### [Start-SPOInformationBarriersInsightsReport](Start-SPOInformationBarriersInsightsReport.md) Generates a new report to identify and discover the usage patterns of Information Barriers (IB) across SharePoint sites and OneDrive accounts in the organization. +### [Start-SPOM365AgentAccessInsightsReport](Start-SPOM365AgentAccessInsightsReport.md) +Using this cmdlet, administrators may trigger the build of a new Microsoft 365 agent insight report for the specified number of days. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon. + ### [Start-SPORestrictedAccessForSitesInsights](Start-SPORestrictedAccessForSitesInsights.md) This cmdlet enables administrator to trigger the build of a new restricted access control insights report for the data from last 28 days. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md new file mode 100644 index 000000000..ad6ad8249 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spom365agentaccessinsightsreport +applicable: SharePoint Online +title: Start-SPOM365AgentAccessInsightsReport +schema: 2.0.0 +author: starringGTM +ms.author: gchaudhary +ms.reviewer: +--- + + # Start-SPOM365AgentAccessInsightsReport + +## SYNOPSIS + +Using this cmdlet, administrators may trigger the build of a new Microsoft 365 agent insight report for the specified number of days. + +> [!NOTE] +> The feature associated with this cmdlet will be rolling out soon. + +## SYNTAX + +``` +Start-SPOM365AgentAccessInsightsReport [-Force] [-ReportPeriodInDays ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +After executing this cmdlet, the Microsoft 365 agent insight report generation request for the specified number of days is added to the pipeline queue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Start-SPOM365AgentAccessInsightsReport +``` + +Example 1 generates the Microsoft 365 agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided. + +### EXAMPLE 2 + +```powershell +Start-SPOM365AgentAccessInsightsReport –ReportPeriodInDays 14 +``` + +Example 2 generates the Copilot agent insight report for a specified duration of 14 days. + +## PARAMETERS + +### -Force + +> Applicable: SharePoint Online + +It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPeriodInDays + +> Applicable: SharePoint Online + +It specifies the duration of the M365 agent insight report in days. The possible values of ReportPeriodInDays are: 1, 7, 14, 28. If this parameter is not provided, it generates the report for a default duration of 1 day. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + + +[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport.md) +