Tenants - Update Tenant Setting

Tjänst:
Admin
API-version:
v1

Uppdatera en viss klientinställning.

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.

Permissions

Anroparen måste vara infrastrukturadministratör eller autentisera med hjälp av tjänstens huvudnamn.

Obligatoriska delegerade omfång

Tenant.ReadWrite.All

Limitations

Maximalt 25 begäranden per minut.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity Support
User Yes
Tjänsthuvudnamn och hanterade identiteter Yes

Interface

POST https://api.fabric.microsoft.com/v1/admin/tenantsettings/{tenantSettingName}/update

URI-parametrar

Name I Obligatorisk Typ Description
tenantSettingName
 path True

string

Namnet på klientinställningen.

Begärandetext

Name Obligatorisk Typ Description
enabled True

boolean

Status för klientinställningen. Falskt – inaktiverat, sant – aktiverat.
delegateToCapacity

boolean

Anger om klientinställningen kan delegeras till en kapacitetsadministratör. Falskt – Kapacitetsadministratören kan inte åsidosätta klientinställningen. Sant – Kapacitetsadministratören kan åsidosätta klientinställningen.
delegateToDomain

boolean

Anger om klientinställningen kan delegeras till en domänadministratör. Falskt – Domänadministratören kan inte åsidosätta klientinställningen. Sant – Domänadministratören kan åsidosätta klientinställningen.
delegateToWorkspace

boolean

Anger om klientinställningen kan delegeras till en arbetsyteadministratör. Falskt – Arbetsyteadministratören kan inte åsidosätta klientinställningen. Sant – Arbetsyteadministratören kan åsidosätta klientinställningen.
enabledSecurityGroups

TenantSettingSecurityGroup[]

En lista över aktiverade säkerhetsgrupper.
excludedSecurityGroups

TenantSettingSecurityGroup[]

En lista över undantagna säkerhetsgrupper.
properties

TenantSettingProperty[]

Egenskaper för klientinställning.

Svar

Name Typ Description
200 OK

UpdateTenantSettingResponse

OK. Åtgärden lyckades.
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • Förbjudet – anroparen har inte behörighet att anropa API:et.

Exempel

Update tenant setting example

Exempelbegäran

POST https://api.fabric.microsoft.com/v1/admin/tenantsettings/PublishToWeb/update

{
  "enabled": true,
  "enabledSecurityGroups": [
    {
      "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
      "name": "TestComputeCdsa"
    }
  ],
  "properties": [
    {
      "name": "CreateP2w",
      "value": "true",
      "type": "Boolean"
    }
  ]
}

Exempelsvar

Statuskod:
200 
{
  "tenantSettings": [
    {
      "settingName": "PublishToWeb",
      "title": "Sample test tenant setting",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "enabledSecurityGroups": [
        {
          "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
          "name": "TestComputeCdsa"
        }
      ],
      "properties": [
        {
          "name": "CreateP2w",
          "value": "true",
          "type": "Boolean"
        }
      ],
      "tenantSettingGroup": "TestSetting"
    }
  ]
}

Definitioner

Name Description
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
TenantSetting

Information om inställning på klientnivå.
TenantSettingProperty

Egenskap för klientinställning.
TenantSettingPropertyType

Egenskapstyp för klientinställning. Ytterligare egenskapstyper för klientinställning kan läggas till över tid.
TenantSettingSecurityGroup

Säkerhetsgrupp för klientinställning.
UpdateTenantSettingRequest

Uppdateringsbegäran för klientinställning.
UpdateTenantSettingResponse

Uppdateringssvar för klientinställning.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

TenantSetting

Objekt

Information om inställning på klientnivå.

Name Typ Description
canSpecifySecurityGroups

boolean

Anger om klientinställningen är aktiverad för en säkerhetsgrupp. False – klientinställningen är aktiverad för hela organisationen. Sant – klientinställningen är aktiverad för säkerhetsgrupper.
delegateToCapacity

