Tenants - List Tenant Settings
Returns a list of the tenant settings.
The caller must be a Fabric administrator or authenticate using a service principal.
Tenant.Read.All or Tenant.ReadWrite.All
Maximum 200 requests per hour.
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal | Yes |
Managed identities | Yes |
GET https://api.fabric.microsoft.com/v1/admin/tenantsettings
Name | Type | Description |
---|---|---|
200 OK |
OK. The operation was successful. |
|
Other Status Codes |
Common error codes:
|
Sample request
GET https://api.fabric.microsoft.com/v1/admin/tenantsettings
Sample response
{
"tenantSettings": [
{
"settingName": "AdminApisIncludeDetailedMetadata",
"title": "Enhance admin APIs responses with detailed metadata",
"enabled": true,
"canSpecifySecurityGroups": true,
"tenantSettingGroup": "AdminApiSettings"
},
{
"settingName": "DatamartTenant",
"title": "Create Datamarts (Preview)",
"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": "DatamartSettings"
},
{
"settingName": "CertifyDatasets",
"title": "Certification",
"enabled": true,
"canSpecifySecurityGroups": true,
"tenantSettingGroup": "ExportAndSharing"
}
]
}
Name | Description |
---|---|
Delegated |
The Fabric component (workspace, capacity or domain) that the tenant setting was delegated from. Additional |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Tenant |
Tenant setting details. |
Tenant |
Tenant setting property. |
Tenant |
Tenant setting property type. Additional tenant setting property types may be added over time. |
Tenant |
A list of tenant settings. |
Tenant |
Tenant setting security group. |
The Fabric component (workspace, capacity or domain) that the tenant setting was delegated from. Additional DelegatedFrom
may be added over time.
Name | Type | Description |
---|---|---|
Capacity |
string |
The setting is delegated from a capacity. |
Domain |
string |
The setting is delegated from a domain. |
Tenant |
string |
The setting is delegated from a tenant. |
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. |
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 |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
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 |
The error related resource details. |
Tenant setting details.
Name | Type | Description |
---|---|---|
canSpecifySecurityGroups |
boolean |
Indicates if the tenant setting is enabled for a security group. 0 - The tenant setting is enabled for the entire organization. 1 - 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 |
Tenant setting delegated from tenant, capacity or domain. |
|
enabled |
boolean |
The status of the tenant setting. 0 - Disabled, 1- Enabled. |
enabledSecurityGroups |
A list of enabled security groups. |
|
excludedSecurityGroups |
A list of excluded security groups. |
|
properties |
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. |
Tenant setting property.
Name | Type | Description |
---|---|---|
name |
string |
The name of the property. |
type |
The type of the property. |
|
value |
string |
The value of the property. |
Tenant setting property type. Additional tenant setting property types may be added over time.
Name | Type | Description |
---|---|---|
Boolean |
string |
A checkbox in the UI. |
FreeText |
string |
UI accepts any string for the text box. |
Integer |
string |
UI accepts only integers for the text box. |
MailEnabledSecurityGroup |
string |
UI accepts only email enabled security groups for the text box. |
Url |
string |
UI accepts only URLs for the text box. |
A list of tenant settings.
Name | Type | Description |
---|---|---|
tenantSettings |
A list of tenant settings. |
Tenant setting security group.
Name | Type | Description |
---|---|---|
graphId |
string |
The graph ID of the security group. |
name |
string |
The name of the security group. |