Update windowsAppX

Article
08/01/2024

Namespace: microsoft.graph

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a windowsAppX 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)	DeviceManagementApps.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementApps.ReadWrite.All

HTTP Request

PATCH /deviceAppManagement/mobileApps/{mobileAppId}

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the windowsAppX object.

The following table shows the properties that are required when you create the windowsAppX.

Property	Type	Description
id	String	Key of the entity. Inherited from mobileApp
displayName	String	The admin provided or imported title of the app. Inherited from mobileApp
description	String	The description of the app. Inherited from mobileApp
publisher	String	The publisher of the app. Inherited from mobileApp
largeIcon	mimeContent	The large icon, to be displayed in the app details and used for upload of the icon. Inherited from mobileApp
createdDateTime	DateTimeOffset	The date and time the app was created. Inherited from mobileApp
lastModifiedDateTime	DateTimeOffset	The date and time the app was last modified. Inherited from mobileApp
isFeatured	Boolean	The value indicating whether the app is marked as featured by the admin. Inherited from mobileApp
privacyInformationUrl	String	The privacy statement Url. Inherited from mobileApp
informationUrl	String	The more information Url. Inherited from mobileApp
owner	String	The owner of the app. Inherited from mobileApp
developer	String	The developer of the app. Inherited from mobileApp
notes	String	Notes for the app. Inherited from mobileApp
publishingState	mobileAppPublishingState	The publishing state for the app. The app cannot be assigned unless the app is published. Inherited from mobileApp. Possible values are: `notPublished`, `processing`, `published`.
committedContentVersion	String	The internal committed content version. Inherited from mobileLobApp
fileName	String	The name of the main Lob application file. Inherited from mobileLobApp
size	Int64	The total size, including all uploaded files. Inherited from mobileLobApp
applicableArchitectures	windowsArchitecture	The Windows architecture(s) on which this app can run. Possible values are: `none`, `x86`, `x64`, `arm`, `neutral`; default value is `none`. Possible values are: `none`, `x86`, `x64`, `arm`, `neutral`.
identityName	String	The identity name of the uploaded app package. For example: "Contoso.DemoApp".
identityPublisherHash	String	The identity publisher hash of the uploaded app package. This is the hash of the publisher from the manifest. For example: "AB82CD0XYZ".
identityResourceIdentifier	String	The identity resource identifier of the uploaded app package. For example: "TestResourceId".
isBundle	Boolean	When TRUE, indicates that the app is a bundle. When FALSE, indicates that the app is not a bundle. By default, property is set to FALSE.
minimumSupportedOperatingSystem	windowsMinimumOperatingSystem	The value for the minimum applicable operating system. Valid values for a WindowsAppX app include `v8_0`, `v8_1` and `v10_0`. If the app is a bundle, the minimum supported OS has to be at least `v8_1`.
identityVersion	String	The identity version of the uploaded app package. For example: "1.0.0.0".

Response

If successful, this method returns a 200 OK response code and an updated windowsAppX object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/v1.0/deviceAppManagement/mobileApps/{mobileAppId}
Content-type: application/json
Content-length: 1141

