Tenants - List Workspaces Tenant Settings Overrides

Service:

Admin

API-versie:

v1

Notitie

Deze API is in preview.

Retourneert een lijst met onderdrukkingen voor delegering van werkruimten.

Deze API ondersteunt paginering. Er kunnen maximaal 10.000 records per aanvraag worden geretourneerd. Met het vervolgtoken in het antwoord kunt u de volgende 10.000 records ophalen.

De gebruiker moet een Fabric-servicebeheerder 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 vermeld in deze sectie.

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

Interface

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

Met optionele parameters:

GET https://api.fabric.microsoft.com/v1/admin/workspaces/delegatedTenantSettingOverrides?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	WorkspaceTenantSettingOverrides	De bewerking is geslaagd.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: Verboden: de aanroeper heeft geen machtigingen om de API aan te roepen.

Voorbeelden

List workspace tenant settings overrides example

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "id": "f51b705f-a409-4d40-9197-c5d5f349e2ef",
      "tenantSettings": [
        {
          "settingName": "TenantSettingForWorkspaceDelegatedSwitch",
          "title": "Workspace delegation test settings",
          "enabled": true,
          "canSpecifySecurityGroups": true,
          "enabledSecurityGroups": [
            {
              "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
              "name": "Admin API SP Test"
            },
            {
              "graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
              "name": "Admin API Testing"
            },
            {
              "graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
              "name": "Admin Only"
            }
          ],
          "tenantSettingGroup": "Delegation testing",
          "delegatedFrom": "Tenant"
        }
      ]
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces/delegatedTenantSettingOverrides?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Definities

Name	Description
DelegatedFrom	Het Fabric-onderdeel (werkruimte, capaciteit of domein) waaruit de tenantinstelling is gedelegeerd. Er kunnen na verloop van tijd extra DelegatedFrom worden toegevoegd.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
TenantSettingProperty	Tenantinstellingseigenschap.
TenantSettingPropertyType	Eigenschapstype tenantinstelling. Er kunnen in de loop van de tijd extra typen eigenschappen voor tenantinstellingen worden toegevoegd.
TenantSettingSecurityGroup	Beveiligingsgroep voor tenantinstellingen.
WorkspaceTenantSetting	Details van de tenantinstelling voor de werkruimte.
WorkspaceTenantSettingOverride	Een workspaceadmin kan de tenantinstelling overschrijven.
WorkspaceTenantSettingOverrides	Een lijst met tenantinstellingen overschrijft.

DelegatedFrom

Inventarisatie

Het Fabric-onderdeel (werkruimte, capaciteit of domein) waaruit de tenantinstelling is gedelegeerd. Er kunnen na verloop van tijd extra DelegatedFrom worden toegevoegd.

Waarde	Description
Capacity	De instelling wordt gedelegeerd vanuit een capaciteit.
Domain	De instelling wordt gedelegeerd vanuit een domein.
Tenant	De instelling wordt gedelegeerd vanuit een tenant.

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.

TenantSettingProperty

Object

Tenantinstellingseigenschap.

Name	Type	Description
name	string	De naam van de eigenschap.
type	TenantSettingPropertyType	Het type eigenschap.
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
Boolean	Een selectievakje in de gebruikersinterface.
FreeText	De gebruikersinterface accepteert een tekenreeks voor het tekstvak.
Integer	De gebruikersinterface accepteert alleen gehele getallen voor het tekstvak.
MailEnabledSecurityGroup	De gebruikersinterface accepteert alleen beveiligingsgroepen waarvoor e-mail is ingeschakeld voor het tekstvak.
Url	De gebruikersinterface accepteert alleen URL's voor het tekstvak.

TenantSettingSecurityGroup

Object

Beveiligingsgroep voor tenantinstellingen.

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

WorkspaceTenantSetting

Object

Details van de tenantinstelling voor de werkruimte.

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.
delegatedFrom	DelegatedFrom	Tenantinstelling die is gedelegeerd vanuit tenant, capaciteit of domein.
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.

WorkspaceTenantSettingOverride

Object

Een workspaceadmin kan de tenantinstelling overschrijven.

Name	Type	Description
id	string uuid	De id van een werkruimte.
tenantSettings	WorkspaceTenantSetting[]	Een lijst met tenantinstellingen voor werkruimten.

WorkspaceTenantSettingOverrides

Object

Een lijst met tenantinstellingen overschrijft.

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	WorkspaceTenantSettingOverride[]	Een lijst met tenantinstellingen die zijn overschreven door een werkruimtebeheerder.