Update-FabricCapacityTenantSettingOverrides
Updates tenant setting overrides for a specified capacity ID.
Syntax
Update-FabricCapacityTenantSettingOverrides [-TenantSettingName] <string>
[-EnableTenantSetting] <bool> [[-DelegateToCapacity] <bool>] [[-DelegateToDomain] <bool>]
[[-DelegateToWorkspace] <bool>] [[-EnabledSecurityGroups] <Object>]
[[-ExcludedSecurityGroups] <Object>] [[-Properties] <Object>] [-WhatIf] [-Confirm]
[<CommonParameters>]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.
Examples
Example 1
Updates the tenant setting "SomeSetting" for the capacity with ID "12345" and enables it.
Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true"Example 2
Updates the tenant setting "SomeSetting" for the capacity with ID "12345", enables it, and specifies security groups to include.
Update-FabricCapacityTenantSettingOverrides -CapacityId "12345" -SettingTitle "SomeSetting" -EnableTenantSetting "true" -EnabledSecurityGroups @(@{graphId="1";name="Group1"},@{graphId="2";name="Group2"})Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -EnableTenantSetting | bool | ✓Required | 1 | – | (Mandatory) Indicates whether the tenant setting should be enabled. Default: False |
| -TenantSettingName | string | ✓Required | 0 | – | |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -DelegateToCapacity | bool | 2 | – | Default: False |
|
| -DelegateToDomain | bool | 3 | – | Default: False |
|
| -DelegateToWorkspace | bool | 4 | – | (Optional) Specifies the workspace to which the setting should be delegated. Default: False |
|
| -EnabledSecurityGroups | object | 5 | – | (Optional) A JSON array of security groups to be enabled, each containing |
|
| -ExcludedSecurityGroups | object | 6 | – | (Optional) A JSON array of security groups to be excluded, each containing |
|
| -Properties | object | 7 | – | ||
| -WhatIfalias: wi | switch | Named | – | Runs the command in a mode that only reports what would happen without performing the actions. |
This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.
Notes
Author: Tiago Balabuch, Kamil Nowinski