Update winGetApp
Namespace: microsoft.graph
Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Update the properties of a winGetApp object.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
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, DeviceManagementApps.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All |
PATCH /deviceAppManagement/mobileApps/{mobileAppId}
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Accept | application/json |
In the request body, supply a JSON representation for the winGetApp object.
The following table shows the properties that are required when you create the winGetApp.
Property | Type | Description |
---|---|---|
id | String | Key of the entity. This property is read-only. 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. This property is read-only. Inherited from mobileApp |
lastModifiedDateTime | DateTimeOffset | The date and time the app was last modified. This property is read-only. 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 |
uploadState | Int32 | The upload state. Possible values are: 0 - Not Ready , 1 - Ready , 2 - Processing . This property is read-only. Inherited from mobileApp |
publishingState | mobileAppPublishingState | The publishing state for the app. The app cannot be assigned unless the app is published. This property is read-only. Inherited from mobileApp. Possible values are: notPublished , processing , published . |
isAssigned | Boolean | The value indicating whether the app is assigned to at least one group. This property is read-only. Inherited from mobileApp |
roleScopeTagIds | String collection | List of scope tag ids for this mobile app. Inherited from mobileApp |
dependentAppCount | Int32 | The total number of dependencies the child app has. This property is read-only. Inherited from mobileApp |
supersedingAppCount | Int32 | The total number of apps this app directly or indirectly supersedes. This property is read-only. Inherited from mobileApp |
supersededAppCount | Int32 | The total number of apps this app is directly or indirectly superseded by. This property is read-only. Inherited from mobileApp |
manifestHash | String | Hash of package metadata properties used to validate that the application matches the metadata in the source repository. |
packageIdentifier | String | The PackageIdentifier from the WinGet source repository REST API. This also maps to the Id when using the WinGet client command line application. Required at creation time, cannot be modified on existing objects. |
installExperience | winGetAppInstallExperience | The install experience settings associated with this application, which are used to ensure the desired install experiences on the target device are taken into account. This includes the account type (System or User) that actions should be run as on target devices. Required at creation time. |
If successful, this method returns a 200 OK
response code and an updated winGetApp object in the response body.
Here is an example of the request.
PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}
Content-type: application/json
Content-length: 985
{
"@odata.type": "#microsoft.graph.winGetApp",
"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",
"uploadState": 11,
"publishingState": "processing",
"isAssigned": true,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"dependentAppCount": 1,
"supersedingAppCount": 3,
"supersededAppCount": 2,
"manifestHash": "Manifest Hash value",
"packageIdentifier": "Package Identifier value",
"installExperience": {
"@odata.type": "microsoft.graph.winGetAppInstallExperience",
"runAsAccount": "user"
}
}
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: 1157
{
"@odata.type": "#microsoft.graph.winGetApp",
"id": "22032c2e-2c2e-2203-2e2c-03222e2c0322",
"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",
"uploadState": 11,
"publishingState": "processing",
"isAssigned": true,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"dependentAppCount": 1,
"supersedingAppCount": 3,
"supersededAppCount": 2,
"manifestHash": "Manifest Hash value",
"packageIdentifier": "Package Identifier value",
"installExperience": {
"@odata.type": "microsoft.graph.winGetAppInstallExperience",
"runAsAccount": "user"
}
}