Update deviceLogCollectionResponse

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 deviceLogCollectionResponse 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, DeviceManagementManagedDevices.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All

HTTP Request

PATCH /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/logCollectionRequests/{deviceLogCollectionResponseId}

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 deviceLogCollectionResponse object.

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

Property Type Description
id String The unique identifier in the form of tenantId_deviceId_requestId.
status appLogUploadState Indicates the status for the app log collection request if it is pending, completed or failed, Default is pending. Possible values are: pending, completed, failed, unknownFutureValue.
managedDeviceId Guid Indicates Intune device unique identifier.
errorCode Int64 The error code, if any. Valid values -9.22337203685478E+18 to 9.22337203685478E+18
requestedDateTimeUTC DateTimeOffset The DateTime of the request.
receivedDateTimeUTC DateTimeOffset The DateTime the request was received.
initiatedByUserPrincipalName String The UPN for who initiated the request.
expirationDateTimeUTC DateTimeOffset The DateTime of the expiration of the logs.
size Double The size of the logs. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
sizeInKB Double The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
enrolledByUser String The User Principal Name (UPN) of the user that enrolled the device.

Response

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

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/logCollectionRequests/{deviceLogCollectionResponseId}
Content-type: application/json
Content-length: 558

{
  "@odata.type": "#microsoft.graph.deviceLogCollectionResponse",
  "status": "completed",
  "managedDeviceId": "3b336f00-6f00-3b33-006f-333b006f333b",
  "errorCode": 9,
  "requestedDateTimeUTC": "2016-12-31T23:57:40.7845755-08:00",
  "receivedDateTimeUTC": "2016-12-31T23:59:48.6545758-08:00",
  "initiatedByUserPrincipalName": "Initiated By User Principal Name value",
  "expirationDateTimeUTC": "2017-01-01T00:02:49.2157996-08:00",
  "size": 1.3333333333333333,
  "sizeInKB": 2.6666666666666665,
  "enrolledByUser": "Enrolled By User value"
}

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: 607

{
  "@odata.type": "#microsoft.graph.deviceLogCollectionResponse",
  "id": "05fb97dc-97dc-05fb-dc97-fb05dc97fb05",
  "status": "completed",
  "managedDeviceId": "3b336f00-6f00-3b33-006f-333b006f333b",
  "errorCode": 9,
  "requestedDateTimeUTC": "2016-12-31T23:57:40.7845755-08:00",
  "receivedDateTimeUTC": "2016-12-31T23:59:48.6545758-08:00",
  "initiatedByUserPrincipalName": "Initiated By User Principal Name value",
  "expirationDateTimeUTC": "2017-01-01T00:02:49.2157996-08:00",
  "size": 1.3333333333333333,
  "sizeInKB": 2.6666666666666665,
  "enrolledByUser": "Enrolled By User value"
}