Tenants - Update Tenant Setting

Служба:
Admin
Версия API:
v1

Обновите заданный параметр клиента.

Note

Этот API является частью предварительного выпуска и предоставляется только для оценки и разработки. Он может измениться на основе отзывов и не рекомендуется для использования в рабочей среде.

Permissions

Вызывающий объект должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.

Обязательные делегированные области

Tenant.ReadWrite.All

Limitations

Не более 25 запросов в минуту.

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Identity Support
User Yes
Представитель службы и управляемые удостоверения Yes

Interface

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

Параметры URI

Имя В Обязательно Тип Описание
tenantSettingName
 path True

string

Имя параметра клиента.

Текст запроса

Имя Обязательно Тип Описание
enabled True

boolean

Состояние параметра клиента. False — отключено, true — включено.
delegateToCapacity

boolean

Указывает, можно ли делегировать параметр клиента администратору емкости. False — администратор емкости не может переопределить параметр клиента. True. Администратор емкости может переопределить параметр клиента.
delegateToDomain

boolean

Указывает, можно ли делегировать параметр клиента администратору домена. False — администратор домена не может переопределить параметр клиента. True. Администратор домена может переопределить параметр клиента.
delegateToWorkspace

boolean

Указывает, можно ли делегировать параметр клиента администратору рабочей области. False — администратор рабочей области не может переопределить параметр клиента. True. Администратор рабочей области может переопределить параметр клиента.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Список включенных групп безопасности.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Список исключенных групп безопасности.
properties

TenantSettingProperty[]

Свойства параметра клиента.

Ответы

Имя Тип Описание
200 OK

UpdateTenantSettingResponse

OK. Операция прошла успешно.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • Запрещено. Вызывающий объект не имеет разрешений для вызова API.

Примеры

Update tenant setting example

Образец запроса

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

Пример ответа

Код состояния:
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"
    }
  ]
}

Определения

Имя Описание
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
TenantSetting

Сведения о параметрах уровня клиента.
TenantSettingProperty

Свойство параметра клиента.
TenantSettingPropertyType

Тип свойства параметра клиента. С течением времени могут добавляться дополнительные типы свойств параметров клиента.
TenantSettingSecurityGroup

Группа безопасности параметров клиента.
UpdateTenantSettingRequest

Запрос на обновление параметров клиента.
UpdateTenantSettingResponse

Ответ на обновление параметра клиента.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

TenantSetting

Объект

Сведения о параметрах уровня клиента.

Имя Тип Описание
canSpecifySecurityGroups

boolean

Указывает, включен ли параметр клиента для группы безопасности. False. Параметр клиента включен для всей организации. True. Параметр клиента включен для групп безопасности.
delegateToCapacity

boolean

Указывает, можно ли делегировать параметр клиента администратору емкости. False — администратор емкости не может переопределить параметр клиента. True. Администратор емкости может переопределить параметр клиента.
delegateToDomain

boolean

Указывает, можно ли делегировать параметр клиента администратору домена. False — администратор домена не может переопределить параметр клиента. True. Администратор домена может переопределить параметр клиента.
delegateToWorkspace

boolean

Указывает, можно ли делегировать параметр клиента администратору рабочей области. False — администратор рабочей области не может переопределить параметр клиента. True. Администратор рабочей области может переопределить параметр клиента.
enabled

boolean

Состояние параметра клиента. False — отключено, true — включено.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Список включенных групп безопасности.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Список исключенных групп безопасности.
properties

TenantSettingProperty[]

Свойства параметра клиента.
settingName

string

Имя параметра клиента.
tenantSettingGroup

string

Имя группы параметров клиента.
title

string

Заголовок параметра клиента.

TenantSettingProperty

Объект

Свойство параметра клиента.

Имя Тип Описание
name

string

Название свойства.
type

TenantSettingPropertyType

Тип свойства.
value

string

Значение свойства.

TenantSettingPropertyType

Перечисление

Тип свойства параметра клиента. С течением времени могут добавляться дополнительные типы свойств параметров клиента.

Значение Описание
FreeText

Пользовательский интерфейс принимает любую строку для текстового поля.
Url

Пользовательский интерфейс принимает только URL-адреса для текстового поля.
Boolean

Флажок в пользовательском интерфейсе.
MailEnabledSecurityGroup

Пользовательский интерфейс принимает только группы безопасности с поддержкой электронной почты для текстового поля.
Integer

Пользовательский интерфейс принимает только целые числа для текстового поля.

TenantSettingSecurityGroup

Объект

Группа безопасности параметров клиента.

Имя Тип Описание
graphId

string

Идентификатор графа группы безопасности.
name

string

Имя группы безопасности.

UpdateTenantSettingRequest

Объект

Запрос на обновление параметров клиента.

Имя Тип Описание
delegateToCapacity

boolean

Указывает, можно ли делегировать параметр клиента администратору емкости. False — администратор емкости не может переопределить параметр клиента. True. Администратор емкости может переопределить параметр клиента.
delegateToDomain

boolean

Указывает, можно ли делегировать параметр клиента администратору домена. False — администратор домена не может переопределить параметр клиента. True. Администратор домена может переопределить параметр клиента.
delegateToWorkspace

boolean

Указывает, можно ли делегировать параметр клиента администратору рабочей области. False — администратор рабочей области не может переопределить параметр клиента. True. Администратор рабочей области может переопределить параметр клиента.
enabled

boolean

Состояние параметра клиента. False — отключено, true — включено.
enabledSecurityGroups

TenantSettingSecurityGroup[]

Список включенных групп безопасности.
excludedSecurityGroups

TenantSettingSecurityGroup[]

Список исключенных групп безопасности.
properties

TenantSettingProperty[]

Свойства параметра клиента.

UpdateTenantSettingResponse

Объект

Ответ на обновление параметра клиента.

Имя Тип Описание
tenantSettings

TenantSetting[]

Список параметров клиента, которые были обновлены.