Add ShouldProcess support for revoke functions

Enhance the Revoke-FabricExternalDataShares and Revoke-FabricCapacityTenantSettingOverrides functions to include ShouldProcess support, allowing for confirmation prompts before executing the revoke actions. This improves safety and user control over destructive operations.

Also, update the corresponding test files to include new parameters for Confirm and WhatIf, ensuring comprehensive testing for these changes.

Thank you!

Author: SQLDBAWithABeard

source/Public/External Data Share/Revoke-FabricExternalDataShares.ps1

@@ -53,10 +53,13 @@ function Revoke-FabricExternalDataShares {
         Write-Message -Message "Constructing API endpoint URI..." -Level Debug
         $apiEndpointURI = "{0}/admin/workspaces/{1}/items/{2}/externalDataShares/{3}/revoke" -f $FabricConfig.BaseUrl, $WorkspaceId, $ItemId, $ExternalDataShareId
 
+        if ($PSCmdlet.ShouldProcess("$ExternalDataShareId", "revoke")) {
+
         $externalDataShares = Invoke-FabricAPIRequest `
             -BaseURI $apiEndpointURI `
             -Headers $FabricConfig.FabricHeaders `
             -Method Post
+        }
 
         # Step 4: Return retrieved data
         Write-Message -Message "Successfully revoked external data shares." -Level Info

source/Public/Tenant/Revoke-FabricCapacityTenantSettingOverrides.ps1

@@ -43,12 +43,13 @@ function Revoke-FabricCapacityTenantSettingOverrides {
         $apiEndpointURI = "{0}/admin/capacities/{1}/delegatedTenantSettingOverrides/{2}" -f $FabricConfig.BaseUrl, $capacityId, $tenantSettingName
         Write-Message -Message "Constructed API Endpoint: $apiEndpointURI" -Level Debug
 
+        if ($PSCmdlet.ShouldProcess("$tenantSettingName" , "Revoke")) {
         # Step 3: Invoke the Fabric API to retrieve capacity tenant setting overrides
         $response = Invoke-FabricAPIRequest `
             -BaseURI $apiEndpointURI `
             -Headers $FabricConfig.FabricHeaders `
             -Method Delete
-
+        }
         Write-Message -Message "Successfully removed the tenant setting override '$tenantSettingName' from the capacity with ID '$capacityId'." -Level Info
         return $response
     } catch {

tests/Unit/Revoke-FabricCapacityTenantSettingOverrides.Tests.ps1

@@ -3,20 +3,21 @@ param(
     $ModuleName = "FabricTools",
     $expectedParams = @(
         "capacityId"
-                "tenantSettingName"
-                "Verbose"
-                "Debug"
-                "ErrorAction"
-                "WarningAction"
-                "InformationAction"
-                "ProgressAction"
-                "ErrorVariable"
-                "WarningVariable"
-                "InformationVariable"
-                "OutVariable"
-                "OutBuffer"
-                "PipelineVariable"
-                
+        "tenantSettingName"
+        "Verbose"
+        "Debug"
+        "ErrorAction"
+        "WarningAction"
+        "InformationAction"
+        "ProgressAction"
+        "ErrorVariable"
+        "WarningVariable"
+        "InformationVariable"
+        "OutVariable"
+        "OutBuffer"
+        "PipelineVariable"
+        "Confirm"
+        "WhatIf"
     )
 )
 
@@ -44,4 +45,3 @@ Describe "Revoke-FabricCapacityTenantSettingOverrides" -Tag "UnitTests" {
         }
     }
 }
-

tests/Unit/Revoke-FabricExternalDataShares.Tests.ps1

@@ -3,21 +3,22 @@ param(
     $ModuleName = "FabricTools",
     $expectedParams = @(
         "WorkspaceId"
-                "ItemId"
-                "ExternalDataShareId"
-                "Verbose"
-                "Debug"
-                "ErrorAction"
-                "WarningAction"
-                "InformationAction"
-                "ProgressAction"
-                "ErrorVariable"
-                "WarningVariable"
-                "InformationVariable"
-                "OutVariable"
-                "OutBuffer"
-                "PipelineVariable"
-                
+        "ItemId"
+        "ExternalDataShareId"
+        "Verbose"
+        "Debug"
+        "ErrorAction"
+        "WarningAction"
+        "InformationAction"
+        "ProgressAction"
+        "ErrorVariable"
+        "WarningVariable"
+        "InformationVariable"
+        "OutVariable"
+        "OutBuffer"
+        "PipelineVariable"
+        "Confirm"
+        "WhatIf"
     )
 )
 
@@ -45,4 +46,3 @@ Describe "Revoke-FabricExternalDataShares" -Tag "UnitTests" {
         }
     }
 }
-