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.
Update the properties of an activityBasedTimeoutPolicy object.
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) |
Policy.Read.ApplicationConfiguration |
Policy.ReadWrite.ApplicationConfiguration |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
Policy.Read.ApplicationConfiguration |
Policy.ReadWrite.ApplicationConfiguration |
HTTP request
PATCH /policies/activityBasedTimeoutPolicies/{id}
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property |
Type |
Description |
| definition |
String collection |
A string collection containing a JSON string that defines the rules and settings for this policy. |
| displayName |
String |
Display name for this policy. |
| isOrganizationDefault |
Boolean |
If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Default value is false. |
Response
If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.
Example
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/policies/activityBasedTimeoutPolicies/cf70ac6c-8a1a-40cd-a523-a2b4a56de0df
Content-type: application/json
{
"displayName": "Idle timeout for all apps"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new ActivityBasedTimeoutPolicy
{
DisplayName = "Idle timeout for all apps",
};
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Policies.ActivityBasedTimeoutPolicies["{activityBasedTimeoutPolicy-id}"].PatchAsync(requestBody);
// 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"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewActivityBasedTimeoutPolicy()
displayName := "Idle timeout for all apps"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=go
activityBasedTimeoutPolicies, err := graphClient.Policies().ActivityBasedTimeoutPolicies().ByActivityBasedTimeoutPolicyId("activityBasedTimeoutPolicy-id").Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ActivityBasedTimeoutPolicy activityBasedTimeoutPolicy = new ActivityBasedTimeoutPolicy();
activityBasedTimeoutPolicy.setDisplayName("Idle timeout for all apps");
ActivityBasedTimeoutPolicy result = graphClient.policies().activityBasedTimeoutPolicies().byActivityBasedTimeoutPolicyId("{activityBasedTimeoutPolicy-id}").patch(activityBasedTimeoutPolicy);
const options = {
authProvider,
};
const client = Client.init(options);
const activityBasedTimeoutPolicy = {
displayName: 'Idle timeout for all apps'
};
await client.api('/policies/activityBasedTimeoutPolicies/cf70ac6c-8a1a-40cd-a523-a2b4a56de0df')
.version('beta')
.update(activityBasedTimeoutPolicy);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ActivityBasedTimeoutPolicy;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ActivityBasedTimeoutPolicy();
$requestBody->setDisplayName('Idle timeout for all apps');
$result = $graphServiceClient->policies()->activityBasedTimeoutPolicies()->byActivityBasedTimeoutPolicyId('activityBasedTimeoutPolicy-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
displayName = "Idle timeout for all apps"
}
Update-MgBetaPolicyActivityBasedTimeoutPolicy -ActivityBasedTimeoutPolicyId $activityBasedTimeoutPolicyId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.activity_based_timeout_policy import ActivityBasedTimeoutPolicy
# To initialize your graph_client, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ActivityBasedTimeoutPolicy(
display_name = "Idle timeout for all apps",
)
result = await graph_client.policies.activity_based_timeout_policies.by_activity_based_timeout_policy_id('activityBasedTimeoutPolicy-id').patch(request_body)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 204 No Content