boolean

Anger om klientinställningen kan delegeras till en kapacitetsadministratör. Falskt – Kapacitetsadministratören kan inte åsidosätta klientinställningen. Sant – Kapacitetsadministratören kan åsidosätta klientinställningen.
delegateToDomain

boolean

Anger om klientinställningen kan delegeras till en domänadministratör. Falskt – Domänadministratören kan inte åsidosätta klientinställningen. Sant – Domänadministratören kan åsidosätta klientinställningen.
delegateToWorkspace

boolean

Anger om klientinställningen kan delegeras till en arbetsyteadministratör. Falskt – Arbetsyteadministratören kan inte åsidosätta klientinställningen. Sant – Arbetsyteadministratören kan åsidosätta klientinställningen.
enabled

boolean

Status för klientinställningen. Falskt – inaktiverat, sant – aktiverat.
enabledSecurityGroups

TenantSettingSecurityGroup[]

En lista över aktiverade säkerhetsgrupper.
excludedSecurityGroups

TenantSettingSecurityGroup[]

En lista över undantagna säkerhetsgrupper.
properties

TenantSettingProperty[]

Egenskaper för klientinställning.
settingName

string

Namnet på klientinställningen.
tenantSettingGroup

string

Namn på klientinställningsgrupp.
title

string

Klientinställningens rubrik.

TenantSettingProperty

Objekt

Egenskap för klientinställning.

Name Typ Description
name

string

Namnet på egenskapen.
type

TenantSettingPropertyType

Egenskapens typ.
value

string

Värdet för egenskapen.

TenantSettingPropertyType

Uppräkning

Egenskapstyp för klientinställning. Ytterligare egenskapstyper för klientinställning kan läggas till över tid.

Värde Description
FreeText

Användargränssnittet accepterar alla strängar för textrutan.
Url

Användargränssnittet accepterar endast URL:er för textrutan.
Boolean

En kryssruta i användargränssnittet.
MailEnabledSecurityGroup

Användargränssnittet accepterar endast e-postaktiverade säkerhetsgrupper för textrutan.
Integer

Användargränssnittet accepterar endast heltal för textrutan.

TenantSettingSecurityGroup

Objekt

Säkerhetsgrupp för klientinställning.

Name Typ Description
graphId

string

Graf-ID för säkerhetsgruppen.
name

string

Namnet på säkerhetsgruppen.

UpdateTenantSettingRequest

Objekt

Uppdateringsbegäran för klientinställning.

Name Typ Description
delegateToCapacity

boolean

Anger om klientinställningen kan delegeras till en kapacitetsadministratör. Falskt – Kapacitetsadministratören kan inte åsidosätta klientinställningen. Sant – Kapacitetsadministratören kan åsidosätta klientinställningen.
delegateToDomain

boolean

Anger om klientinställningen kan delegeras till en domänadministratör. Falskt – Domänadministratören kan inte åsidosätta klientinställningen. Sant – Domänadministratören kan åsidosätta klientinställningen.
delegateToWorkspace

boolean

Anger om klientinställningen kan delegeras till en arbetsyteadministratör. Falskt – Arbetsyteadministratören kan inte åsidosätta klientinställningen. Sant – Arbetsyteadministratören kan åsidosätta klientinställningen.
enabled

boolean

Status för klientinställningen. Falskt – inaktiverat, sant – aktiverat.
enabledSecurityGroups

TenantSettingSecurityGroup[]

En lista över aktiverade säkerhetsgrupper.
excludedSecurityGroups

TenantSettingSecurityGroup[]

En lista över undantagna säkerhetsgrupper.
properties

TenantSettingProperty[]

Egenskaper för klientinställning.

UpdateTenantSettingResponse

Objekt

Uppdateringssvar för klientinställning.

Name Typ Description
tenantSettings

TenantSetting[]

En lista över klientinställningar som har uppdaterats.