public/Tenant/Update-FabricTenantSetting.ps1
|
<#
.SYNOPSIS Updates tenant setting overrides for a specified capacity ID. .DESCRIPTION The `Update-FabricCapacityTenantSettingOverrides` function updates tenant setting overrides in a Fabric environment by making a POST request to the appropriate API endpoint. It allows specifying settings such as enabling tenant settings, delegating to a workspace, and including or excluding security groups. .PARAMETER CapacityId (Mandatory) The ID of the capacity for which the tenant setting overrides are being updated. .PARAMETER SettingTitle (Mandatory) The title of the tenant setting to be updated. .PARAMETER EnableTenantSetting (Mandatory) Indicates whether the tenant setting should be enabled. .PARAMETER DelegateToWorkspace (Optional) Specifies the workspace to which the setting should be delegated. .PARAMETER EnabledSecurityGroups (Optional) A JSON array of security groups to be enabled, each containing `graphId` and `name` properties. .PARAMETER ExcludedSecurityGroups (Optional) A JSON array of security groups to be excluded, each containing `graphId` and `name` properties. .EXAMPLE Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it. .EXAMPLE Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"}) Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include. .NOTES - Requires `$FabricConfig` global configuration, including `BaseUrl` and `FabricHeaders`. - Calls `Test-TokenExpired` to ensure token validity before making the API request. Author: Tiago Balabuch #> function Update-FabricCapacityTenantSettingOverrides { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string]$TenantSettingName, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [bool]$EnableTenantSetting, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [bool]$DelegateToCapacity, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [bool]$DelegateToDomain, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [bool]$DelegateToWorkspace, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [System.Object]$EnabledSecurityGroups, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [System.Object]$ExcludedSecurityGroups, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [System.Object]$Properties ) try { # Validate authentication token Write-Message -Message "Validating authentication token..." -Level Debug Test-TokenExpired Write-Message -Message "Authentication token is valid." -Level Debug # Validate Security Groups if provided if ($EnabledSecurityGroups) { foreach ($enabledGroup in $EnabledSecurityGroups) { if (-not ($enabledGroup.PSObject.Properties.Name -contains 'graphId' -and $enabledGroup.PSObject.Properties.Name -contains 'name')) { throw "Each enabled security group must contain 'graphId' and 'name' properties." } } } if ($ExcludedSecurityGroups) { foreach ($excludedGroup in $ExcludedSecurityGroups) { if (-not ($excludedGroup.PSObject.Properties.Name -contains 'graphId' -and $excludedGroup.PSObject.Properties.Name -contains 'name')) { throw "Each excluded security group must contain 'graphId' and 'name' properties." } } } # Validate Security Groups if provided if ($Properties) { foreach ($property in $Properties) { if (-not ($property.PSObject.Properties.Name -contains 'name' -and $property.PSObject.Properties.Name -contains 'type' -and $property.PSObject.Properties.Name -contains 'value')) { throw "Each property object must include 'name', 'type', and 'value' properties to be valid." } } } # Construct API endpoint URL $apiEndpointURI = "{0}/admin/tenantsettings/{1}/update" -f $FabricConfig.BaseUrl, $TenantSettingName Write-Message -Message "Constructed API Endpoint: $apiEndpointURI" -Level Debug # Construct request body $body = @{ EnableTenantSetting = $EnableTenantSetting } if ($DelegateToCapacity) { $body.delegateToCapacity = $DelegateToCapacity } if ($DelegateToDomain) { $body.delegateToDomain = $DelegateToDomain } if ($DelegateToWorkspace) { $body.delegateToWorkspace = $DelegateToWorkspace } if ($EnabledSecurityGroups) { $body.enabledSecurityGroups = $EnabledSecurityGroups } if ($ExcludedSecurityGroups) { $body.excludedSecurityGroups = $ExcludedSecurityGroups } if ($Properties) { $body.properties = $Properties } # Convert body to JSON $bodyJson = $body | ConvertTo-Json -Depth 5 Write-Message -Message "Request Body: $bodyJson" -Level Debug # Invoke Fabric API request $response = Invoke-FabricAPIRequest ` -BaseURI $apiEndpointURI ` -Headers $FabricConfig.FabricHeaders ` -Method Post ` -Body $bodyJson Write-Message -Message "Successfully updated tenant setting." -Level Info return $response } catch { $errorDetails = $_.Exception.Message Write-Message -Message "Error updating tenant settings: $errorDetails" -Level Error } } |