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

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновите один или несколько параметров на уровне клиента для SharePoint и OneDrive.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	SharePointTenantSettings.ReadWrite.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	SharePointTenantSettings.ReadWrite.All	Недоступно.

При вызове от имени пользователя пользователь должен принадлежать к одной из следующих ролей администратора. Дополнительные сведения о ролях администраторов см. в разделе Сведения о ролях администратора в Центр администрирования Microsoft 365:

• Глобальный администратор
• Администратор SharePoint

HTTP-запрос

PATCH /admin/sharepoint/settings

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

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

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

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

Свойство	Тип	Описание
allowedDomainGuidsForSyncApp	Коллекция идентификаторов GUID	Коллекция идентификаторов GUID доверенного домена для приложения приложение синхронизации OneDrive.
deletedUserPersonalSiteRetentionPeriodInDays	Int32	Количество дней для сохранения oneDrive удаленного пользователя.
excludedFileExtensionsForSyncApp	Коллекция строк	Коллекция расширений файлов, не переданных приложением приложение синхронизации OneDrive.
idleSessionSignOut	microsoft.graph.idleSessionSignOut	Указывает политики выхода сеанса бездействия для клиента.
imageTaggingOption	imageTaggingChoice	Указывает параметр тегов изображений для клиента. Возможные значения: disabled, basic, enhanced.
isCommentingOnSitePagesEnabled	Логический	Указывает, разрешены ли комментарии на современных страницах сайта в SharePoint.
isFileActivityNotificationEnabled	Логический	Указывает, включены ли push-уведомления для событий OneDrive.
isLegacyAuthProtocolsEnabled	Логический	Указывает, включены ли устаревшие протоколы проверки подлинности для клиента.
isLoopEnabled	Логический	Указывает, разрешена ли Fluid Framework на сайтах SharePoint.
isMacSyncAppEnabled	Логический	Указывает, можно ли синхронизировать файлы с помощью приложения приложение синхронизации OneDrive для Mac.
isRequireAcceptingUserToMatchInvitedUserEnabled	Логический	Указывает, должны ли гости входить в систему с помощью той же учетной записи, в которую отправляются приглашения на общий доступ.
isResharingByExternalUsersEnabled	Логический	Указывает, разрешено ли гостям повторно делиться файлами, папками и сайтами, которыми они не владеют.
isSharePointMobileNotificationEnabled	Логический	Указывает, включены ли мобильные push-уведомления для SharePoint.
isSharePointNewsfeedEnabled	Логический	Указывает, разрешен ли канал новостей на современных страницах сайта в SharePoint.
isSiteCreationEnabled	Логический	Указывает, разрешено ли пользователям создавать сайты.
isSiteCreationUIEnabled	Логический	Указывает, отображаются ли команды пользовательского интерфейса для создания сайтов.
isSitePagesCreationEnabled	Логический	Указывает, разрешено ли создание новых современных страниц на сайтах SharePoint.
isSitesStorageLimitAutomatic	Логический	Указывает, осуществляется ли автоматическое управление объемом хранилища сайта или установлены ли определенные ограничения хранилища для каждого сайта.
isSyncButtonHiddenOnPersonalSite	Логический	Указывает, скрыта ли кнопка синхронизации в OneDrive.
isUnmanagedSyncAppForTenantRestricted	Логический	Указывает, разрешено ли пользователям синхронизировать файлы только на компьютерах, присоединенных к определенным доменам.
personalSiteDefaultStorageLimitInMB	Int64	Ограничение хранилища OneDrive по умолчанию для всех новых и существующих пользователей, которым назначена лицензирование. Измеряется в мегабайтах (МБ).
sharingAllowedDomainList	Коллекция строк	Коллекция доменов электронной почты, которым разрешено предоставлять общий доступ за пределами организации.
sharingBlockedDomainList	Коллекция строк	Коллекция доменов электронной почты, которые заблокированы для общего доступа за пределами организации.
sharingCapability	sharingCapabilities	Возможность совместного использования для клиента. Возможные значения: disabled, externalUserSharingOnly, externalUserAndGuestSharing, existingExternalUserSharingOnly.
sharingDomainRestrictionMode	sharingDomainRestrictionMode	Указывает режим внешнего совместного доступа для доменов. Возможные значения: none, allowList, blockList.
siteCreationDefaultManagedPath	String	Значение управляемого пути сайта группы. Это путь, по которому будут создаваться новые сайты групп.
siteCreationDefaultStorageLimitInMB	Int32	Квота хранилища по умолчанию для нового сайта после создания. Измеряется в мегабайтах (МБ).
tenantDefaultTimezone	String	Часовой пояс клиента по умолчанию для вновь созданных сайтов. Список возможных значений см. в разделе Свойство SPRegionalSettings.TimeZones.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект settings в тексте ответа.

