Tenants - List Tenant Settings

Služba:: Admin

Verzia rozhrania API:: v1

Vráti zoznam nastavení nájomníka.

Povolenia

Volajúci musí byť správcom služby Fabric alebo ho overovať pomocou objektu služby.

Povinné delegované rozsahy

Tenant.Read.All alebo Tenant.ReadWrite.All

Limitations

Maximálne 25 žiadostí za minútu.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

S voliteľnými parametrami:

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

Parametre URI

Name	V	Povinné	Typ	Description
continuationToken	query		string	Token na načítanie ďalšej stránky výsledkov.

Odpovede

Name	Typ	Description
200 OK	TenantSettings	OK. Operácia bola úspešná.
Other Status Codes	ErrorResponse	Bežné kódy chýb: Zakázané – volajúci nemá povolenia na volanie rozhrania API.

Name

Typ

Description

200 OK

TenantSettings

OK. Operácia bola úspešná.

Other Status Codes

ErrorResponse

Bežné kódy chýb:

Zakázané – volajúci nemá povolenia na volanie rozhrania API.

Príklady

List tenant settings example

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 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"
    }
  ]
}

Definície

Name	Description
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
TenantSetting	Podrobnosti nastavenia na úrovni nájomníka.
TenantSettingProperty	Vlastnosť nastavenia nájomníka.
TenantSettingPropertyType	Typ vlastnosti nastavenia nájomníka. V priebehu času je možné pridať ďalšie typy vlastností nastavenia nájomníka.
TenantSettings	Zoznam nastavení nájomníka.
TenantSettingSecurityGroup	Skupina zabezpečenia nastavenia nájomníka.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

TenantSetting

Object

Podrobnosti nastavenia na úrovni nájomníka.

Name	Typ	Description
canSpecifySecurityGroups	boolean	Udáva, či je nastavenie nájomníka povolené pre skupinu zabezpečenia. False – nastavenie nájomníka je povolené pre celú organizáciu. Pravda – nastavenie nájomníka je povolené pre skupiny zabezpečenia.
delegateToCapacity	boolean	Udáva, či nastavenie nájomníka je možné delegovať na správcu kapacity. False – správca kapacity nemôže prepísať nastavenie nájomníka. Pravda – správca kapacity môže prepísať nastavenie nájomníka.
delegateToDomain	boolean	Udáva, či nastavenie nájomníka je možné delegovať na správcu domény. False – správca domény nemôže prepísať nastavenie nájomníka. Pravda – správca domény môže prepísať nastavenie nájomníka.
delegateToWorkspace	boolean	Udáva, či nastavenie nájomníka je možné delegovať na správcu pracovného priestoru. False – správca pracovného priestoru nemôže prepísať nastavenie nájomníka. Pravda – správca pracovného priestoru môže prepísať nastavenie nájomníka.
enabled	boolean	Stav nastavenia nájomníka. False – Disabled, True – Enabled.
enabledSecurityGroups	TenantSettingSecurityGroup[]	Zoznam povolených skupín zabezpečenia.
excludedSecurityGroups	TenantSettingSecurityGroup[]	Zoznam vylúčených skupín zabezpečenia.
properties	TenantSettingProperty[]	Vlastnosti nastavenia nájomníka.
settingName	string	Názov nastavenia nájomníka.
tenantSettingGroup	string	Názov skupiny nastavení nájomníka.
title	string	Názov nastavenia nájomníka.

TenantSettingProperty

Object

Vlastnosť nastavenia nájomníka.

Name	Typ	Description
name	string	Názov vlastnosti.
type	TenantSettingPropertyType	Typ vlastnosti.
value	string	Hodnota vlastnosti .

TenantSettingPropertyType

Enumerácia

Typ vlastnosti nastavenia nájomníka. V priebehu času je možné pridať ďalšie typy vlastností nastavenia nájomníka.

Hodnota	Description
FreeText	Používateľské rozhranie prijíma pre textové pole ľubovoľný reťazec.
Url	Používateľské rozhranie prijíma pre textové pole iba URL adresy.
Boolean	Začiarkavacie políčko v používateľskom rozhraní.
MailEnabledSecurityGroup	Používateľské rozhranie prijíma pre textové pole iba skupiny zabezpečenia s podporou e-mailu.
Integer	Používateľské rozhranie prijíma pre textové pole iba celé čísla.

TenantSettings

Object

Zoznam nastavení nájomníka.

Name	Typ	Description
continuationToken	string	Token pre ďalšiu dávku množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
continuationUri	string	Identifikátor URI ďalšej série množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
value	TenantSetting[]	Zoznam nastavení nájomníka.

TenantSettingSecurityGroup

Object

Skupina zabezpečenia nastavenia nájomníka.

Name	Typ	Description
graphId	string	ID grafu skupiny zabezpečenia.
name	string	Názov skupiny zabezpečenia.

Zdieľať cez

Tenants - List Tenant Settings

Povolenia

Povinné delegované rozsahy

Limitations

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Odpovede

Príklady

List tenant settings example

Vzorová požiadavka

Vzorová odpoveď

Definície

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

TenantSetting

TenantSettingProperty

TenantSettingPropertyType

TenantSettings

TenantSettingSecurityGroup