Get-MgBetaReportSharePointApiUsage

Module:: Microsoft.Graph.Beta.Reports Module

Get aggregated usage data for all applications in a tenant. Specify either a period or a date, but not both. Optionally filter the results by application ID. Data is returned in CSV format by default, or in JSON format when requested through the $format query parameter. Use the optional reportType parameter to choose which usage metrics to return: egressReport (default) includes usage (UsageMB in CSV, usageMB in JSON), and throttlingReport includes throttled request counts (ThrottledRequests in CSV, throttledRequests in JSON). Each report type must be enabled (onboarded) for the tenant before its data is available. Use enableApiUsageReport to enable a report metric, disableApiUsageReport to disable it, and List apiUsageReportMetrics to check the enablement status. If you request a report type that isn't enabled for the tenant, this method returns a 403 Forbidden response with the error code accessDenied and the message 'Tenant is not enabled for this report type.' CSV column headers use PascalCase (ThrottledRequests) while JSON properties use camelCase (throttledRequests) to maintain consistency with other Microsoft Graph reporting APIs.

Syntax

Get1 (Default)

Get-MgBetaReportSharePointApiUsage
    -Date <datetime>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Get2

Get-MgBetaReportSharePointApiUsage
    -AppId <string>
    -Period <string>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Get

Get-MgBetaReportSharePointApiUsage
    -AppId <string>
    -Date <datetime>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Get3

Get-MgBetaReportSharePointApiUsage
    -Period <string>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity3

Get-MgBetaReportSharePointApiUsage
    -InputObject <IReportsIdentity>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity2

Get-MgBetaReportSharePointApiUsage
    -InputObject <IReportsIdentity>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity1

Get-MgBetaReportSharePointApiUsage
    -InputObject <IReportsIdentity>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaReportSharePointApiUsage
    -InputObject <IReportsIdentity>
    -OutFile <string>
    [-ReportType <string>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-PassThru]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Parameters

-AppId

Usage: appId='{appId}'

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

Get2

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Date

Usage: date={date}

Parameter properties

Type:	System.DateTime
Supports wildcards:	False
DontShow:	False

Parameter sets

Get1

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.IReportsIdentity
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity3

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentity2

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentity1

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OutFile

Path to write output file to

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Period

Usage: period='{period}'

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

Get3

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get2

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ReportType

Usage: reportType='@reportType'

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IReportsIdentity

System.Collections.IDictionary

Outputs

