Public/Get-SfLimits.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<#
    .SYNOPSIS
    Queries salesforce limits report

    .DESCRIPTION
    Used to query for salesforce limits in the salesforce org.

    .INPUTS
    None. You cannot pipe objects to Get-SfDevices.

    .OUTPUTS
    An array of PSCustomObject with the properties:
       - AnalyticsExternalDataSizeMB
       - BOZosCalloutHourlyLimit
       - ConcurrentAsyncGetReportInstances
       - ConcurrentEinsteinDataInsightsStoryCreation
       - ConcurrentEinsteinDiscoveryStoryCreation
       - ConcurrentSyncReportRuns
       - DailyAnalyticsDataflowJobExecutions
       - DailyAnalyticsUploadedFilesSizeMB
       - DailyApiRequests
       - DailyAsyncApexExecutions
       - DailyBulkApiRequests
       - DailyBulkV2QueryFileStorageMB
       - DailyBulkV2QueryJobs
       - DailyDurableGenericStreamingApiEvents
       - DailyDurableStreamingApiEvents
       - DailyEinsteinDataInsightsStoryCreation
       - DailyEinsteinDiscoveryPredictAPICalls
       - DailyEinsteinDiscoveryPredictionsByCDC
       - DailyEinsteinDiscoveryStoryCreation
       - DailyGenericStreamingApiEvents
       - DailyStandardVolumePlatformEvents
       - DailyStreamingApiEvents
       - DailyWorkflowEmails
       - DataStorageMB
       - DurableStreamingApiConcurrentClients
       - FileStorageMB
       - HourlyAsyncReportRuns
       - HourlyDashboardRefreshes
       - HourlyDashboardResults
       - HourlyDashboardStatuses
       - HourlyLongTermIdMapping
       - HourlyODataCallout
       - HourlyPublishedPlatformEvents
       - HourlyPublishedStandardVolumePlatformEvents
       - HourlyShortTermIdMapping
       - HourlySyncReportRuns
       - HourlyTimeBasedWorkflow
       - MassEmail
       - MonthlyEinsteinDiscoveryStoryCreation
       - MonthlyPlatformEventsUsageEntitlement
       - Package2VersionCreates
       - Package2VersionCreatesWithoutValidation
       - PermissionSets
       - SingleEmail
       - StreamingApiConcurrentClients

    .EXAMPLE
    PS> (Get-SfLimits).DailyApiRequests.Remaining

    .LINK
    Set-FileConfig

    .NOTES
    Assumes config is initialized for org access.
#>

function Get-SfLimits {
    Invoke-SfApi "/limits"
}