Freigeben über

Tenants - List Tenant Settings

Dienst:
Admin
API-Version:
v1

Gibt eine Liste der Mandanteneinstellungen zurück.

Erlaubnisse

Der Aufrufer muss ein Fabric-Administrator sein oder sich mit einem Dienstprinzipal authentifizieren.

Erforderliche delegierte Bereiche

Tenant.Read.All oder Tenant.ReadWrite.All

Einschränkungen

Maximal 25 Anforderungen pro Minute.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützung
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
continuationToken
 query

string

Ein Token zum Abrufen der nächsten Seite mit Ergebnissen.

Antworten

Name Typ Beschreibung
200 OK

TenantSettings

OKAY. Der Vorgang war erfolgreich.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • Verboten – Der Aufrufer verfügt nicht über Berechtigungen zum Aufrufen der API.

Beispiele

List tenant settings example

Beispielanforderung

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

Beispiel für eine Antwort

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"
    }
  ]
}

Definitionen

Name Beschreibung
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
TenantSetting

Details zur Einstellung auf Mandantenebene.
TenantSettingProperty

Mandanteneinstellungseigenschaft.
TenantSettingPropertyType

Eigenschaftentyp der Mandanteneinstellung. Zusätzliche Mandanteneinstellungseigenschaftentypen können im Laufe der Zeit hinzugefügt werden.
TenantSettings

Eine Liste der Mandanteneinstellungen.
TenantSettingSecurityGroup

Sicherheitsgruppe für Mandanteneinstellung.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

TenantSetting

Objekt

Details zur Einstellung auf Mandantenebene.

Name Typ Beschreibung
canSpecifySecurityGroups

boolean

Gibt an, ob die Mandanteneinstellung für eine Sicherheitsgruppe aktiviert ist. False – Die Mandanteneinstellung ist für die gesamte Organisation aktiviert. True – Die Mandanteneinstellung ist für Sicherheitsgruppen aktiviert.
delegateToCapacity

boolean

Gibt an, ob die Mandanteneinstellung an einen Kapazitätsadministrator delegiert werden kann. False – Kapazitätsadministrator kann die Mandanteneinstellung nicht außer Kraft setzen. True – Kapazitätsadministrator kann die Mandanteneinstellung außer Kraft setzen.
delegateToDomain

boolean

Gibt an, ob die Mandanteneinstellung an einen Domänenadministrator delegiert werden kann. False – Domänenadministrator kann die Mandanteneinstellung nicht außer Kraft setzen. True – Domänenadministrator kann die Mandanteneinstellung außer Kraft setzen.
delegateToWorkspace

boolean

Gibt an, ob die Mandanteneinstellung an einen Arbeitsbereichsadministrator delegiert werden kann. False – Arbeitsbereichsadministrator kann die Mandanteneinstellung nicht außer Kraft setzen. True – Arbeitsbereichsadministrator kann die Mandanteneinstellung außer Kraft setzen.
enabled

boolean

Der Status der Mandanteneinstellung. False - Disabled, True - Enabled.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Eine Liste der aktivierten Sicherheitsgruppen.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Eine Liste der ausgeschlossenen Sicherheitsgruppen.
properties

TenantSettingProperty[]

Eigenschaften der Mandanteneinstellung.
settingName

string

Der Name der Mandanteneinstellung.
tenantSettingGroup

string

Name der Mandanteneinstellungsgruppe.
title

string

Der Titel der Mandanteneinstellung.

TenantSettingProperty

Objekt

Mandanteneinstellungseigenschaft.

Name Typ Beschreibung
name

string

Der Name der Eigenschaft.
type

TenantSettingPropertyType

Den Typ der Eigenschaft.
value

string

Der Wert der Eigenschaft.

TenantSettingPropertyType

Enumeration

Eigenschaftentyp der Mandanteneinstellung. Zusätzliche Mandanteneinstellungseigenschaftentypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
FreeText

Die Benutzeroberfläche akzeptiert eine beliebige Zeichenfolge für das Textfeld.
Url

Die Benutzeroberfläche akzeptiert nur URLs für das Textfeld.
Boolean

Ein Kontrollkästchen in der Benutzeroberfläche.
MailEnabledSecurityGroup

Die Benutzeroberfläche akzeptiert nur E-Mail-aktivierte Sicherheitsgruppen für das Textfeld.
Integer

Die Benutzeroberfläche akzeptiert nur ganze Zahlen für das Textfeld.

TenantSettings

Objekt

Eine Liste der Mandanteneinstellungen.

Name Typ Beschreibung
continuationToken

string

Das Token für den nächsten Resultsetbatch. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
continuationUri

string

Der URI des nächsten Resultsetbatches. Wenn keine weiteren Datensätze vorhanden sind, wird sie aus der Antwort entfernt.
value

TenantSetting[]

Eine Liste der Mandanteneinstellungen.

TenantSettingSecurityGroup

Objekt

Sicherheitsgruppe für Mandanteneinstellung.

Name Typ Beschreibung
graphId

string

Die Diagramm-ID der Sicherheitsgruppe.
name

string

Der Name der Sicherheitsgruppe.