workbookWorksheetProtection: protect

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Protect a worksheet. It throws if the worksheet has been protected.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Files.ReadWrite	Not available.
Delegated (personal Microsoft account)	Files.ReadWrite	Not available.
Application	Not supported.	Not supported.

HTTP request

POST /me/drive/items/{id}/workbook/worksheets/{id|name}/protection/protect
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/protection/protect

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Workbook-Session-Id	Workbook session Id that determines if changes are persisted or not. Optional.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
options	workbookWorksheetProtectionOptions	Optional. sheet protection options.

Response

If successful, this method returns 200 OK response code. It doesn't return anything in the response body.

Example

Here is an example of how to call this API.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id|name}/protection/protect
Content-type: application/json

{
  "options": {
    "allowFormatCells": true,
    "allowFormatColumns": true,
    "allowFormatRows": true,
    "allowInsertColumns": true,
    "allowInsertRows": true,
    "allowInsertHyperlinks": true,
    "allowDeleteColumns": true,
    "allowDeleteRows": true,
    "allowSort": true,
    "allowAutoFilter": true,
    "allowPivotTables": true
  }
}

C#

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

// Dependencies
using Microsoft.Graph.Beta.Drives.Item.Items.Item.Workbook.Worksheets.Item.Protection.Protect;
using Microsoft.Graph.Beta.Models;

var requestBody = new ProtectPostRequestBody
{
	Options = new WorkbookWorksheetProtectionOptions
	{
		AllowFormatCells = true,
		AllowFormatColumns = true,
		AllowFormatRows = true,
		AllowInsertColumns = true,
		AllowInsertRows = true,
		AllowInsertHyperlinks = true,
		AllowDeleteColumns = true,
		AllowDeleteRows = true,
		AllowSort = true,
		AllowAutoFilter = true,
		AllowPivotTables = true,
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Workbook.Worksheets["{workbookWorksheet-id}"].Protection.Protect.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

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

requestBody := graphdrives.NewProtectPostRequestBody()
options := graphmodels.NewWorkbookWorksheetProtectionOptions()
allowFormatCells := true
options.SetAllowFormatCells(&allowFormatCells) 
allowFormatColumns := true
options.SetAllowFormatColumns(&allowFormatColumns) 
allowFormatRows := true
options.SetAllowFormatRows(&allowFormatRows) 
allowInsertColumns := true
options.SetAllowInsertColumns(&allowInsertColumns) 
allowInsertRows := true
options.SetAllowInsertRows(&allowInsertRows) 
allowInsertHyperlinks := true
options.SetAllowInsertHyperlinks(&allowInsertHyperlinks) 
allowDeleteColumns := true
options.SetAllowDeleteColumns(&allowDeleteColumns) 
allowDeleteRows := true
options.SetAllowDeleteRows(&allowDeleteRows) 
allowSort := true
options.SetAllowSort(&allowSort) 
allowAutoFilter := true
options.SetAllowAutoFilter(&allowAutoFilter) 
allowPivotTables := true
options.SetAllowPivotTables(&allowPivotTables) 
requestBody.SetOptions(options)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Workbook().Worksheets().ByWorkbookWorksheetId("workbookWorksheet-id").Protection().Protect().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.drives.item.items.item.workbook.worksheets.item.protection.protect.ProtectPostRequestBody protectPostRequestBody = new com.microsoft.graph.beta.drives.item.items.item.workbook.worksheets.item.protection.protect.ProtectPostRequestBody();
WorkbookWorksheetProtectionOptions options = new WorkbookWorksheetProtectionOptions();
options.setAllowFormatCells(true);
options.setAllowFormatColumns(true);
options.setAllowFormatRows(true);
options.setAllowInsertColumns(true);
options.setAllowInsertRows(true);
options.setAllowInsertHyperlinks(true);
options.setAllowDeleteColumns(true);
options.setAllowDeleteRows(true);
options.setAllowSort(true);
options.setAllowAutoFilter(true);
options.setAllowPivotTables(true);
protectPostRequestBody.setOptions(options);
graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").workbook().worksheets().byWorkbookWorksheetId("{workbookWorksheet-id}").protection().protect().post(protectPostRequestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const protect = {
  options: {
    allowFormatCells: true,
    allowFormatColumns: true,
    allowFormatRows: true,
    allowInsertColumns: true,
    allowInsertRows: true,
    allowInsertHyperlinks: true,
    allowDeleteColumns: true,
    allowDeleteRows: true,
    allowSort: true,
    allowAutoFilter: true,
    allowPivotTables: true
  }
};

await client.api('/me/drive/items/{id}/workbook/worksheets/{id|name}/protection/protect')
	.version('beta')
	.post(protect);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Drives\Item\Items\Item\Workbook\Worksheets\Item\Protection\Protect\ProtectPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\WorkbookWorksheetProtectionOptions;


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

$requestBody = new ProtectPostRequestBody();
$options = new WorkbookWorksheetProtectionOptions();
$options->setAllowFormatCells(true);
$options->setAllowFormatColumns(true);
$options->setAllowFormatRows(true);
$options->setAllowInsertColumns(true);
$options->setAllowInsertRows(true);
$options->setAllowInsertHyperlinks(true);
$options->setAllowDeleteColumns(true);
$options->setAllowDeleteRows(true);
$options->setAllowSort(true);
$options->setAllowAutoFilter(true);
$options->setAllowPivotTables(true);
$requestBody->setOptions($options);

$graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->workbook()->worksheets()->byWorkbookWorksheetId('workbookWorksheet-id')->protection()->protect()->post($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.drives.item.items.item.workbook.worksheets.item.protection.protect.protect_post_request_body import ProtectPostRequestBody
from msgraph_beta.generated.models.workbook_worksheet_protection_options import WorkbookWorksheetProtectionOptions
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ProtectPostRequestBody(
	options = WorkbookWorksheetProtectionOptions(
		allow_format_cells = True,
		allow_format_columns = True,
		allow_format_rows = True,
		allow_insert_columns = True,
		allow_insert_rows = True,
		allow_insert_hyperlinks = True,
		allow_delete_columns = True,
		allow_delete_rows = True,
		allow_sort = True,
		allow_auto_filter = True,
		allow_pivot_tables = True,
	),
)

await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').workbook.worksheets.by_workbook_worksheet_id('workbookWorksheet-id').protection.protect.post(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 200 OK