Tenants - List Tenant Settings

Service:: Admin

API-versie:: v1

Retourneert een lijst met de tenantinstellingen.

Machtigingen

De aanroeper moet een Fabric-beheerder zijn of verifiëren met behulp van een service-principal.

Vereiste gedelegeerde bereiken

Tenant.Read.All of Tenant.ReadWrite.All

Beperkingen

Maximaal 25 aanvragen per minuut.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
continuationToken	query		string	Een token voor het ophalen van de volgende pagina met resultaten.

Antwoorden

Name	Type	Description
200 OK	TenantSettings	OK. De bewerking is geslaagd.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: Verboden: de aanroeper heeft geen machtigingen om de API aan te roepen.

Name

Type

Description

200 OK

TenantSettings

OK. De bewerking is geslaagd.

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

Verboden: de aanroeper heeft geen machtigingen om de API aan te roepen.

Voorbeelden

List tenant settings example

Voorbeeldaanvraag

HTTP

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "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"
    }
  ]
}

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
TenantSetting	Details van instelling op tenantniveau.
TenantSettingProperty	Tenantinstellingseigenschap.
TenantSettingPropertyType	Eigenschapstype tenantinstelling. Er kunnen in de loop van de tijd extra typen eigenschappen voor tenantinstellingen worden toegevoegd.
TenantSettings	Een lijst met tenantinstellingen.
TenantSettingSecurityGroup	Beveiligingsgroep voor tenantinstellingen.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

TenantSetting

Object

Details van instelling op tenantniveau.

Name	Type	Description
canSpecifySecurityGroups	boolean	Geeft aan of de tenantinstelling is ingeschakeld voor een beveiligingsgroep. Onwaar: de tenantinstelling is ingeschakeld voor de hele organisatie. Waar: de tenantinstelling is ingeschakeld voor beveiligingsgroepen.
delegateToCapacity	boolean	Hiermee wordt aangegeven of de tenantinstelling kan worden gedelegeerd aan een capaciteitsbeheerder. Onwaar: capaciteitsbeheerder kan de tenantinstelling niet overschrijven. Waar: capaciteitsbeheerder kan de tenantinstelling overschrijven.
delegateToDomain	boolean	Hiermee wordt aangegeven of de tenantinstelling kan worden gedelegeerd aan een domeinbeheerder. Onwaar- Domeinbeheerder kan de tenantinstelling niet overschrijven. Waar: domeinbeheerder kan de tenantinstelling overschrijven.
delegateToWorkspace	boolean	Hiermee wordt aangegeven of de tenantinstelling kan worden gedelegeerd aan een werkruimtebeheerder. Onwaar- Werkruimtebeheerder kan de tenantinstelling niet overschrijven. Waar: werkruimtebeheerder kan de tenantinstelling overschrijven.
enabled	boolean	De status van de tenantinstelling. False - Disabled, True - Enabled.
enabledSecurityGroups	TenantSettingSecurityGroup[]	Een lijst met ingeschakelde beveiligingsgroepen.
excludedSecurityGroups	TenantSettingSecurityGroup[]	Een lijst met uitgesloten beveiligingsgroepen.
properties	TenantSettingProperty[]	Eigenschappen van tenantinstellingen.
settingName	string	De naam van de tenantinstelling.
tenantSettingGroup	string	Naam van de tenantinstellingsgroep.
title	string	De titel van de tenantinstelling.

TenantSettingProperty

Object

Tenantinstellingseigenschap.

Name	Type	Description
name	string	De naam van de eigenschap.
type	TenantSettingPropertyType	Het type eigendom.
value	string	De waarde van de eigenschap.

TenantSettingPropertyType

Inventarisatie

Eigenschapstype tenantinstelling. Er kunnen in de loop van de tijd extra typen eigenschappen voor tenantinstellingen worden toegevoegd.

Waarde	Description
FreeText	De gebruikersinterface accepteert een tekenreeks voor het tekstvak.
Url	De gebruikersinterface accepteert alleen URL's voor het tekstvak.
Boolean	Een selectievakje in de gebruikersinterface.
MailEnabledSecurityGroup	De gebruikersinterface accepteert alleen beveiligingsgroepen waarvoor e-mail is ingeschakeld voor het tekstvak.
Integer	De gebruikersinterface accepteert alleen gehele getallen voor het tekstvak.

TenantSettings

Object

Een lijst met tenantinstellingen.

Name	Type	Description
continuationToken	string	Het token voor de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
continuationUri	string	De URI van de volgende batch met resultatensets. Als er geen records meer zijn, wordt deze verwijderd uit het antwoord.
value	TenantSetting[]	Een lijst met tenantinstellingen.

TenantSettingSecurityGroup

Object

Beveiligingsgroep voor tenantinstellingen.

Name	Type	Description
graphId	string	De grafiek-id van de beveiligingsgroep.
name	string	De naam van de beveiligingsgroep.

Delen via

Tenants - List Tenant Settings

Machtigingen

Vereiste gedelegeerde bereiken

Beperkingen

Door Microsoft Entra ondersteunde identiteiten

gebruikersinterface

URI-parameters

Antwoorden

Voorbeelden

List tenant settings example

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

TenantSetting

TenantSettingProperty

TenantSettingPropertyType

TenantSettings

TenantSettingSecurityGroup