Merge pull request #1313 from kris6673/endpoints

Move some functions, modernize and support POST and GET
KelvinTegelaar · Feb 24, 2025 · cd3394a · cd3394a
2 parents ce0fdd4 + 6bd7c23
commit cd3394a
Show file tree

Hide file tree

Showing 126 changed files with 1,116 additions and 1,090 deletions.
diff --git a/Modules/CIPPCore/Public/CippQueue/Invoke-ListCippQueue.ps1 b/Modules/CIPPCore/Public/CippQueue/Invoke-ListCippQueue.ps1
@@ -10,9 +10,6 @@ function Invoke-ListCippQueue {
     if ($Request) {
         $APIName = $Request.Params.CIPPEndpoint
         Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
-
-        # Write to the Azure Functions log stream.
-        Write-Host 'PowerShell HTTP trigger function processed a request.'
     }
 
     $CippQueue = Get-CippTable -TableName 'CippQueue'

diff --git a/Modules/CIPPCore/Public/CippQueue/Invoke-RemoveCippQueue.ps1 b/Modules/CIPPCore/Public/CippQueue/Invoke-RemoveCippQueue.ps1
@@ -10,9 +10,6 @@ function Invoke-RemoveCippQueue {
     $APIName = $Request.Params.CIPPEndpoint
     Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
 
-    # Write to the Azure Functions log stream.
-    Write-Host 'PowerShell HTTP trigger function processed a request.'
-
     $CippQueue = Get-CippTable -TableName 'CippQueue'
     Clear-AzDataTable @CippQueue
     $CippQueueTasks = Get-CippTable -TableName 'CippQueueTasks'

diff --git a/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-ExecListBackup.ps1 b/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-ExecListBackup.ps1
@@ -10,23 +10,32 @@ Function Invoke-ExecListBackup {
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
 
+    $APIName = $Request.Params.CIPPEndpoint
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'
+
+    $Type = $Request.Query.Type
+    $TenantFilter = $Request.Query.tenantFilter
+    $NameOnly = $Request.Query.NameOnly
+    $BackupName = $Request.Query.BackupName
+
     $CippBackupParams = @{}
-    if ($Request.Query.Type) {
-        $CippBackupParams.Type = $Request.Query.Type
+    if ($Type) {
+        $CippBackupParams.Type = $Type
     }
-    if ($Request.Query.TenantFilter) {
-        $CippBackupParams.TenantFilter = $Request.Query.TenantFilter
+    if ($TenantFilter) {
+        $CippBackupParams.TenantFilter = $TenantFilter
     }
-    if ($Request.Query.NameOnly) {
+    if ($NameOnly) {
         $CippBackupParams.NameOnly = $true
     }
-    if ($Request.Query.BackupName) {
-        $CippBackupParams.Name = $Request.Query.BackupName
+    if ($BackupName) {
+        $CippBackupParams.Name = $BackupName
     }
 
     $Result = Get-CIPPBackup @CippBackupParams
 
-    if ($request.Query.NameOnly) {
+    if ($NameOnly) {
         $Result = $Result | Select-Object @{Name = 'BackupName'; exp = { $_.RowKey } }, Timestamp | Sort-Object Timestamp -Descending
     }
 

diff --git a/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-GetVersion.ps1 b/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-GetVersion.ps1
@@ -13,10 +13,9 @@ Function Invoke-GetVersion {
     $APIName = $Request.Params.CIPPEndpoint
     Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
 
-    $CIPPVersion = $request.query.localversion
+    $CIPPVersion = $request.query.LocalVersion
 
     $Version = Assert-CippVersion -CIPPVersion $CIPPVersion
-    # Write to the Azure Functions log stream.
 
     # Associate values to output bindings by calling 'Push-OutputBinding'.
     Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{

diff --git a/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-ListApiTest.ps1 b/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-ListApiTest.ps1
@@ -8,6 +8,7 @@ function Invoke-ListApiTest {
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
 
+    # Associate values to output bindings by calling 'Push-OutputBinding'.
     Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
             StatusCode = [HttpStatusCode]::OK
             Body       = ($Request | ConvertTo-Json -Depth 5)

diff --git a/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/invoke-ListEmptyResults.ps1 b/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/invoke-ListEmptyResults.ps1
@@ -11,6 +11,7 @@ Function invoke-ListEmptyResults {
     param($Request, $TriggerMetadata)
 
 
+    # Associate values to output bindings by calling 'Push-OutputBinding'.
     Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
             StatusCode = [HttpStatusCode]::OK
             Body       = @()

diff --git a/...s/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Scheduler/Invoke-ListScheduledItems.ps1 b/...s/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Scheduler/Invoke-ListScheduledItems.ps1
@@ -10,35 +10,42 @@ Function Invoke-ListScheduledItems {
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
 
-    # Write to the Azure Functions log stream.
-    Write-Host 'PowerShell HTTP trigger function processed a request.'
+    $APIName = $Request.Params.CIPPEndpoint
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'
+
+
+    # Interact with query parameters or the body of the request.
+    $ShowHidden = $Request.Query.ShowHidden ?? $Request.Body.ShowHidden
+    $Name = $Request.Query.Name ?? $Request.Body.Name
+    $Type = $Request.Query.Type ?? $Request.Body.Type
 
     $ScheduledItemFilter = [System.Collections.Generic.List[string]]::new()
     $ScheduledItemFilter.Add("PartitionKey eq 'ScheduledTask'")
 
-    if ($Request.Query.ShowHidden) {
+    if ($ShowHidden -eq $true) {
         $ScheduledItemFilter.Add('Hidden eq true')
     } else {
         $ScheduledItemFilter.Add('Hidden eq false')
     }
 
-    if ($Request.Query.Name) {
-        $ScheduledItemFilter.Add("Name eq '$($Request.Query.Name)'")
+    if ($Name -eq $true) {
+        $ScheduledItemFilter.Add("Name eq '$($Name)'")
     }
 
     $Filter = $ScheduledItemFilter -join ' and '
 
     Write-Host "Filter: $Filter"
     $Table = Get-CIPPTable -TableName 'ScheduledTasks'
-    if ($Request.Query.Showhidden -eq $true) {
+    if ($ShowHidden -eq $true) {
         $HiddenTasks = $false
     } else {
         $HiddenTasks = $true
     }
     $Tasks = Get-CIPPAzDataTableEntity @Table -Filter $Filter | Where-Object { $_.Hidden -ne $HiddenTasks }
-    if ($Request.Query.Type) {
-        $tasks.Command
-        $Tasks = $Tasks | Where-Object { $_.command -eq $Request.Query.Type }
+    if ($Type) {
+        $Tasks.Command
+        $Tasks = $Tasks | Where-Object { $_.command -eq $Type }
     }
 
     $AllowedTenants = Test-CIPPAccess -Request $Request -TenantList

diff --git a/...es/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Settings/Invoke-ExecCPVPermissions.ps1 b/...es/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Settings/Invoke-ExecCPVPermissions.ps1
@@ -11,18 +11,17 @@ Function Invoke-ExecCPVPermissions {
     param($Request, $TriggerMetadata)
 
     $APIName = $Request.Params.CIPPEndpoint
-    Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'
+    $TenantFilter = $Request.Body.tenantFilter
 
-    # Write to the Azure Functions log stream.
-    Write-Host 'PowerShell HTTP trigger function processed a request.'
-    $Tenant = Get-Tenants -IncludeAll | Where-Object -Property customerId -EQ $Request.Body.TenantFilter | Select-Object -First 1
+    $Tenant = Get-Tenants -IncludeAll | Where-Object -Property customerId -EQ $TenantFilter | Select-Object -First 1
 
     if ($Tenant) {
         Write-Host "Our tenant is $($Tenant.displayName) - $($Tenant.defaultDomainName)"
 
-        $TenantFilter = $Request.Body.TenantFilter
         $CPVConsentParams = @{
-            TenantFilter = $Request.Body.TenantFilter
+            TenantFilter = $TenantFilter
         }
         if ($Request.Query.ResetSP -eq 'true') {
             $CPVConsentParams.ResetSP = $true

diff --git a/...points/Invoke-AddTenantAllowBlockList.ps1 → ...change/Invoke-AddTenantAllowBlockList.ps1 b/...points/Invoke-AddTenantAllowBlockList.ps1 → ...change/Invoke-AddTenantAllowBlockList.ps1
diff --git a/...PPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Invoke-EditAntiPhishingFilter.ps1 b/...PPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Invoke-EditAntiPhishingFilter.ps1
@@ -9,24 +9,24 @@ function Invoke-EditAntiPhishingFilter {
     param($Request, $TriggerMetadata)
 
     $APIName = $Request.Params.CIPPEndpoint
-    Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
-
-    # Write to the Azure Functions log stream.
-    Write-Host 'PowerShell HTTP trigger function processed a request.'
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
 
     # Interact with query parameters or the body of the request.
-    $TenantFilter = $Request.Query.TenantFilter
+    $TenantFilter = $Request.Query.tenantFilter ?? $Request.Body.tenantFilter
+    $RuleName = $Request.Query.RuleName ?? $Request.Body.RuleName
+    $State = $Request.Query.State ?? $Request.Body.State
 
     try {
         $ExoRequestParam = @{
-            tenantid = $TenantFilter
-            cmdParams = @{
-                Identity = $Request.query.RuleName
+            tenantid         = $TenantFilter
+            cmdParams        = @{
+                Identity = $RuleName
             }
-            useSystemmailbox = $true
+            useSystemMailbox = $true
         }
 
-        switch ($Request.query.State) {
+        switch ($State) {
             'Enable' {
                 $ExoRequestParam.Add('cmdlet', 'Enable-AntiPhishRule')
             }
@@ -37,19 +37,21 @@ function Invoke-EditAntiPhishingFilter {
                 throw 'Invalid state'
             }
         }
-        New-ExoRequest @ExoRequestParam
+        $null = New-ExoRequest @ExoRequestParam
 
-        $Result = "Sucessfully set Anti-Phishing rule $($Request.query.RuleName) to $($Request.query.State)"
-        Write-LogMessage -headers $Request.Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev Info
+        $Result = "Successfully set Anti-Phishing rule $RuleName to $State"
+        Write-LogMessage -headers $Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev Info
+        $StatusCode = [HttpStatusCode]::OK
     } catch {
-        $ErrorMessage = Get-NormalizedError -Message $_.Exception.Message
-        $Result = "Failed setting Anti-Phishing rule $($Request.query.RuleName) to $($request.query.State). Error: $ErrorMessage"
-        Write-LogMessage -headers $Request.Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev 'Error'
+        $ErrorMessage = Get-CippException -Exception $_
+        $Result = "Failed setting Anti-Phishing rule $RuleName to $State. Error: $($ErrorMessage.NormalizedError)"
+        Write-LogMessage -headers $Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev 'Error' -LogData $ErrorMessage
+        $StatusCode = [HttpStatusCode]::InternalServerError
     }
 
     # Associate values to output bindings by calling 'Push-OutputBinding'.
     Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
-            StatusCode = [HttpStatusCode]::OK
+            StatusCode = $StatusCode
             Body       = @{Results = $Result }
-    })
+        })
 }
diff --git a/...es/CIPPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Invoke-EditMalwareFilter.ps1 b/...es/CIPPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Invoke-EditMalwareFilter.ps1
@@ -9,24 +9,24 @@ function Invoke-EditMalwareFilter {
     param($Request, $TriggerMetadata)
 
     $APIName = $Request.Params.CIPPEndpoint
-    Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
-
-    # Write to the Azure Functions log stream.
-    Write-Host 'PowerShell HTTP trigger function processed a request.'
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
 
     # Interact with query parameters or the body of the request.
-    $TenantFilter = $Request.Query.TenantFilter
+    $TenantFilter = $Request.Query.tenantFilter ?? $Request.Body.tenantFilter
+    $RuleName = $Request.Query.RuleName ?? $Request.Body.RuleName
+    $State = $Request.Query.State ?? $Request.Body.State
 
     try {
         $ExoRequestParam = @{
-            tenantid = $TenantFilter
-            cmdParams = @{
-                Identity = $Request.query.RuleName
+            tenantid         = $TenantFilter
+            cmdParams        = @{
+                Identity = $RuleName
             }
-            useSystemmailbox = $true
+            useSystemMailbox = $true
         }
 
-        switch ($Request.query.State) {
+        switch ($State) {
             'Enable' {
                 $ExoRequestParam.Add('cmdlet', 'Enable-MalwareFilterRule')
             }
@@ -37,19 +37,21 @@ function Invoke-EditMalwareFilter {
                 throw 'Invalid state'
             }
         }
-        New-ExoRequest @ExoRequestParam
+        $null = New-ExoRequest @ExoRequestParam
 
-        $Result = "Sucessfully set Malware Filter rule $($Request.query.RuleName) to $($Request.query.State)"
-        Write-LogMessage -headers $Request.Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev Info
+        $Result = "Successfully set Malware Filter rule $($RuleName) to $($State)"
+        Write-LogMessage -headers $Headers -API $APIName -tenant $TenantFilter -message $Result -Sev Info
+        $StatusCode = [HttpStatusCode]::OK
     } catch {
-        $ErrorMessage = Get-NormalizedError -Message $_.Exception.Message
-        $Result = "Failed setting Malware Filter rule $($Request.query.RuleName) to $($request.query.State). Error: $ErrorMessage"
-        Write-LogMessage -headers $Request.Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev 'Error'
+        $ErrorMessage = Get-CippException -Exception $_
+        $Result = "Failed setting Malware Filter rule $($RuleName) to $($State). Error: $($ErrorMessage.NormalizedError)"
+        Write-LogMessage -headers $Headers -API $APIName -tenant $TenantFilter -message $Result -Sev 'Error' -LogData $ErrorMessage
+        $StatusCode = [HttpStatusCode]::InternalServerError
     }
 
     # Associate values to output bindings by calling 'Push-OutputBinding'.
     Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
-            StatusCode = [HttpStatusCode]::OK
+            StatusCode = $StatusCode
             Body       = @{Results = $Result }
-    })
+        })
 }
diff --git a/...ore/Public/Entrypoints/HTTP Functions/Email-Exchange/Invoke-EditSafeAttachmentsFilter.ps1 b/...ore/Public/Entrypoints/HTTP Functions/Email-Exchange/Invoke-EditSafeAttachmentsFilter.ps1
@@ -9,24 +9,24 @@ function Invoke-EditSafeAttachmentsFilter {
     param($Request, $TriggerMetadata)
 
     $APIName = $Request.Params.CIPPEndpoint
-    Write-LogMessage -headers $Request.Headers -API $APINAME -message 'Accessed this API' -Sev 'Debug'
-
-    # Write to the Azure Functions log stream.
-    Write-Host 'PowerShell HTTP trigger function processed a request.'
+    $Headers = $Request.Headers
+    Write-LogMessage -headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'
 
     # Interact with query parameters or the body of the request.
-    $TenantFilter = $Request.Query.TenantFilter
+    $TenantFilter = $Request.Query.tenantFilter ?? $Request.Body.tenantFilter
+    $RuleName = $Request.Query.RuleName ?? $Request.Body.RuleName
+    $State = $Request.Query.State ?? $Request.Body.State
 
     try {
         $ExoRequestParam = @{
-            tenantid = $TenantFilter
-            cmdParams = @{
-                Identity = $Request.query.RuleName
+            tenantid         = $TenantFilter
+            cmdParams        = @{
+                Identity = $RuleName
             }
-            useSystemmailbox = $true
+            useSystemMailbox = $true
         }
 
-        switch ($Request.query.State) {
+        switch ($State) {
             'Enable' {
                 $ExoRequestParam.Add('cmdlet', 'Enable-SafeAttachmentRule')
             }
@@ -37,19 +37,21 @@ function Invoke-EditSafeAttachmentsFilter {
                 throw 'Invalid state'
             }
         }
-        New-ExoRequest @ExoRequestParam
+        $null = New-ExoRequest @ExoRequestParam
 
-        $Result = "Sucessfully set SafeAttachment rule $($Request.query.RuleName) to $($Request.query.State)"
-        Write-LogMessage -headers $Request.Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev Info
+        $Result = "Successfully set SafeAttachment rule $($RuleName) to $($State)"
+        Write-LogMessage -headers $Headers -API $APIName -tenant $TenantFilter -message $Result -Sev 'Info'
+        $StatusCode = [HttpStatusCode]::OK
     } catch {
-        $ErrorMessage = Get-NormalizedError -Message $_.Exception.Message
-        $Result = "Failed setting SafeAttachment rule $($Request.query.RuleName) to $($request.query.State). Error: $ErrorMessage"
-        Write-LogMessage -headers $Request.Headers -API $APINAME -tenant $TenantFilter -message $Result -Sev 'Error'
+        $ErrorMessage = Get-CippException -Exception $_
+        $Result = "Failed setting SafeAttachment rule $($RuleName) to $($State). Error: $($ErrorMessage.NormalizedError)"
+        Write-LogMessage -headers $Headers -API $APIName -tenant $TenantFilter -message $Result -Sev 'Error' -LogData $ErrorMessage
+        $StatusCode = [HttpStatusCode]::InternalServerError
     }
 
     # Associate values to output bindings by calling 'Push-OutputBinding'.
     Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
-            StatusCode = [HttpStatusCode]::OK
+            StatusCode = $StatusCode
             Body       = @{Results = $Result }
-    })
+        })
 }