Tenants - Update Capacity Tenant Setting Override

Service:

Admin

API Version:

v1

Note

This API is in preview.

Update given tenant setting override for given capacity Id.

Permissions

The caller must be a Fabric administrator or authenticate using a service principal.

Required Delegated Scopes

Tenant.ReadWrite.All

Limitations

Maximum 25 requests per minute.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

POST https://api.fabric.microsoft.com/v1/admin/capacities/{capacityId}/delegatedTenantSettingOverrides/{tenantSettingName}/update

URI Parameters

Name	In	Required	Type	Description
capacityId	path	True	string (uuid)	The capacity ID.
tenantSettingName	path	True	string	The name of tenant setting.

Request Body

Name	Required	Type	Description
enabled	True	boolean	The status of the tenant setting. False - Disabled, True - Enabled.
delegateToWorkspace		boolean	Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting.
enabledSecurityGroups		TenantSettingSecurityGroup[]	A list of enabled security groups.
excludedSecurityGroups		TenantSettingSecurityGroup[]	A list of excluded security groups.

Responses

Name	Type	Description
200 OK	UpdateCapacityTenantSettingOverrideResponse	The operation was successful.
Other Status Codes	ErrorResponse	Common error codes: Forbidden - The caller doesn't have permissions to call the API.

Examples

Update capacity tenant setting override example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/admin/capacities/f51b705f-a409-4d40-9197-c5d5f349e2ef/delegatedTenantSettingOverrides/AdminApisIncludeDetailedMetadata/update

{
  "enabled": true,
  "enabledSecurityGroups": [
    {
      "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
      "name": "TestComputeCdsa"
    }
  ],
  "delegateToWorkspace": true
}

Sample response

Status code:

200

{
  "overrides": [
    {
      "settingName": "TenantSettingForCapacityDelegatedSwitch",
      "title": "Capacity delegation test settings",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "enabledSecurityGroups": [
        {
          "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
          "name": "TestComputeCdsa"
        }
      ],
      "tenantSettingGroup": "Delegation testing",
      "properties": [
        {
          "name": "testIntProp",
          "value": "5",
          "type": "Integer"
        }
      ],
      "delegateToWorkspace": true,
      "delegatedFrom": "Tenant"
    }
  ]
}

Definitions

Name	Description
CapacityTenantSetting	Capacity tenant setting details.
DelegatedFrom	The Fabric component (workspace, capacity or domain) that the tenant setting was delegated from. Additional DelegatedFrom may be added over time.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
TenantSettingProperty	Tenant setting property.
TenantSettingPropertyType	Tenant setting property type. Additional tenant setting property types may be added over time.
TenantSettingSecurityGroup	Tenant setting security group.
UpdateCapacityTenantSettingOverrideRequest	Capacity tenant setting override update request.
UpdateCapacityTenantSettingOverrideResponse	Capacity tenant setting override update request.

CapacityTenantSetting

Object

Capacity tenant setting details.

Name	Type	Description
canSpecifySecurityGroups	boolean	Indicates if the tenant setting is enabled for a security group. False - The tenant setting is enabled for the entire organization. True - The tenant setting is enabled for security groups.
delegateToWorkspace	boolean	Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting.
delegatedFrom	DelegatedFrom	Tenant setting delegated from tenant, capacity or domain.
enabled	boolean	The status of the tenant setting. False - Disabled, True - Enabled.
enabledSecurityGroups	TenantSettingSecurityGroup[]	A list of enabled security groups.
excludedSecurityGroups	TenantSettingSecurityGroup[]	A list of excluded security groups.
properties	TenantSettingProperty[]	Tenant setting properties.
settingName	string	The name of the tenant setting.
tenantSettingGroup	string	Tenant setting group name.
title	string	The title of the tenant setting.

DelegatedFrom

Enumeration

The Fabric component (workspace, capacity or domain) that the tenant setting was delegated from. Additional DelegatedFrom may be added over time.

Value	Description
Tenant	The setting is delegated from a tenant.
Capacity	The setting is delegated from a capacity.
Domain	The setting is delegated from a domain.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

TenantSettingProperty

Object

Tenant setting property.

Name	Type	Description
name	string	The name of the property.
type	TenantSettingPropertyType	The type of the property.
value	string	The value of the property.

TenantSettingPropertyType

Enumeration

Tenant setting property type. Additional tenant setting property types may be added over time.

Value	Description
FreeText	UI accepts any string for the text box.
Url	UI accepts only URLs for the text box.
Boolean	A checkbox in the UI.
MailEnabledSecurityGroup	UI accepts only email enabled security groups for the text box.
Integer	UI accepts only integers for the text box.

TenantSettingSecurityGroup

Object

Tenant setting security group.

Name	Type	Description
graphId	string	The graph ID of the security group.
name	string	The name of the security group.

UpdateCapacityTenantSettingOverrideRequest

Object

Capacity tenant setting override update request.

Name	Type	Description
delegateToWorkspace	boolean	Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting.
enabled	boolean	The status of the tenant setting. False - Disabled, True - Enabled.
enabledSecurityGroups	TenantSettingSecurityGroup[]	A list of enabled security groups.
excludedSecurityGroups	TenantSettingSecurityGroup[]	A list of excluded security groups.

UpdateCapacityTenantSettingOverrideResponse

Object

Capacity tenant setting override update request.

Name	Type	Description
overrides	CapacityTenantSetting[]	A list of tenant settings that were updated in given capacity.