Namespace: microsoft.graph
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. Required. |
| displayName |
String |
Display name for this policy. Required. |
| 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. Optional, 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/v1.0/policies/activityBasedTimeoutPolicies/{id}
Content-type: application/json
{
"definition": [
"definition-value"
],
"displayName": "displayName-value",
"isOrganizationDefault": true
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new ActivityBasedTimeoutPolicy
{
Definition = new List<string>
{
"definition-value",
},
DisplayName = "displayName-value",
IsOrganizationDefault = true,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Policies.ActivityBasedTimeoutPolicies["{activityBasedTimeoutPolicy-id}"].PatchAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc policies activity-based-timeout-policies patch --activity-based-timeout-policy-id {activityBasedTimeoutPolicy-id} --body '{\
"definition": [\
"definition-value"\
],\
"displayName": "displayName-value",\
"isOrganizationDefault": true\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewActivityBasedTimeoutPolicy()
definition := []string {
"definition-value",
}
requestBody.SetDefinition(definition)
displayName := "displayName-value"
requestBody.SetDisplayName(&displayName)
isOrganizationDefault := true
requestBody.SetIsOrganizationDefault(&isOrganizationDefault)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
activityBasedTimeoutPolicies, err := graphClient.Policies().ActivityBasedTimeoutPolicies().ByActivityBasedTimeoutPolicyId("activityBasedTimeoutPolicy-id").Patch(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ActivityBasedTimeoutPolicy activityBasedTimeoutPolicy = new ActivityBasedTimeoutPolicy();
LinkedList<String> definition = new LinkedList<String>();
definition.add("definition-value");
activityBasedTimeoutPolicy.setDefinition(definition);
activityBasedTimeoutPolicy.setDisplayName("displayName-value");
activityBasedTimeoutPolicy.setIsOrganizationDefault(true);
ActivityBasedTimeoutPolicy result = graphClient.policies().activityBasedTimeoutPolicies().byActivityBasedTimeoutPolicyId("{activityBasedTimeoutPolicy-id}").patch(activityBasedTimeoutPolicy);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const activityBasedTimeoutPolicy = {
definition: [
'definition-value'
],
displayName: 'displayName-value',
isOrganizationDefault: true
};
await client.api('/policies/activityBasedTimeoutPolicies/{id}')
.update(activityBasedTimeoutPolicy);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ActivityBasedTimeoutPolicy;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ActivityBasedTimeoutPolicy();
$requestBody->setDefinition(['definition-value', ]);
$requestBody->setDisplayName('displayName-value');
$requestBody->setIsOrganizationDefault(true);
$result = $graphServiceClient->policies()->activityBasedTimeoutPolicies()->byActivityBasedTimeoutPolicyId('activityBasedTimeoutPolicy-id')->patch($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
definition = @(
"definition-value"
)
displayName = "displayName-value"
isOrganizationDefault = $true
}
Update-MgPolicyActivityBasedTimeoutPolicy -ActivityBasedTimeoutPolicyId $activityBasedTimeoutPolicyId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.activity_based_timeout_policy import ActivityBasedTimeoutPolicy
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ActivityBasedTimeoutPolicy(
definition = [
"definition-value",
],
display_name = "displayName-value",
is_organization_default = True,
)
result = await graph_client.policies.activity_based_timeout_policies.by_activity_based_timeout_policy_id('activityBasedTimeoutPolicy-id').patch(request_body)
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.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 204 No Content
Content-type: application/json
{
"definition": [
"definition-value"
],
"displayName": "displayName-value",
"isOrganizationDefault": true,
"id": "id-value"
}