Update macOSSoftwareUpdateStateSummary
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 macOSSoftwareUpdateStateSummary 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 |
Delegated (personal Microsoft account) | Not supported. |
Application | DeviceManagementConfiguration.ReadWrite.All |
PATCH /deviceManagement/macOSSoftwareUpdateAccountSummaries/{macOSSoftwareUpdateAccountSummaryId}/categorySummaries/{macOSSoftwareUpdateCategorySummaryId}/updateStateSummaries/{macOSSoftwareUpdateStateSummaryId}
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 macOSSoftwareUpdateStateSummary object.
The following table shows the properties that are required when you create the macOSSoftwareUpdateStateSummary.
Property | Type | Description |
---|---|---|
id | String | Key of the entity. |
displayName | String | Human readable name of the software update |
productKey | String | Product key of the software update. |
updateCategory | macOSSoftwareUpdateCategory | Software update category. Possible values are: critical , configurationDataFile , firmware , other . |
updateVersion | String | Version of the software update |
state | macOSSoftwareUpdateState | State of the software update. Possible values are: success , downloading , downloaded , installing , idle , available , scheduled , downloadFailed , downloadInsufficientSpace , downloadInsufficientPower , downloadInsufficientNetwork , installInsufficientSpace , installInsufficientPower , installFailed , commandFailed . |
lastUpdatedDateTime | DateTimeOffset | Last date time the report for this device and product key was updated. |
If successful, this method returns a 200 OK
response code and an updated macOSSoftwareUpdateStateSummary object in the response body.
Here is an example of the request.
PATCH https://graph.microsoft.com/beta/deviceManagement/macOSSoftwareUpdateAccountSummaries/{macOSSoftwareUpdateAccountSummaryId}/categorySummaries/{macOSSoftwareUpdateCategorySummaryId}/updateStateSummaries/{macOSSoftwareUpdateStateSummaryId}
Content-type: application/json
Content-length: 331
{
"@odata.type": "#microsoft.graph.macOSSoftwareUpdateStateSummary",
"displayName": "Display Name value",
"productKey": "Product Key value",
"updateCategory": "configurationDataFile",
"updateVersion": "Update Version value",
"state": "downloading",
"lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00"
}
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: 380
{
"@odata.type": "#microsoft.graph.macOSSoftwareUpdateStateSummary",
"id": "9527a1df-a1df-9527-dfa1-2795dfa12795",
"displayName": "Display Name value",
"productKey": "Product Key value",
"updateCategory": "configurationDataFile",
"updateVersion": "Update Version value",
"state": "downloading",
"lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00"
}