Namespace: microsoft.graph
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Update the properties of a iosUpdateConfiguration 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
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type |
Permissions (from least to most privileged) |
Delegated (work or school account) |
DeviceManagementConfiguration.ReadWrite.All |
Delegated (personal Microsoft account) |
Not supported. |
Application |
DeviceManagementConfiguration.ReadWrite.All |
HTTP Request
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}
Request body
In the request body, supply a JSON representation for the iosUpdateConfiguration object.
The following table shows the properties that are required when you create the iosUpdateConfiguration.
Property |
Type |
Description |
id |
String |
Key of the entity. Inherited from deviceConfiguration |
lastModifiedDateTime |
DateTimeOffset |
DateTime the object was last modified. Inherited from deviceConfiguration |
createdDateTime |
DateTimeOffset |
DateTime the object was created. Inherited from deviceConfiguration |
description |
String |
Admin provided description of the Device Configuration. Inherited from deviceConfiguration |
displayName |
String |
Admin provided name of the device configuration. Inherited from deviceConfiguration |
version |
Int32 |
Version of the device configuration. Inherited from deviceConfiguration |
activeHoursStart |
TimeOfDay |
Active Hours Start (active hours mean the time window when updates install should not happen) |
activeHoursEnd |
TimeOfDay |
Active Hours End (active hours mean the time window when updates install should not happen) |
scheduledInstallDays |
dayOfWeek collection |
Days in week for which active hours are configured. This collection can contain a maximum of 7 elements. Possible values are: sunday , monday , tuesday , wednesday , thursday , friday , saturday . |
utcTimeOffsetInMinutes |
Int32 |
UTC Time Offset indicated in minutes |
Response
If successful, this method returns a 200 OK
response code and an updated iosUpdateConfiguration object in the response body.
Example
Request
Here is an example of the request.
PATCH https://graph.microsoft.com/v1.0/deviceManagement/deviceConfigurations/{deviceConfigurationId}
Content-type: application/json
Content-length: 325
{
"@odata.type": "#microsoft.graph.iosUpdateConfiguration",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"activeHoursStart": "12:00:05.5020000",
"activeHoursEnd": "11:59:00.8990000",
"scheduledInstallDays": [
"monday"
],
"utcTimeOffsetInMinutes": 6
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new IosUpdateConfiguration
{
OdataType = "#microsoft.graph.iosUpdateConfiguration",
Description = "Description value",
DisplayName = "Display Name value",
Version = 7,
ActiveHoursStart = new Time(DateTime.Parse("12:00:05.5020000")),
ActiveHoursEnd = new Time(DateTime.Parse("11:59:00.8990000")),
ScheduledInstallDays = new List<DayOfWeekObject?>
{
DayOfWeekObject.Monday,
},
UtcTimeOffsetInMinutes = 6,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.DeviceConfigurations["{deviceConfiguration-id}"].PatchAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc device-management device-configurations patch --device-configuration-id {deviceConfiguration-id} --body '{\
"@odata.type": "#microsoft.graph.iosUpdateConfiguration",\
"description": "Description value",\
"displayName": "Display Name value",\
"version": 7,\
"activeHoursStart": "12:00:05.5020000",\
"activeHoursEnd": "11:59:00.8990000",\
"scheduledInstallDays": [\
"monday"\
],\
"utcTimeOffsetInMinutes": 6\
}\
'
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.NewDeviceConfiguration()
description := "Description value"
requestBody.SetDescription(&description)
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName)
version := int32(7)
requestBody.SetVersion(&version)
activeHoursStart := 12:00:05.5020000
requestBody.SetActiveHoursStart(&activeHoursStart)
activeHoursEnd := 11:59:00.8990000
requestBody.SetActiveHoursEnd(&activeHoursEnd)
scheduledInstallDays := []graphmodels.DayOfWeekable {
dayOfWeek := graphmodels.MONDAY_DAYOFWEEK
requestBody.SetDayOfWeek(&dayOfWeek)
}
requestBody.SetScheduledInstallDays(scheduledInstallDays)
utcTimeOffsetInMinutes := int32(6)
requestBody.SetUtcTimeOffsetInMinutes(&utcTimeOffsetInMinutes)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
deviceConfigurations, err := graphClient.DeviceManagement().DeviceConfigurations().ByDeviceConfigurationId("deviceConfiguration-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);
IosUpdateConfiguration deviceConfiguration = new IosUpdateConfiguration();
deviceConfiguration.setOdataType("#microsoft.graph.iosUpdateConfiguration");
deviceConfiguration.setDescription("Description value");
deviceConfiguration.setDisplayName("Display Name value");
deviceConfiguration.setVersion(7);
LocalTime activeHoursStart = LocalTime.parse("12:00:05.5020000");
deviceConfiguration.setActiveHoursStart(activeHoursStart);
LocalTime activeHoursEnd = LocalTime.parse("11:59:00.8990000");
deviceConfiguration.setActiveHoursEnd(activeHoursEnd);
LinkedList<DayOfWeek> scheduledInstallDays = new LinkedList<DayOfWeek>();
scheduledInstallDays.add(DayOfWeek.Monday);
deviceConfiguration.setScheduledInstallDays(scheduledInstallDays);
deviceConfiguration.setUtcTimeOffsetInMinutes(6);
DeviceConfiguration result = graphClient.deviceManagement().deviceConfigurations().byDeviceConfigurationId("{deviceConfiguration-id}").patch(deviceConfiguration);
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 deviceConfiguration = {
'@odata.type': '#microsoft.graph.iosUpdateConfiguration',
description: 'Description value',
displayName: 'Display Name value',
version: 7,
activeHoursStart: '12:00:05.5020000',
activeHoursEnd: '11:59:00.8990000',
scheduledInstallDays: [
'monday'
],
utcTimeOffsetInMinutes: 6
};
await client.api('/deviceManagement/deviceConfigurations/{deviceConfigurationId}')
.update(deviceConfiguration);
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\IosUpdateConfiguration;
use Microsoft\Kiota\Abstractions\Types\Time;
use Microsoft\Graph\Generated\Models\DayOfWeek;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new IosUpdateConfiguration();
$requestBody->setOdataType('#microsoft.graph.iosUpdateConfiguration');
$requestBody->setDescription('Description value');
$requestBody->setDisplayName('Display Name value');
$requestBody->setVersion(7);
$requestBody->setActiveHoursStart(new Time('12:00:05.5020000'));
$requestBody->setActiveHoursEnd(new Time('11:59:00.8990000'));
$requestBody->setScheduledInstallDays([new DayOfWeek('monday'), ]);
$requestBody->setUtcTimeOffsetInMinutes(6);
$result = $graphServiceClient->deviceManagement()->deviceConfigurations()->byDeviceConfigurationId('deviceConfiguration-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.DeviceManagement
$params = @{
"@odata.type" = "#microsoft.graph.iosUpdateConfiguration"
description = "Description value"
displayName = "Display Name value"
version = 7
activeHoursStart = "12:00:05.5020000"
activeHoursEnd = "11:59:00.8990000"
scheduledInstallDays = @(
"monday"
)
utcTimeOffsetInMinutes =
}
Update-MgDeviceManagementDeviceConfiguration -DeviceConfigurationId $deviceConfigurationId -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.ios_update_configuration import IosUpdateConfiguration
from msgraph.generated.models.day_of_week import DayOfWeek
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = IosUpdateConfiguration(
odata_type = "#microsoft.graph.iosUpdateConfiguration",
description = "Description value",
display_name = "Display Name value",
version = 7,
active_hours_start = "12:00:05.5020000",
active_hours_end = "11:59:00.8990000",
scheduled_install_days = [
DayOfWeek.Monday,
],
utc_time_offset_in_minutes = 6,
)
result = await graph_client.device_management.device_configurations.by_device_configuration_id('deviceConfiguration-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
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 497
{
"@odata.type": "#microsoft.graph.iosUpdateConfiguration",
"id": "321aef09-ef09-321a-09ef-1a3209ef1a32",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"activeHoursStart": "12:00:05.5020000",
"activeHoursEnd": "11:59:00.8990000",
"scheduledInstallDays": [
"monday"
],
"utcTimeOffsetInMinutes": 6
}