Update editionUpgradeConfiguration
Article
11/30/2023
11 contributors
Feedback
In this article
Namespace: microsoft.graph
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Update the properties of a editionUpgradeConfiguration 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 editionUpgradeConfiguration object.
The following table shows the properties that are required when you create the editionUpgradeConfiguration .
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
licenseType
editionUpgradeLicenseType
Edition Upgrade License Type. Possible values are: productKey
, licenseFile
.
targetEdition
windows10EditionType
Edition Upgrade Target Edition. Possible values are: windows10Enterprise
, windows10EnterpriseN
, windows10Education
, windows10EducationN
, windows10MobileEnterprise
, windows10HolographicEnterprise
, windows10Professional
, windows10ProfessionalN
, windows10ProfessionalEducation
, windows10ProfessionalEducationN
, windows10ProfessionalWorkstation
, windows10ProfessionalWorkstationN
.
license
String
Edition Upgrade License File Content.
productKey
String
Edition Upgrade Product Key.
Response
If successful, this method returns a 200 OK
response code and an updated editionUpgradeConfiguration 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: 311
{
"@odata.type": "#microsoft.graph.editionUpgradeConfiguration",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"licenseType": "licenseFile",
"targetEdition": "windows10EnterpriseN",
"license": "License value",
"productKey": "Product Key value"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new EditionUpgradeConfiguration
{
OdataType = "#microsoft.graph.editionUpgradeConfiguration",
Description = "Description value",
DisplayName = "Display Name value",
Version = 7,
LicenseType = EditionUpgradeLicenseType.LicenseFile,
TargetEdition = Windows10EditionType.Windows10EnterpriseN,
License = "License value",
ProductKey = "Product Key value",
};
// 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 .
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc device-management device-configurations patch --device-configuration-id {deviceConfiguration-id} --body '{\
"@odata.type": "#microsoft.graph.editionUpgradeConfiguration",\
"description": "Description value",\
"displayName": "Display Name value",\
"version": 7,\
"licenseType": "licenseFile",\
"targetEdition": "windows10EnterpriseN",\
"license": "License value",\
"productKey": "Product Key value"\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodels.NewDeviceConfiguration()
description := "Description value"
requestBody.SetDescription(&description)
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName)
version := int32(7)
requestBody.SetVersion(&version)
licenseType := graphmodels.LICENSEFILE_EDITIONUPGRADELICENSETYPE
requestBody.SetLicenseType(&licenseType)
targetEdition := graphmodels.WINDOWS10ENTERPRISEN_WINDOWS10EDITIONTYPE
requestBody.SetTargetEdition(&targetEdition)
license := "License value"
requestBody.SetLicense(&license)
productKey := "Product Key value"
requestBody.SetProductKey(&productKey)
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);
EditionUpgradeConfiguration deviceConfiguration = new EditionUpgradeConfiguration();
deviceConfiguration.setOdataType("#microsoft.graph.editionUpgradeConfiguration");
deviceConfiguration.setDescription("Description value");
deviceConfiguration.setDisplayName("Display Name value");
deviceConfiguration.setVersion(7);
deviceConfiguration.setLicenseType(EditionUpgradeLicenseType.LicenseFile);
deviceConfiguration.setTargetEdition(Windows10EditionType.Windows10EnterpriseN);
deviceConfiguration.setLicense("License value");
deviceConfiguration.setProductKey("Product Key value");
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.editionUpgradeConfiguration',
description: 'Description value',
displayName: 'Display Name value',
version: 7,
licenseType: 'licenseFile',
targetEdition: 'windows10EnterpriseN',
license: 'License value',
productKey: 'Product Key value'
};
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\EditionUpgradeConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EditionUpgradeConfiguration();
$requestBody->setOdataType('#microsoft.graph.editionUpgradeConfiguration');
$requestBody->setDescription('Description value');
$requestBody->setDisplayName('Display Name value');
$requestBody->setVersion(7);
$requestBody->setLicenseType(new EditionUpgradeLicenseType('licenseFile'));
$requestBody->setTargetEdition(new Windows10EditionType('windows10EnterpriseN'));
$requestBody->setLicense('License value');
$requestBody->setProductKey('Product Key value');
$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.editionUpgradeConfiguration"
description = "Description value"
displayName = "Display Name value"
version = 7
licenseType = "licenseFile"
targetEdition = "windows10EnterpriseN"
license = "License value"
productKey = "Product Key value"
}
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 .
from msgraph import GraphServiceClient
from msgraph.generated.models.edition_upgrade_configuration import EditionUpgradeConfiguration
graph_client = GraphServiceClient(credentials, scopes)
request_body = EditionUpgradeConfiguration(
odata_type = "#microsoft.graph.editionUpgradeConfiguration",
description = "Description value",
display_name = "Display Name value",
version = 7,
license_type = EditionUpgradeLicenseType.LicenseFile,
target_edition = Windows10EditionType.Windows10EnterpriseN,
license = "License value",
product_key = "Product Key value",
)
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: 483
{
"@odata.type": "#microsoft.graph.editionUpgradeConfiguration",
"id": "f39fc471-c471-f39f-71c4-9ff371c49ff3",
"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,
"licenseType": "licenseFile",
"targetEdition": "windows10EnterpriseN",
"license": "License value",
"productKey": "Product Key value"
}