Tenants - Update Tenant Setting

Usługa:
Admin
Wersja interfejsu API:
v1

Zaktualizuj określone ustawienie dzierżawy.

Permissions

Obiekt wywołujący musi być administratorem sieci szkieletowej lub uwierzytelniać się przy użyciu jednostki usługi.

Wymagane zakresy delegowane

Tenant.ReadWrite.All

Limitations

Maksymalnie 25 żądań na minutę.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
tenantSettingName
 path True

string

Nazwa ustawienia dzierżawy.

Treść żądania

Nazwisko Wymagane Typ Opis
enabled True

boolean

Stan ustawienia dzierżawy. Fałsz — wyłączone, Prawda — włączone.
delegateToCapacity

boolean

Wskazuje, czy ustawienie dzierżawy może być delegowane do administratora pojemności. Fałsz — administrator pojemności nie może zastąpić ustawienia dzierżawy. True — administrator pojemności może zastąpić ustawienie dzierżawy.
delegateToDomain

boolean

Wskazuje, czy ustawienie dzierżawy można delegować do administratora domeny. Fałsz — administrator domeny nie może zastąpić ustawienia dzierżawy. Prawda — administrator domeny może zastąpić ustawienie dzierżawy.
delegateToWorkspace

boolean

Wskazuje, czy ustawienie dzierżawy może być delegowane do administratora obszaru roboczego. Fałsz — administrator obszaru roboczego nie może zastąpić ustawienia dzierżawy. Prawda — administrator obszaru roboczego może zastąpić ustawienie dzierżawy.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Lista grup zabezpieczeń z obsługą.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Lista wykluczonych grup zabezpieczeń.
properties

TenantSettingProperty[]

Właściwości ustawień dzierżawy.

Odpowiedzi

Nazwisko Typ Opis
200 OK

UpdateTenantSettingResponse

OK. Operacja zakończyła się pomyślnie.
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • Zabronione — obiekt wywołujący nie ma uprawnień do wywoływania interfejsu API.

Przykłady

Update tenant setting example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
    }
  ]
}

Definicje

Nazwisko Opis
ErrorParameter

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
TenantSetting

Szczegóły ustawień na poziomie dzierżawy.
TenantSettingProperty

Właściwość ustawienia dzierżawy.
TenantSettingPropertyType

Typ właściwości ustawienia dzierżawy. Dodatkowe typy właściwości ustawień dzierżawy mogą być dodawane w czasie.
TenantSettingSecurityGroup

Ustawienie grupy zabezpieczeń dzierżawy.
UpdateTenantSettingRequest

Żądanie aktualizacji ustawień dzierżawy.
UpdateTenantSettingResponse

Odpowiedź na aktualizację ustawień dzierżawy.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko Typ Opis
message

string

Czytelny dla człowieka opis znaczenia parametru.
name

string

Identyfikator parametru.
value

string

Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

TenantSetting

Objekt

Szczegóły ustawień na poziomie dzierżawy.

Nazwisko Typ Opis
canSpecifySecurityGroups

boolean

Wskazuje, czy ustawienie dzierżawy jest włączone dla grupy zabezpieczeń. Fałsz — ustawienie dzierżawy jest włączone dla całej organizacji. True — ustawienie dzierżawy jest włączone dla grup zabezpieczeń.
delegateToCapacity

boolean

Wskazuje, czy ustawienie dzierżawy może być delegowane do administratora pojemności. Fałsz — administrator pojemności nie może zastąpić ustawienia dzierżawy. True — administrator pojemności może zastąpić ustawienie dzierżawy.
delegateToDomain

boolean

Wskazuje, czy ustawienie dzierżawy można delegować do administratora domeny. Fałsz — administrator domeny nie może zastąpić ustawienia dzierżawy. Prawda — administrator domeny może zastąpić ustawienie dzierżawy.
delegateToWorkspace

boolean

Wskazuje, czy ustawienie dzierżawy może być delegowane do administratora obszaru roboczego. Fałsz — administrator obszaru roboczego nie może zastąpić ustawienia dzierżawy. Prawda — administrator obszaru roboczego może zastąpić ustawienie dzierżawy.
enabled

boolean

Stan ustawienia dzierżawy. Fałsz — wyłączone, Prawda — włączone.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Lista grup zabezpieczeń z obsługą.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Lista wykluczonych grup zabezpieczeń.
properties

TenantSettingProperty[]

Właściwości ustawień dzierżawy.
settingName

string

Nazwa ustawienia dzierżawy.
tenantSettingGroup

string

Nazwa grupy ustawień dzierżawy.
title

string

Tytuł ustawienia dzierżawy.

TenantSettingProperty

Objekt

Właściwość ustawienia dzierżawy.

Nazwisko Typ Opis
name

string

Nazwa właściwości.
type

TenantSettingPropertyType

Typ właściwości.
value

string

Wartość właściwości.

TenantSettingPropertyType

Wyliczenie

Typ właściwości ustawienia dzierżawy. Dodatkowe typy właściwości ustawień dzierżawy mogą być dodawane w czasie.

Wartość Opis
FreeText

Interfejs użytkownika akceptuje dowolny ciąg dla pola tekstowego.
Url

Interfejs użytkownika akceptuje tylko adresy URL pola tekstowego.
Boolean

Pole wyboru w interfejsie użytkownika.
MailEnabledSecurityGroup

Interfejs użytkownika akceptuje tylko grupy zabezpieczeń z obsługą poczty e-mail dla pola tekstowego.
Integer

Interfejs użytkownika akceptuje tylko liczby całkowite dla pola tekstowego.

TenantSettingSecurityGroup

Objekt

Ustawienie grupy zabezpieczeń dzierżawy.

Nazwisko Typ Opis
graphId

string

Identyfikator grafu grupy zabezpieczeń.
name

string

Nazwa grupy zabezpieczeń.

UpdateTenantSettingRequest

Objekt

Żądanie aktualizacji ustawień dzierżawy.

Nazwisko Typ Opis
delegateToCapacity

boolean

Wskazuje, czy ustawienie dzierżawy może być delegowane do administratora pojemności. Fałsz — administrator pojemności nie może zastąpić ustawienia dzierżawy. True — administrator pojemności może zastąpić ustawienie dzierżawy.
delegateToDomain

boolean

Wskazuje, czy ustawienie dzierżawy można delegować do administratora domeny. Fałsz — administrator domeny nie może zastąpić ustawienia dzierżawy. Prawda — administrator domeny może zastąpić ustawienie dzierżawy.
delegateToWorkspace

boolean

Wskazuje, czy ustawienie dzierżawy może być delegowane do administratora obszaru roboczego. Fałsz — administrator obszaru roboczego nie może zastąpić ustawienia dzierżawy. Prawda — administrator obszaru roboczego może zastąpić ustawienie dzierżawy.
enabled

boolean

Stan ustawienia dzierżawy. Fałsz — wyłączone, Prawda — włączone.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Lista grup zabezpieczeń z obsługą.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Lista wykluczonych grup zabezpieczeń.
properties

TenantSettingProperty[]

Właściwości ustawień dzierżawy.

UpdateTenantSettingResponse

Objekt

Odpowiedź na aktualizację ustawień dzierżawy.

Nazwisko Typ Opis
tenantSettings

TenantSetting[]

Lista zaktualizowanych ustawień dzierżawy.