System.Boolean

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IReportsIdentity>: Identity Parameter [ActiveUsersMetricId <String>]: The unique identifier of activeUsersMetric [AggregationWindow <String>]: Usage: aggregationWindow='{aggregationWindow}' [AlertConfigurationId <String>]: The unique identifier of alertConfiguration [AlertId <String>]: The unique identifier of alert [ApiUsageReportEnablementStatusMetric <String>]: The unique identifier of apiUsageReportEnablementStatus [AppCredentialSignInActivityId <String>]: The unique identifier of appCredentialSignInActivity [AppId <String>]: Usage: appId='{appId}' [ApplicationSignInDetailedSummaryId <String>]: The unique identifier of applicationSignInDetailedSummary [AuditActivityTypeId <String>]: The unique identifier of auditActivityType [AuthenticationsMetricId <String>]: The unique identifier of authenticationsMetric [CorrelatedIdentityId <String>]: The unique identifier of correlatedIdentity [CredentialUserRegistrationDetailsId <String>]: The unique identifier of credentialUserRegistrationDetails [CustomSecurityAttributeAuditId <String>]: The unique identifier of customSecurityAttributeAudit [DailyInactiveUsersByApplicationMetricId <String>]: The unique identifier of dailyInactiveUsersByApplicationMetric [DailyInactiveUsersMetricId <String>]: The unique identifier of dailyInactiveUsersMetric [Date <DateTime?>]: Usage: date={date} [DeviceManagementCachedReportConfigurationId <String>]: The unique identifier of deviceManagementCachedReportConfiguration [DeviceManagementExportJobId <String>]: The unique identifier of deviceManagementExportJob [DirectoryAuditId <String>]: The unique identifier of directoryAudit [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime} [ExclusiveIntervalEndDateTime <DateTime?>]: Usage: exclusiveIntervalEndDateTime={exclusiveIntervalEndDateTime} [Filter <String>]: Usage: filter='{filter}' [GroupAnalyticsId <String>]: The unique identifier of groupAnalytics [GroupId <String>]: Usage: groupId='{groupId}' [IdentityCorrelationId <String>]: The unique identifier of identityCorrelation [IncludedUserRoles <String>]: Usage: includedUserRoles='{includedUserRoles}' [IncludedUserTypes <String>]: Usage: includedUserTypes='{includedUserTypes}' [InclusiveIntervalStartDateTime <DateTime?>]: Usage: inclusiveIntervalStartDateTime={inclusiveIntervalStartDateTime} [InsightSummaryId <String>]: The unique identifier of insightSummary [ManifestId <String>]: The unique identifier of manifest [MfaCompletionMetricId <String>]: The unique identifier of mfaCompletionMetric [MfaTelecomFraudMetricId <String>]: The unique identifier of mfaTelecomFraudMetric [MfaUserCountMetricId <String>]: The unique identifier of mfaUserCountMetric [MicrosoftAppsFileStorageContainerAppUsageAppId <String>]: The unique identifier of microsoftAppsFileStorageContainerAppUsage [MicrosoftAppsFileStorageContainerGeoUsageDataLocationCode <String>]: The unique identifier of microsoftAppsFileStorageContainerGeoUsage [MonthlyInactiveUsersByApplicationMetricId <String>]: The unique identifier of monthlyInactiveUsersByApplicationMetric [MonthlyInactiveUsersMetricId <String>]: The unique identifier of monthlyInactiveUsersMetric [OperationId <String>]: The unique identifier of operation [Period <String>]: Usage: period='{period}' [PrintUsageByPrinterId <String>]: The unique identifier of printUsageByPrinter [PrintUsageByUserId <String>]: The unique identifier of printUsageByUser [PrintUsageId <String>]: The unique identifier of printUsage [PrinterId <String>]: Usage: printerId='{printerId}' [ProvisioningObjectSummaryId <String>]: The unique identifier of provisioningObjectSummary [SelfServiceSignUpId <String>]: The unique identifier of selfServiceSignUp [ServicePrincipalSignInActivityId <String>]: The unique identifier of servicePrincipalSignInActivity [SignInEventsActivityId <String>]: The unique identifier of signInEventsActivity [SignInEventsAppActivityAppId <String>]: The unique identifier of signInEventsAppActivity [SignInId <String>]: The unique identifier of signIn [Skip <Int32?>]: Usage: skip={skip} [SkipToken <String>]: Usage: skipToken='{skipToken}' [StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime} [Top <Int32?>]: Usage: top={top} [UserCountMetricId <String>]: The unique identifier of userCountMetric [UserCredentialUsageDetailsId <String>]: The unique identifier of userCredentialUsageDetails [UserEventsSummaryId <String>]: The unique identifier of userEventsSummary [UserId <String>]: Usage: userId='{userId}' [UserMfaSignInSummaryId <String>]: The unique identifier of userMfaSignInSummary [UserPasswordResetsAndChangesSummaryId <String>]: The unique identifier of userPasswordResetsAndChangesSummary [UserRegistrationDetailsId <String>]: The unique identifier of userRegistrationDetails [UserRequestsMetricId <String>]: The unique identifier of userRequestsMetric [UserSignUpMetricId <String>]: The unique identifier of userSignUpMetric

Get-MgBetaReportSharePointApiUsage

Syntax

Get1 (Default)

Get2

Get

Get3

GetViaIdentity3

GetViaIdentity2

GetViaIdentity1

GetViaIdentity

Parameters

-AppId

Parameter properties

Parameter sets

-Break

Parameter properties

Parameter sets

-Date

Parameter properties

Parameter sets

-Headers

Parameter properties

Parameter sets

-HttpPipelineAppend

Parameter properties

Parameter sets

-HttpPipelinePrepend

Parameter properties

Parameter sets

-InputObject

Parameter properties

Parameter sets

-OutFile

Parameter properties

Parameter sets

-PassThru

Parameter properties

Parameter sets

-Period

Parameter properties

Parameter sets

-Proxy

Parameter properties

Parameter sets

-ProxyCredential

Parameter properties

Parameter sets

-ProxyUseDefaultCredentials

Parameter properties

Parameter sets

-ReportType

Parameter properties

Parameter sets

-ResponseHeadersVariable

Parameter properties

Parameter sets

CommonParameters

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IReportsIdentity

System.Collections.IDictionary

Outputs

System.Boolean

Notes

Related Links