Merge pull request #1700 from kris6673/this-and-that

Chore: Better admin roles member listing,improve error handling and standardize function casing

Author: JohnDuprey

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Scheduler/Invoke-RemoveScheduledItem.ps1

@@ -4,32 +4,41 @@ function Invoke-RemoveScheduledItem {
         Entrypoint,AnyTenant
     .ROLE
         CIPP.Scheduler.ReadWrite
+    .DESCRIPTION
+        Removes a scheduled item from CIPP's scheduler.
     #>
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
 
-    $APIName = 'RemoveScheduledItem'
-    $User = $Request.Headers
+    $APIName = $Request.Params.CIPPEndpoint
+    $Headers = $Request.Headers
 
     $RowKey = $Request.Query.id ? $Request.Query.id : $Request.Body.id
     $task = @{
         RowKey       = $RowKey
         PartitionKey = 'ScheduledTask'
     }
-    $Table = Get-CIPPTable -TableName 'ScheduledTasks'
-    Remove-AzDataTableEntity -Force @Table -Entity $task
+    try {
+        $Table = Get-CIPPTable -TableName 'ScheduledTasks'
+        Remove-AzDataTableEntity -Force @Table -Entity $task
 
-    $DetailTable = Get-CIPPTable -TableName 'ScheduledTaskDetails'
-    $Details = Get-CIPPAzDataTableEntity @DetailTable -Filter "PartitionKey eq '$($RowKey)'" -Property RowKey, PartitionKey, ETag
+        $DetailTable = Get-CIPPTable -TableName 'ScheduledTaskDetails'
+        $Details = Get-CIPPAzDataTableEntity @DetailTable -Filter "PartitionKey eq '$($RowKey)'" -Property RowKey, PartitionKey, ETag
 
-    if ($Details) {
-        Remove-AzDataTableEntity -Force @DetailTable -Entity $Details
-    }
+        if ($Details) {
+            Remove-AzDataTableEntity -Force @DetailTable -Entity $Details
+        }
 
-    Write-LogMessage -Headers $User -API $APINAME -message "Task removed: $($task.RowKey)" -Sev 'Info'
+        Write-LogMessage -Headers $Headers -API $APIName -message "Task removed: $($task.RowKey)" -Sev 'Info'
+        $StatusCode = [HttpStatusCode]::OK
+    } catch {
+        $ErrorMessage = Get-CippException -Exception $_
+        Write-LogMessage -Headers $Headers -API $APIName -message "Failed to remove task: $($task.RowKey). $($ErrorMessage.NormalizedError)" -Sev 'Error' -LogData $ErrorMessage
+        $StatusCode = [HttpStatusCode]::BadRequest
+    }
 
     return ([HttpResponseContext]@{
-            StatusCode = [HttpStatusCode]::OK
+            StatusCode = $StatusCode
             Body       = @{ Results = 'Task removed successfully.' }
         })
 

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Administration/Contacts/Invoke-RemoveContactTemplates.ps1

@@ -1,4 +1,4 @@
-Function Invoke-RemoveContactTemplates {
+function Invoke-RemoveContactTemplates {
     <#
     .FUNCTIONALITY
         Entrypoint,AnyTenant
@@ -8,23 +8,23 @@ Function Invoke-RemoveContactTemplates {
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
     $APIName = $Request.Params.CIPPEndpoint
-    $User = $Request.Headers
+    $Headers = $Request.Headers
 
-    Write-LogMessage -Headers $User -API $APINAME -message 'Accessed this API' -Sev 'Debug'
-    $ID = $request.query.ID ?? $request.body.ID
+    Write-LogMessage -Headers $Headers -API $APIName -message 'Accessed this API' -Sev 'Debug'
+    $ID = $Request.Query.ID ?? $Request.Body.ID
 
     try {
         $Table = Get-CippTable -tablename 'templates'
         $Filter = "PartitionKey eq 'ContactTemplate' and RowKey eq '$id'"
         $ClearRow = Get-CIPPAzDataTableEntity @Table -Filter $Filter -Property PartitionKey, RowKey
         Remove-AzDataTableEntity -Force @Table -Entity $ClearRow
         $Result = "Removed Contact Template with ID $ID."
-        Write-LogMessage -Headers $User -API $APINAME -message $Result -Sev 'Info'
+        Write-LogMessage -Headers $Headers -API $APIName -message $Result -Sev 'Info'
         $StatusCode = [HttpStatusCode]::OK
     } catch {
         $ErrorMessage = Get-CippException -Exception $_
         $Result = "Failed to remove Contact template with ID $ID. Error: $($ErrorMessage.NormalizedError)"
-        Write-LogMessage -Headers $User -API $APINAME -message $Result -Sev 'Error' -LogData $ErrorMessage
+        Write-LogMessage -Headers $Headers -API $APIName -message $Result -Sev 'Error' -LogData $ErrorMessage
         $StatusCode = [HttpStatusCode]::Forbidden
     }
     return ([HttpResponseContext]@{

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Email-Exchange/Spamfilter/Invoke-ListConnectionFilter.ps1

@@ -1,4 +1,4 @@
-Function Invoke-ListConnectionFilter {
+function Invoke-ListConnectionFilter {
     <#
     .FUNCTIONALITY
         Entrypoint
@@ -7,10 +7,10 @@ Function Invoke-ListConnectionFilter {
     #>
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
-    $Tenantfilter = $request.Query.tenantfilter
+    $TenantFilter = $request.Query.tenantFilter
 
     try {
-        $Policies = New-ExoRequest -tenantid $Tenantfilter -cmdlet 'Get-HostedConnectionFilterPolicy' | Select-Object * -ExcludeProperty *odata*, *data.type*
+        $Policies = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Get-HostedConnectionFilterPolicy' | Select-Object * -ExcludeProperty *odata*, *data.type*
         $StatusCode = [HttpStatusCode]::OK
     } catch {
         $ErrorMessage = Get-NormalizedError -Message $_.Exception.Message

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Endpoint/Autopilot/Invoke-AddAPDevice.ps1

@@ -1,24 +1,29 @@
-Function Invoke-AddAPDevice {
+function Invoke-AddAPDevice {
     <#
     .FUNCTIONALITY
         Entrypoint
     .ROLE
         Endpoint.Autopilot.ReadWrite
+    .DESCRIPTION
+        Adds Autopilot devices to a tenant via Partner Center API
     #>
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
 
     $APIName = $Request.Params.CIPPEndpoint
-    $TenantFilter = (Get-Tenants | Where-Object { $_.defaultDomainName -eq $Request.body.TenantFilter.value }).customerId
-    $GroupName = if ($Request.body.Groupname) { $Request.body.Groupname } else { (New-Guid).GUID }
+    $Headers = $Request.Headers
+
+    $TenantFilter = (Get-Tenants | Where-Object { $_.defaultDomainName -eq $Request.Body.TenantFilter.value }).customerId
+    $GroupName = if ($Request.Body.Groupname) { $Request.Body.Groupname } else { (New-Guid).GUID }
     Write-Host $GroupName
-    $rawDevices = $request.body.autopilotData
+
+    $rawDevices = $Request.Body.autopilotData
     $Devices = ConvertTo-Json @($rawDevices)
     $Result = try {
-        $CurrentStatus = (New-GraphgetRequest -uri "https://api.partnercenter.microsoft.com/v1/customers/$tenantfilter/DeviceBatches" -scope 'https://api.partnercenter.microsoft.com/user_impersonation')
-        if ($groupname -in $CurrentStatus.items.id) {
+        $CurrentStatus = (New-GraphGetRequest -uri "https://api.partnercenter.microsoft.com/v1/customers/$TenantFilter/DeviceBatches" -scope 'https://api.partnercenter.microsoft.com/user_impersonation')
+        if ($GroupName -in $CurrentStatus.items.id) {
             Write-Host 'Gonna do an update!'
-            $body = $request.body.autopilotData | ForEach-Object {
+            $Body = $Request.Body.autopilotData | ForEach-Object {
                 $Device = $_
                 [pscustomobject]@{
                     deviceBatchId       = $GroupName
@@ -29,41 +34,40 @@ Function Invoke-AddAPDevice {
                     modelName           = $Device.modelName
                 }
             }
-            $body = ConvertTo-Json -Depth 10 -Compress -InputObject @($body)
-            Write-Host $body
-            $GraphRequest = (New-GraphPostRequest -returnHeaders $true -uri "https://api.partnercenter.microsoft.com/v1/customers/$TenantFilter/deviceBatches/$groupname/devices" -body $body -scope 'https://api.partnercenter.microsoft.com/user_impersonation')
+            $Body = ConvertTo-Json -Depth 10 -Compress -InputObject @($Body)
+            Write-Host $Body
+            $GraphRequest = (New-GraphPOSTRequest -returnHeaders $true -uri "https://api.partnercenter.microsoft.com/v1/customers/$TenantFilter/deviceBatches/$GroupName/devices" -body $Body -scope 'https://api.partnercenter.microsoft.com/user_impersonation')
         } else {
-            $body = '{"batchId":"' + $($GroupName) + '","devices":' + $Devices + '}'
-            $GraphRequest = (New-GraphPostRequest -returnHeaders $true -uri "https://api.partnercenter.microsoft.com/v1/customers/$TenantFilter/DeviceBatches" -body $body -scope 'https://api.partnercenter.microsoft.com/user_impersonation')
+            $Body = '{"batchId":"' + $($GroupName) + '","devices":' + $Devices + '}'
+            $GraphRequest = (New-GraphPOSTRequest -returnHeaders $true -uri "https://api.partnercenter.microsoft.com/v1/customers/$TenantFilter/DeviceBatches" -body $Body -scope 'https://api.partnercenter.microsoft.com/user_impersonation')
         }
         $Amount = 0
         do {
             Write-Host "Checking status of import job for $GroupName"
-            $amount ++
+            $Amount++
             Start-Sleep 1
-            $NewStatus = New-GraphgetRequest -uri "https://api.partnercenter.microsoft.com/v1/$($GraphRequest.Location)" -scope 'https://api.partnercenter.microsoft.com/user_impersonation'
-        } until ($Newstatus.status -eq 'finished' -or $amount -eq 4)
+            $NewStatus = New-GraphGetRequest -uri "https://api.partnercenter.microsoft.com/v1/$($GraphRequest.Location)" -scope 'https://api.partnercenter.microsoft.com/user_impersonation'
+        } until ($NewStatus.status -eq 'finished' -or $Amount -eq 4)
         if ($NewStatus.status -ne 'finished') { throw 'Could not retrieve status of import - This job might still be running. Check the autopilot device list in 10 minutes for the latest status.' }
         Write-LogMessage -headers $Request.Headers -API $APIName -tenant $($Request.body.TenantFilter.value) -message "Created Autopilot devices group. Group ID is $GroupName" -Sev 'Info'
 
         [PSCustomObject]@{
             Status  = 'Import Job Completed'
             Devices = @($NewStatus.devicesStatus)
         }
+        $StatusCode = [HttpStatusCode]::OK
     } catch {
+        $ErrorMessage = Get-CippException -Exception $_
+        $StatusCode = [HttpStatusCode]::InternalServerError
         [PSCustomObject]@{
-            Status  = "$($Request.body.TenantFilter.value): Failed to create autopilot devices. $($_.Exception.Message)"
+            Status  = "$($Request.Body.TenantFilter.value): Failed to create autopilot devices. $($ErrorMessage.NormalizedError)"
             Devices = @()
         }
-        Write-LogMessage -headers $Request.Headers -API $APIName -tenant $($Request.body.TenantFilter.value) -message "Failed to create autopilot devices. $($_.Exception.Message)" -Sev 'Error'
+        Write-LogMessage -headers $Headers -API $APIName -tenant $($Request.Body.TenantFilter.value) -message "Failed to create autopilot devices. $($ErrorMessage.NormalizedError)" -Sev 'Error' -LogData $ErrorMessage
     }
 
-    $body = [pscustomobject]@{'Results' = $Result }
-    Write-Host $body
     return ([HttpResponseContext]@{
-            StatusCode = [HttpStatusCode]::OK
-            Body       = $body
-
+            StatusCode = $StatusCode
+            Body       = @{'Results' = $Result }
         })
-
 }

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Endpoint/MEM/Invoke-ListAssignmentFilterTemplates.ps1

@@ -8,12 +8,7 @@ function Invoke-ListAssignmentFilterTemplates {
     [CmdletBinding()]
     param($Request, $TriggerMetadata)
 
-    $APIName = $Request.Params.CIPPEndpoint
-    $Headers = $Request.Headers
-
-
-
-    Write-Host $Request.query.id
+    $ID = $Request.Query.ID
 
     #List assignment filter templates
     $Table = Get-CippTable -tablename 'templates'
@@ -22,16 +17,16 @@ function Invoke-ListAssignmentFilterTemplates {
         $data = $_.JSON | ConvertFrom-Json
 
         [PSCustomObject]@{
-            displayName                     = $data.displayName
-            description                     = $data.description
-            platform                        = $data.platform
-            rule                            = $data.rule
-            assignmentFilterManagementType  = $data.assignmentFilterManagementType
-            GUID                            = $_.RowKey
+            displayName                    = $data.displayName
+            description                    = $data.description
+            platform                       = $data.platform
+            rule                           = $data.rule
+            assignmentFilterManagementType = $data.assignmentFilterManagementType
+            GUID                           = $_.RowKey
         }
     } | Sort-Object -Property displayName
 
-    if ($Request.query.ID) { $Templates = $Templates | Where-Object -Property GUID -EQ $Request.query.id }
+    if ($ID) { $Templates = $Templates | Where-Object -Property GUID -EQ $ID }
 
 
     # Associate values to output bindings by calling 'Push-OutputBinding'.

Modules/CIPPCore/Public/Entrypoints/Invoke-ListRoles.ps1

@@ -1,4 +1,4 @@
-Function Invoke-ListRoles {
+function Invoke-ListRoles {
     <#
     .FUNCTIONALITY
         Entrypoint
@@ -9,23 +9,34 @@ Function Invoke-ListRoles {
     param($Request, $TriggerMetadata)
     # Interact with query parameters or the body of the request.
     $TenantFilter = $Request.Query.tenantFilter
-    $SelectList = 'id', 'displayName', 'userPrincipalName'
 
-    [System.Collections.Generic.List[PSCustomObject]]$Roles = New-GraphGetRequest -uri "https://graph.microsoft.com/v1.0/directoryRoles?`$expand=members" -tenantid $TenantFilter
-    $GraphRequest = foreach ($Role in $Roles) {
-
-        #[System.Collections.Generic.List[PSCustomObject]]$Members = New-GraphGetRequest -uri "https://graph.microsoft.com/beta/directoryRoles/$($Role.id)/members?`$select=$($SelectList -join ',')" -tenantid $TenantFilter | Select-Object $SelectList
-        $Members = if ($Role.members) { $role.members | ForEach-Object { " $($_.displayName) ($($_.userPrincipalName))" } } else { 'none' }
-        [PSCustomObject]@{
-            DisplayName = $Role.displayName
-            Description = $Role.description
-            Members     = $Members -join ','
+    try {
+        [System.Collections.Generic.List[PSCustomObject]]$Roles = New-GraphGetRequest -uri "https://graph.microsoft.com/v1.0/directoryRoles?`$expand=members" -tenantid $TenantFilter
+        $GraphRequest = foreach ($Role in $Roles) {
+            $Members = if ($Role.members) {
+                $Role.members | ForEach-Object { [PSCustomObject]@{
+                        displayName       = $_.displayName
+                        userPrincipalName = $_.userPrincipalName
+                        id                = $_.id
+                    } }
+            }
+            [PSCustomObject]@{
+                Id             = $Role.id
+                roleTemplateId = $Role.roleTemplateId
+                DisplayName    = $Role.displayName
+                Description    = $Role.description
+                Members        = @($Members)
+            }
         }
+        $StatusCode = [HttpStatusCode]::OK
+    } catch {
+        $ErrorMessage = Get-CippException -Exception $_
+        "Failed to list roles for tenant $TenantFilter. $($ErrorMessage.NormalizedError)"
+        $StatusCode = [HttpStatusCode]::BadRequest
     }
 
     return [HttpResponseContext]@{
-            StatusCode = [HttpStatusCode]::OK
-            Body       = $GraphRequest
-        }
-
+        StatusCode = $StatusCode
+        Body       = $GraphRequest
+    }
 }