Примеры

Запрос

Ниже показан пример запроса.

HTTP

PATCH https://graph.microsoft.com/beta/admin/sharepoint/settings
Content-Type: application/json
Content-length: 1323

{
    "deletedUserPersonalSiteRetentionPeriodInDays": 365,
    "excludedFileExtensionsForSyncApp": [".mp3"],
    "imageTaggingOption": "enhanced",
    "isLegacyAuthProtocolsEnabled": true,
    "isSitesStorageLimitAutomatic": false,
    "isSyncButtonHiddenOnPersonalSite": false,
    "isUnmanagedSyncAppForTenantRestricted": false,
    "personalSiteDefaultStorageLimitInMB": 120000
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new SharepointSettings
{
	DeletedUserPersonalSiteRetentionPeriodInDays = 365,
	ExcludedFileExtensionsForSyncApp = new List<string>
	{
		".mp3",
	},
	ImageTaggingOption = ImageTaggingChoice.Enhanced,
	IsLegacyAuthProtocolsEnabled = true,
	IsSitesStorageLimitAutomatic = false,
	IsSyncButtonHiddenOnPersonalSite = false,
	IsUnmanagedSyncAppForTenantRestricted = false,
	PersonalSiteDefaultStorageLimitInMB = 120000L,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.Sharepoint.Settings.PatchAsync(requestBody);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta admin sharepoint settings patch --body '{\
    "deletedUserPersonalSiteRetentionPeriodInDays": 365,\
    "excludedFileExtensionsForSyncApp": [".mp3"],\
    "imageTaggingOption": "enhanced",\
    "isLegacyAuthProtocolsEnabled": true,\
    "isSitesStorageLimitAutomatic": false,\
    "isSyncButtonHiddenOnPersonalSite": false,\
    "isUnmanagedSyncAppForTenantRestricted": false,\
    "personalSiteDefaultStorageLimitInMB": 120000\
}\
'

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewSharepointSettings()
deletedUserPersonalSiteRetentionPeriodInDays := int32(365)
requestBody.SetDeletedUserPersonalSiteRetentionPeriodInDays(&deletedUserPersonalSiteRetentionPeriodInDays) 
excludedFileExtensionsForSyncApp := []string {
	".mp3",
}
requestBody.SetExcludedFileExtensionsForSyncApp(excludedFileExtensionsForSyncApp)
imageTaggingOption := graphmodels.ENHANCED_IMAGETAGGINGCHOICE 
requestBody.SetImageTaggingOption(&imageTaggingOption) 
isLegacyAuthProtocolsEnabled := true
requestBody.SetIsLegacyAuthProtocolsEnabled(&isLegacyAuthProtocolsEnabled) 
isSitesStorageLimitAutomatic := false
requestBody.SetIsSitesStorageLimitAutomatic(&isSitesStorageLimitAutomatic) 
isSyncButtonHiddenOnPersonalSite := false
requestBody.SetIsSyncButtonHiddenOnPersonalSite(&isSyncButtonHiddenOnPersonalSite) 
isUnmanagedSyncAppForTenantRestricted := false
requestBody.SetIsUnmanagedSyncAppForTenantRestricted(&isUnmanagedSyncAppForTenantRestricted) 
personalSiteDefaultStorageLimitInMB := int64(120000)
requestBody.SetPersonalSiteDefaultStorageLimitInMB(&personalSiteDefaultStorageLimitInMB) 

settings, err := graphClient.Admin().Sharepoint().Settings().Patch(context.Background(), requestBody, nil)

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SharepointSettings sharepointSettings = new SharepointSettings();
sharepointSettings.setDeletedUserPersonalSiteRetentionPeriodInDays(365);
LinkedList<String> excludedFileExtensionsForSyncApp = new LinkedList<String>();
excludedFileExtensionsForSyncApp.add(".mp3");
sharepointSettings.setExcludedFileExtensionsForSyncApp(excludedFileExtensionsForSyncApp);
sharepointSettings.setImageTaggingOption(ImageTaggingChoice.Enhanced);
sharepointSettings.setIsLegacyAuthProtocolsEnabled(true);
sharepointSettings.setIsSitesStorageLimitAutomatic(false);
sharepointSettings.setIsSyncButtonHiddenOnPersonalSite(false);
sharepointSettings.setIsUnmanagedSyncAppForTenantRestricted(false);
sharepointSettings.setPersonalSiteDefaultStorageLimitInMB(120000L);
SharepointSettings result = graphClient.admin().sharepoint().settings().patch(sharepointSettings);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const sharepointSettings = {
    deletedUserPersonalSiteRetentionPeriodInDays: 365,
    excludedFileExtensionsForSyncApp: ['.mp3'],
    imageTaggingOption: 'enhanced',
    isLegacyAuthProtocolsEnabled: true,
    isSitesStorageLimitAutomatic: false,
    isSyncButtonHiddenOnPersonalSite: false,
    isUnmanagedSyncAppForTenantRestricted: false,
    personalSiteDefaultStorageLimitInMB: 120000
};

await client.api('/admin/sharepoint/settings')
	.version('beta')
	.update(sharepointSettings);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SharepointSettings;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SharepointSettings();
$requestBody->setDeletedUserPersonalSiteRetentionPeriodInDays(365);
$requestBody->setExcludedFileExtensionsForSyncApp(['.mp3', 	]);
$requestBody->setImageTaggingOption(new ImageTaggingChoice('enhanced'));
$requestBody->setIsLegacyAuthProtocolsEnabled(true);
$requestBody->setIsSitesStorageLimitAutomatic(false);
$requestBody->setIsSyncButtonHiddenOnPersonalSite(false);
$requestBody->setIsUnmanagedSyncAppForTenantRestricted(false);
$requestBody->setPersonalSiteDefaultStorageLimitInMB(120000);

$result = $graphServiceClient->admin()->sharepoint()->settings()->patch($requestBody)->wait();

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Beta.Sites

$params = @{
	deletedUserPersonalSiteRetentionPeriodInDays = 365
	excludedFileExtensionsForSyncApp = @(
	".mp3"
)
imageTaggingOption = "enhanced"
isLegacyAuthProtocolsEnabled = $true
isSitesStorageLimitAutomatic = $false
isSyncButtonHiddenOnPersonalSite = $false
isUnmanagedSyncAppForTenantRestricted = $false
personalSiteDefaultStorageLimitInMB = 120000
}

Update-MgBetaAdminSharepointSetting -BodyParameter $params

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.sharepoint_settings import SharepointSettings

graph_client = GraphServiceClient(credentials, scopes)

request_body = SharepointSettings(
	deleted_user_personal_site_retention_period_in_days = 365,
	excluded_file_extensions_for_sync_app = [
		".mp3",
	],
	image_tagging_option = ImageTaggingChoice.Enhanced,
	is_legacy_auth_protocols_enabled = True,
	is_sites_storage_limit_automatic = False,
	is_sync_button_hidden_on_personal_site = False,
	is_unmanaged_sync_app_for_tenant_restricted = False,
	personal_site_default_storage_limit_in_m_b = 120000,
)

result = await graph_client.admin.sharepoint.settings.patch(request_body)

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.sharepointSettings",
    "allowedDomainGuidsForSyncApp": [
        "bdd1ab9b-3fd0-4def-a761-ec8d7471732c", 
        "ad31vb6b-5zd0-7tyg-m231-kj8d6578432c"
    ],
    "availableManagedPathsForSiteCreation": [
        "/sites/",
        "/teams/"
    ],
    "deletedUserPersonalSiteRetentionPeriodInDays": 365,
    "excludedFileExtensionsForSyncApp": [
        ".mp3"
    ],
    "idleSessionSignOut": {
        "isEnabled": true,
        "warnAfterInSeconds": 120,
        "signOutAfterInSeconds": 300
    },
    "imageTaggingOption": "basic",
    "isCommentingOnSitePagesEnabled": true,
    "isFileActivityNotificationEnabled": true,
    "isLegacyAuthProtocolsEnabled": true,
    "isLoopEnabled": true,
    "isMacSyncAppEnabled": false,
    "isRequireAcceptingUserToMatchInvitedUserEnabled": true,
    "isResharingByExternalUsersEnabled": true,
    "isSharePointMobileNotificationEnabled": true,
    "isSharePointNewsfeedEnabled": true,
    "isSiteCreationEnabled": true,
    "isSiteCreationUIEnabled": true,
    "isSitePagesCreationEnabled": true,
    "isSitesStorageLimitAutomatic": false,
    "isSyncButtonHiddenOnPersonalSite": false,
    "isUnmanagedSyncAppForTenantRestricted": false,
    "personalSiteDefaultStorageLimitInMB": 120000,
    "sharingAllowedDomainList" : [
        "contoso.com",
        "fabrikam.com"
    ],
    "sharingBlockedDomainList" : [
        "contoso.com",
        "fabrikam.com"
    ],
    "sharingCapability": "externalUserAndGuestSharing",
    "sharingDomainRestrictionMode": "allowList",
    "siteCreationDefaultManagedPath": "/sites/",
    "siteCreationDefaultStorageLimitInMB": 808034,
    "tenantDefaultTimezone": "(UTC-05:00) Eastern Time (US and Canada)"
}