Tenants - List Capacities Tenant Settings Overrides

Service:

Admin

API Version:

v1

Напомена

This API is in preview.

Returns list of tenant setting overrides that override at the capacities.

This API supports pagination. A maximum of 10,000 records can be returned per request. With the continuation token provided in the response, you can get the next 10,000 records.

The user must be a Fabric Service Administrator or authenticate using a service principal.

Required Delegated Scopes

Tenant.Read.All or 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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/capacities/delegatedTenantSettingOverrides

With optional parameters:

HTTP

GET https://api.fabric.microsoft.com/v1/admin/capacities/delegatedTenantSettingOverrides?continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
continuationToken	query		string	A token for retrieving the next page of results.

Responses

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

Examples

List capacities tenant settings overrides example

Sample request

HTTP

HTTP

GET https://api.fabric.microsoft.com/v1/admin/capacities/delegatedTenantSettingOverrides

Sample response

Status code:

200

JSON

{
  "value": [
    {
      "id": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
      "tenantSettings": [
        {
          "settingName": "TenantSettingForCapacityDelegatedSwitch",
          "title": "Capacity delegation test settings",
          "enabled": true,
          "canSpecifySecurityGroups": true,
          "enabledSecurityGroups": [
            {
              "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
              "name": "TestComputeCdsa"
            },
            {
              "graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
              "name": "TestComputeGroup2"
            },
            {
              "graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
              "name": "TestCertifiers"
            }
          ],
          "tenantSettingGroup": "Delegation testing",
          "properties": [
            {
              "name": "testIntProp",
              "value": "5",
              "type": "Integer"
            }
          ],
          "delegateToWorkspace": false,
          "delegatedFrom": "Tenant"
        }
      ]
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/capacities/delegatedTenantSettingOverrides?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Definitions

Name	Description
CapacityTenantSetting	Capacity tenant setting details.
CapacityTenantSettingOverride	A capacity admin can override the tenant setting.
CapacityTenantSettingOverrides	A list of tenant settings overrides.
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.

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.

CapacityTenantSettingOverride

Object

A capacity admin can override the tenant setting.

Name	Type	Description
id	string	The ID of a capacity.
tenantSettings	CapacityTenantSetting[]	A list of capacity tenant settings.

CapacityTenantSettingOverrides

Object

A list of tenant settings overrides.

Name	Type	Description
continuationToken	string	The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri	string	The URI of the next result set batch. If there are no more records, it's removed from the response.
value	CapacityTenantSettingOverride[]	A list of tenant settings that were overridden by capacity admin.

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
Capacity	The setting is delegated from a capacity.
Domain	The setting is delegated from a domain.
Tenant	The setting is delegated from a tenant.

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
Boolean	A checkbox in the UI.
FreeText	UI accepts any string for the text box.
Integer	UI accepts only integers for the text box.
MailEnabledSecurityGroup	UI accepts only email enabled security groups for the text box.
Url	UI accepts only URLs 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.