{
  "@odata.type": "#microsoft.graph.windowsAppX",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "publishingState": "processing",
  "committedContentVersion": "Committed Content Version value",
  "fileName": "File Name value",
  "size": 4,
  "applicableArchitectures": "x86",
  "identityName": "Identity Name value",
  "identityPublisherHash": "Identity Publisher Hash value",
  "identityResourceIdentifier": "Identity Resource Identifier value",
  "isBundle": true,
  "minimumSupportedOperatingSystem": {
    "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem",
    "v8_0": true,
    "v8_1": true,
    "v10_0": true
  },
  "identityVersion": "Identity Version value"
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new WindowsAppX
{
	OdataType = "#microsoft.graph.windowsAppX",
	DisplayName = "Display Name value",
	Description = "Description value",
	Publisher = "Publisher value",
	LargeIcon = new MimeContent
	{
		OdataType = "microsoft.graph.mimeContent",
		Type = "Type value",
		Value = Convert.FromBase64String("dmFsdWU="),
	},
	IsFeatured = true,
	PrivacyInformationUrl = "https://example.com/privacyInformationUrl/",
	InformationUrl = "https://example.com/informationUrl/",
	Owner = "Owner value",
	Developer = "Developer value",
	Notes = "Notes value",
	PublishingState = MobileAppPublishingState.Processing,
	CommittedContentVersion = "Committed Content Version value",
	FileName = "File Name value",
	Size = 4L,
	ApplicableArchitectures = WindowsArchitecture.X86,
	IdentityName = "Identity Name value",
	IdentityPublisherHash = "Identity Publisher Hash value",
	IdentityResourceIdentifier = "Identity Resource Identifier value",
	IsBundle = true,
	MinimumSupportedOperatingSystem = new WindowsMinimumOperatingSystem
	{
		OdataType = "microsoft.graph.windowsMinimumOperatingSystem",
		V80 = true,
		V81 = true,
		V100 = true,
	},
	IdentityVersion = "Identity Version value",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceAppManagement.MobileApps["{mobileApp-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-app-management mobile-apps patch --mobile-app-id {mobileApp-id} --body '{\
  "@odata.type": "#microsoft.graph.windowsAppX",\
  "displayName": "Display Name value",\
  "description": "Description value",\
  "publisher": "Publisher value",\
  "largeIcon": {\
    "@odata.type": "microsoft.graph.mimeContent",\
    "type": "Type value",\
    "value": "dmFsdWU="\
  },\
  "isFeatured": true,\
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",\
  "informationUrl": "https://example.com/informationUrl/",\
  "owner": "Owner value",\
  "developer": "Developer value",\
  "notes": "Notes value",\
  "publishingState": "processing",\
  "committedContentVersion": "Committed Content Version value",\
  "fileName": "File Name value",\
  "size": 4,\
  "applicableArchitectures": "x86",\
  "identityName": "Identity Name value",\
  "identityPublisherHash": "Identity Publisher Hash value",\
  "identityResourceIdentifier": "Identity Resource Identifier value",\
  "isBundle": true,\
  "minimumSupportedOperatingSystem": {\
    "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem",\
    "v8_0": true,\
    "v8_1": true,\
    "v10_0": true\
  },\
  "identityVersion": "Identity Version value"\
}\
'

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.NewMobileApp()
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName) 
description := "Description value"
requestBody.SetDescription(&description) 
publisher := "Publisher value"
requestBody.SetPublisher(&publisher) 
largeIcon := graphmodels.NewMimeContent()
type := "Type value"
largeIcon.SetType(&type) 
value := []byte("dmFsdWU=")
largeIcon.SetValue(&value) 
requestBody.SetLargeIcon(largeIcon)
isFeatured := true
requestBody.SetIsFeatured(&isFeatured) 
privacyInformationUrl := "https://example.com/privacyInformationUrl/"
requestBody.SetPrivacyInformationUrl(&privacyInformationUrl) 
informationUrl := "https://example.com/informationUrl/"
requestBody.SetInformationUrl(&informationUrl) 
owner := "Owner value"
requestBody.SetOwner(&owner) 
developer := "Developer value"
requestBody.SetDeveloper(&developer) 
notes := "Notes value"
requestBody.SetNotes(&notes) 
publishingState := graphmodels.PROCESSING_MOBILEAPPPUBLISHINGSTATE 
requestBody.SetPublishingState(&publishingState) 
committedContentVersion := "Committed Content Version value"
requestBody.SetCommittedContentVersion(&committedContentVersion) 
fileName := "File Name value"
requestBody.SetFileName(&fileName) 
size := int64(4)
requestBody.SetSize(&size) 
applicableArchitectures := graphmodels.X86_WINDOWSARCHITECTURE 
requestBody.SetApplicableArchitectures(&applicableArchitectures) 
identityName := "Identity Name value"
requestBody.SetIdentityName(&identityName) 
identityPublisherHash := "Identity Publisher Hash value"
requestBody.SetIdentityPublisherHash(&identityPublisherHash) 
identityResourceIdentifier := "Identity Resource Identifier value"
requestBody.SetIdentityResourceIdentifier(&identityResourceIdentifier) 
isBundle := true
requestBody.SetIsBundle(&isBundle) 
minimumSupportedOperatingSystem := graphmodels.NewWindowsMinimumOperatingSystem()
v8_0 := true
minimumSupportedOperatingSystem.SetV8_0(&v8_0) 
v8_1 := true
minimumSupportedOperatingSystem.SetV8_1(&v8_1) 
v10_0 := true
minimumSupportedOperatingSystem.SetV10_0(&v10_0) 
requestBody.SetMinimumSupportedOperatingSystem(minimumSupportedOperatingSystem)
identityVersion := "Identity Version value"
requestBody.SetIdentityVersion(&identityVersion) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mobileApps, err := graphClient.DeviceAppManagement().MobileApps().ByMobileAppId("mobileApp-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);

WindowsAppX mobileApp = new WindowsAppX();
mobileApp.setOdataType("#microsoft.graph.windowsAppX");
mobileApp.setDisplayName("Display Name value");
mobileApp.setDescription("Description value");
mobileApp.setPublisher("Publisher value");
MimeContent largeIcon = new MimeContent();
largeIcon.setOdataType("microsoft.graph.mimeContent");
largeIcon.setType("Type value");
byte[] value = Base64.getDecoder().decode("dmFsdWU=");
largeIcon.setValue(value);
mobileApp.setLargeIcon(largeIcon);
mobileApp.setIsFeatured(true);
mobileApp.setPrivacyInformationUrl("https://example.com/privacyInformationUrl/");
mobileApp.setInformationUrl("https://example.com/informationUrl/");
mobileApp.setOwner("Owner value");
mobileApp.setDeveloper("Developer value");
mobileApp.setNotes("Notes value");
mobileApp.setPublishingState(MobileAppPublishingState.Processing);
mobileApp.setCommittedContentVersion("Committed Content Version value");
mobileApp.setFileName("File Name value");
mobileApp.setSize(4L);
mobileApp.setApplicableArchitectures(EnumSet.of(WindowsArchitecture.X86));
mobileApp.setIdentityName("Identity Name value");
mobileApp.setIdentityPublisherHash("Identity Publisher Hash value");
mobileApp.setIdentityResourceIdentifier("Identity Resource Identifier value");
mobileApp.setIsBundle(true);
WindowsMinimumOperatingSystem minimumSupportedOperatingSystem = new WindowsMinimumOperatingSystem();
minimumSupportedOperatingSystem.setOdataType("microsoft.graph.windowsMinimumOperatingSystem");
minimumSupportedOperatingSystem.setV80(true);
minimumSupportedOperatingSystem.setV81(true);
minimumSupportedOperatingSystem.setV100(true);
mobileApp.setMinimumSupportedOperatingSystem(minimumSupportedOperatingSystem);
mobileApp.setIdentityVersion("Identity Version value");
MobileApp result = graphClient.deviceAppManagement().mobileApps().byMobileAppId("{mobileApp-id}").patch(mobileApp);

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 mobileApp = {
  '@odata.type': '#microsoft.graph.windowsAppX',
  displayName: 'Display Name value',
  description: 'Description value',
  publisher: 'Publisher value',
  largeIcon: {
    '@odata.type': 'microsoft.graph.mimeContent',
    type: 'Type value',
    value: 'dmFsdWU='
  },
  isFeatured: true,
  privacyInformationUrl: 'https://example.com/privacyInformationUrl/',
  informationUrl: 'https://example.com/informationUrl/',
  owner: 'Owner value',
  developer: 'Developer value',
  notes: 'Notes value',
  publishingState: 'processing',
  committedContentVersion: 'Committed Content Version value',
  fileName: 'File Name value',
  size: 4,
  applicableArchitectures: 'x86',
  identityName: 'Identity Name value',
  identityPublisherHash: 'Identity Publisher Hash value',
  identityResourceIdentifier: 'Identity Resource Identifier value',
  isBundle: true,
  minimumSupportedOperatingSystem: {
    '@odata.type': 'microsoft.graph.windowsMinimumOperatingSystem',
    v8_0: true,
    v8_1: true,
    v10_0: true
  },
  identityVersion: 'Identity Version value'
};

await client.api('/deviceAppManagement/mobileApps/{mobileAppId}')
	.update(mobileApp);

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\WindowsAppX;
use Microsoft\Graph\Generated\Models\MimeContent;
use Microsoft\Graph\Generated\Models\MobileAppPublishingState;
use Microsoft\Graph\Generated\Models\WindowsArchitecture;
use Microsoft\Graph\Generated\Models\WindowsMinimumOperatingSystem;


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

$requestBody = new WindowsAppX();
$requestBody->setOdataType('#microsoft.graph.windowsAppX');
$requestBody->setDisplayName('Display Name value');
$requestBody->setDescription('Description value');
$requestBody->setPublisher('Publisher value');
$largeIcon = new MimeContent();
$largeIcon->setOdataType('microsoft.graph.mimeContent');
$largeIcon->setType('Type value');
$largeIcon->setValue(\GuzzleHttp\Psr7\Utils::streamFor(base64_decode('dmFsdWU=')));
$requestBody->setLargeIcon($largeIcon);
$requestBody->setIsFeatured(true);
$requestBody->setPrivacyInformationUrl('https://example.com/privacyInformationUrl/');
$requestBody->setInformationUrl('https://example.com/informationUrl/');
$requestBody->setOwner('Owner value');
$requestBody->setDeveloper('Developer value');
$requestBody->setNotes('Notes value');
$requestBody->setPublishingState(new MobileAppPublishingState('processing'));
$requestBody->setCommittedContentVersion('Committed Content Version value');
$requestBody->setFileName('File Name value');
$requestBody->setSize(4);
$requestBody->setApplicableArchitectures(new WindowsArchitecture('x86'));
$requestBody->setIdentityName('Identity Name value');
$requestBody->setIdentityPublisherHash('Identity Publisher Hash value');
$requestBody->setIdentityResourceIdentifier('Identity Resource Identifier value');
$requestBody->setIsBundle(true);
$minimumSupportedOperatingSystem = new WindowsMinimumOperatingSystem();
$minimumSupportedOperatingSystem->setOdataType('microsoft.graph.windowsMinimumOperatingSystem');
$minimumSupportedOperatingSystem->setV80(true);
$minimumSupportedOperatingSystem->setV81(true);
$minimumSupportedOperatingSystem->setV100(true);
$requestBody->setMinimumSupportedOperatingSystem($minimumSupportedOperatingSystem);
$requestBody->setIdentityVersion('Identity Version value');

$result = $graphServiceClient->deviceAppManagement()->mobileApps()->byMobileAppId('mobileApp-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.Devices.CorporateManagement

$params = @{
	"@odata.type" = "#microsoft.graph.windowsAppX"
	displayName = "Display Name value"
	description = "Description value"
	publisher = "Publisher value"
	largeIcon = @{
		"@odata.type" = "microsoft.graph.mimeContent"
		type = "Type value"
		value = [System.Text.Encoding]::ASCII.GetBytes("dmFsdWU=")
	}
	isFeatured = $true
	privacyInformationUrl = "https://example.com/privacyInformationUrl/"
	informationUrl = "https://example.com/informationUrl/"
	owner = "Owner value"
	developer = "Developer value"
	notes = "Notes value"
	publishingState = "processing"
	committedContentVersion = "Committed Content Version value"
	fileName = "File Name value"
	size = 
	applicableArchitectures = "x86"
	identityName = "Identity Name value"
	identityPublisherHash = "Identity Publisher Hash value"
	identityResourceIdentifier = "Identity Resource Identifier value"
	isBundle = $true
	minimumSupportedOperatingSystem = @{
		"@odata.type" = "microsoft.graph.windowsMinimumOperatingSystem"
		v8_0 = $true
		v8_1 = $true
		v10_0 = $true
	}
	identityVersion = "Identity Version value"
}

Update-MgDeviceAppManagementMobileApp -MobileAppId $mobileAppId -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.windows_app_x import WindowsAppX
from msgraph.generated.models.mime_content import MimeContent
from msgraph.generated.models.mobile_app_publishing_state import MobileAppPublishingState
from msgraph.generated.models.windows_architecture import WindowsArchitecture
from msgraph.generated.models.windows_minimum_operating_system import WindowsMinimumOperatingSystem
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = WindowsAppX(
	odata_type = "#microsoft.graph.windowsAppX",
	display_name = "Display Name value",
	description = "Description value",
	publisher = "Publisher value",
	large_icon = MimeContent(
		odata_type = "microsoft.graph.mimeContent",
		type = "Type value",
		value = base64.urlsafe_b64decode("dmFsdWU="),
	),
	is_featured = True,
	privacy_information_url = "https://example.com/privacyInformationUrl/",
	information_url = "https://example.com/informationUrl/",
	owner = "Owner value",
	developer = "Developer value",
	notes = "Notes value",
	publishing_state = MobileAppPublishingState.Processing,
	committed_content_version = "Committed Content Version value",
	file_name = "File Name value",
	size = 4,
	applicable_architectures = WindowsArchitecture.X86,
	identity_name = "Identity Name value",
	identity_publisher_hash = "Identity Publisher Hash value",
	identity_resource_identifier = "Identity Resource Identifier value",
	is_bundle = True,
	minimum_supported_operating_system = WindowsMinimumOperatingSystem(
		odata_type = "microsoft.graph.windowsMinimumOperatingSystem",
		v8_0 = True,
		v8_1 = True,
		v10_0 = True,
	),
	identity_version = "Identity Version value",
)

result = await graph_client.device_app_management.mobile_apps.by_mobile_app_id('mobileApp-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: 1313

{
  "@odata.type": "#microsoft.graph.windowsAppX",
  "id": "b5179a93-9a93-b517-939a-17b5939a17b5",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "publishingState": "processing",
  "committedContentVersion": "Committed Content Version value",
  "fileName": "File Name value",
  "size": 4,
  "applicableArchitectures": "x86",
  "identityName": "Identity Name value",
  "identityPublisherHash": "Identity Publisher Hash value",
  "identityResourceIdentifier": "Identity Resource Identifier value",
  "isBundle": true,
  "minimumSupportedOperatingSystem": {
    "@odata.type": "microsoft.graph.windowsMinimumOperatingSystem",
    "v8_0": true,
    "v8_1": true,
    "v10_0": true
  },
  "identityVersion": "Identity Version value"
}

Share via

Update windowsAppX

Permissions

HTTP Request

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources