Tenants - List Tenant Settings

Служба:: Admin

Версия API:: v1

Возвращает список параметров клиента.

Разрешения

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

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

Tenant.Read.All или Tenant.ReadWrite.All

Ограничения

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

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

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

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings

С использованием необязательных параметров:

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings?continuationToken={continuationToken}

Параметры URI

Имя	В	Обязательно	Тип	Описание
continuationToken	query		string	Маркер получения следующей страницы результатов.

Ответы

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

200 OK

Имя	Тип	Описание
200 OK	TenantSettings	ХОРОШО. Операция прошла успешно.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: Запрещено. Вызывающий объект не имеет разрешений для вызова API.

TenantSettings

ХОРОШО. Операция прошла успешно.

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

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

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

Примеры

List tenant settings example

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

HTTP

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings

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

Код состояния:: 200

{
  "value": [
    {
      "settingName": "AdminApisIncludeDetailedMetadata",
      "title": "Enhance admin APIs responses with detailed metadata",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "tenantSettingGroup": "AdminApiSettings"
    },
    {
      "settingName": "DatamartTenant",
      "title": "Create Datamarts (Preview)",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "enabledSecurityGroups": [
        {
          "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
          "name": "TestComputeCdsa"
        },
        {
          "graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
          "name": "TestComputeGroup2"
        },
        {
          "graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
          "name": "TestCertifiers"
        }
      ],
      "tenantSettingGroup": "DatamartSettings"
    },
    {
      "settingName": "CertifyDatasets",
      "title": "Certification",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "tenantSettingGroup": "ExportAndSharing"
    }
  ]
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
TenantSetting	Сведения о параметрах уровня клиента.
TenantSettingProperty	Свойство параметра клиента.
TenantSettingPropertyType	Тип свойства параметра клиента. С течением времени могут добавляться дополнительные типы свойств параметров клиента.
TenantSettings	Список параметров клиента.
TenantSettingSecurityGroup	Группа безопасности параметров клиента.

ErrorRelatedResource

Объект

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

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
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	Пользовательский интерфейс принимает только целые числа для текстового поля.

TenantSettings

Объект

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

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	TenantSetting[]	Список параметров клиента.

TenantSettingSecurityGroup

Объект

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

Имя	Тип	Описание
graphId	string	Идентификатор графа группы безопасности.
name	string	Имя группы безопасности.