Tenants - Update Tenant Setting

Tjeneste:
Admin
API-version:
v1

Opdater en given lejerindstilling.

Permissions

Den, der ringer op, skal være Fabric-administrator eller godkende ved hjælp af en tjenesteprincipal.

Påkrævede delegerede områder

Tenant.ReadWrite.All

Limitations

Maksimalt 25 anmodninger pr. minut.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity Support
User Yes
tjenesteprincipal og administrerede identiteter Yes

Interface

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

URI-parametre

Navn I Påkrævet Type Beskrivelse
tenantSettingName
 path True

string

Navnet på lejerindstillingen.

Brødtekst for anmodning

Navn Påkrævet Type Beskrivelse
enabled True

boolean

Status for lejerindstillingen. False – Deaktiveret, Sand – Aktiveret.
delegateToCapacity

boolean

Angiver, om lejerindstillingen kan delegeres til en kapacitetsadministrator. Falsk – Kapacitetsadministrator kan ikke tilsidesætte lejerindstillingen. Sand – Kapacitetsadministratoren kan tilsidesætte lejerindstillingen.
delegateToDomain

boolean

Angiver, om lejerindstillingen kan delegeres til en domæneadministrator. Falsk – Domæneadministratoren kan ikke tilsidesætte lejerindstillingen. True – Domæneadministratoren kan tilsidesætte lejerindstillingen.
delegateToWorkspace

boolean

Angiver, om lejerindstillingen kan delegeres til en arbejdsområdeadministrator. Falsk – Arbejdsområdeadministrator kan ikke tilsidesætte lejerindstillingen. Sand – Arbejdsområdeadministratoren kan tilsidesætte lejerindstillingen.
enabledSecurityGroups

TenantSettingSecurityGroup[]

En liste over aktiverede sikkerhedsgrupper.
excludedSecurityGroups

TenantSettingSecurityGroup[]

En liste over udeladte sikkerhedsgrupper.
properties

TenantSettingProperty[]

Egenskaber for lejerindstilling.

Svar

Navn Type Beskrivelse
200 OK

UpdateTenantSettingResponse

OK. Handlingen blev udført.
429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • Forbudt – Kalderen har ikke tilladelse til at kalde API'en.

Eksempler

Update tenant setting example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
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

Navn Beskrivelse
ErrorParameter

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
TenantSetting

Oplysninger om indstilling af lejerniveau.
TenantSettingProperty

Lejerindstillingsegenskab.
TenantSettingPropertyType

Egenskabstype for lejerindstilling. Der kan tilføjes flere egenskabstyper for lejerindstillinger over tid.
TenantSettingSecurityGroup

Lejerindstillingssikkerhedsgruppe.
UpdateTenantSettingRequest

Anmodning om opdatering af lejerindstilling.
UpdateTenantSettingResponse

Opdateringssvar for lejerindstilling.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn Type Beskrivelse
message

string

En læsevenlig beskrivelse af parameterens betydning.
name

string

Parameter-id'et.
value

string

Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable

boolean

Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
parameters

ErrorParameter[]

Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

TenantSetting

Objekt

Oplysninger om indstilling af lejerniveau.

Navn Type Beskrivelse
canSpecifySecurityGroups

boolean

Angiver, om lejerindstillingen er aktiveret for en sikkerhedsgruppe. False – lejerindstillingen er aktiveret for hele organisationen. Sand – lejerindstillingen er aktiveret for sikkerhedsgrupper.
delegateToCapacity

boolean

Angiver, om lejerindstillingen kan delegeres til en kapacitetsadministrator. Falsk – Kapacitetsadministrator kan ikke tilsidesætte lejerindstillingen. Sand – Kapacitetsadministratoren kan tilsidesætte lejerindstillingen.
delegateToDomain

boolean

Angiver, om lejerindstillingen kan delegeres til en domæneadministrator. Falsk – Domæneadministratoren kan ikke tilsidesætte lejerindstillingen. True – Domæneadministratoren kan tilsidesætte lejerindstillingen.
delegateToWorkspace

boolean

Angiver, om lejerindstillingen kan delegeres til en arbejdsområdeadministrator. Falsk – Arbejdsområdeadministrator kan ikke tilsidesætte lejerindstillingen. Sand – Arbejdsområdeadministratoren kan tilsidesætte lejerindstillingen.
enabled

boolean

Status for lejerindstillingen. False – Deaktiveret, Sand – Aktiveret.
enabledSecurityGroups

TenantSettingSecurityGroup[]

En liste over aktiverede sikkerhedsgrupper.
excludedSecurityGroups

TenantSettingSecurityGroup[]

En liste over udeladte sikkerhedsgrupper.
properties

TenantSettingProperty[]

Egenskaber for lejerindstilling.
settingName

string

Navnet på lejerindstillingen.
tenantSettingGroup

string

Navn på lejerindstillingsgruppe.
title

string

Titlen på lejerindstillingen.

TenantSettingProperty

Objekt

Lejerindstillingsegenskab.

Navn Type Beskrivelse
name

string

Navnet på egenskaben.
type

TenantSettingPropertyType

Egenskabens type.
value

string

Værdien af egenskaben.

TenantSettingPropertyType

Optælling

Egenskabstype for lejerindstilling. Der kan tilføjes flere egenskabstyper for lejerindstillinger over tid.

Værdi Beskrivelse
FreeText

Brugergrænsefladen accepterer en hvilken som helst streng til tekstfeltet.
Url

Brugergrænsefladen accepterer kun URL-adresser til tekstfeltet.
Boolean

Et afkrydsningsfelt i brugergrænsefladen.
MailEnabledSecurityGroup

Brugergrænsefladen accepterer kun mailaktiveret sikkerhedsgrupper for tekstfeltet.
Integer

Brugergrænsefladen accepterer kun heltal for tekstfeltet.

TenantSettingSecurityGroup

Objekt

Lejerindstillingssikkerhedsgruppe.

Navn Type Beskrivelse
graphId

string

Graf-id'et for sikkerhedsgruppen.
name

string

Navnet på sikkerhedsgruppen.

UpdateTenantSettingRequest

Objekt

Anmodning om opdatering af lejerindstilling.

Navn Type Beskrivelse
delegateToCapacity

boolean

Angiver, om lejerindstillingen kan delegeres til en kapacitetsadministrator. Falsk – Kapacitetsadministrator kan ikke tilsidesætte lejerindstillingen. Sand – Kapacitetsadministratoren kan tilsidesætte lejerindstillingen.
delegateToDomain

boolean

Angiver, om lejerindstillingen kan delegeres til en domæneadministrator. Falsk – Domæneadministratoren kan ikke tilsidesætte lejerindstillingen. True – Domæneadministratoren kan tilsidesætte lejerindstillingen.
delegateToWorkspace

boolean

Angiver, om lejerindstillingen kan delegeres til en arbejdsområdeadministrator. Falsk – Arbejdsområdeadministrator kan ikke tilsidesætte lejerindstillingen. Sand – Arbejdsområdeadministratoren kan tilsidesætte lejerindstillingen.
enabled

boolean

Status for lejerindstillingen. False – Deaktiveret, Sand – Aktiveret.
enabledSecurityGroups

TenantSettingSecurityGroup[]

En liste over aktiverede sikkerhedsgrupper.
excludedSecurityGroups

TenantSettingSecurityGroup[]

En liste over udeladte sikkerhedsgrupper.
properties

TenantSettingProperty[]

Egenskaber for lejerindstilling.

UpdateTenantSettingResponse

Objekt

Opdateringssvar for lejerindstilling.

Navn Type Beskrivelse
tenantSettings

TenantSetting[]

En liste over lejerindstillinger, der blev opdateret.