Create deviceHealthScriptAssignment
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.
Create a new deviceHealthScriptAssignment 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.Read.All, DeviceManagementConfiguration.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All |
HTTP Request
POST /deviceManagement/deviceHealthScripts/{deviceHealthScriptId}/assignments
POST /deviceManagement/deviceComplianceScripts/{deviceComplianceScriptId}/assignments
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 deviceHealthScriptAssignment object.
The following table shows the properties that are required when you create the deviceHealthScriptAssignment.
Property | Type | Description |
---|---|---|
id | String | Key of the device health script assignment entity. This property is read-only. |
target | deviceAndAppManagementAssignmentTarget | The Azure Active Directory group we are targeting the script to |
runRemediationScript | Boolean | Determine whether we want to run detection script only or run both detection script and remediation script |
runSchedule | deviceHealthScriptRunSchedule | Script run schedule for the target group |
Response
If successful, this method returns a 201 Created
response code and a deviceHealthScriptAssignment object in the response body.
Example
Request
Here is an example of the request.
POST https://graph.microsoft.com/beta/deviceManagement/deviceHealthScripts/{deviceHealthScriptId}/assignments
Content-type: application/json
Content-length: 590
{
"@odata.type": "#microsoft.graph.deviceHealthScriptAssignment",
"target": {
"@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget",
"deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value",
"deviceAndAppManagementAssignmentFilterType": "include",
"collectionId": "Collection Id value"
},
"runRemediationScript": true,
"runSchedule": {
"@odata.type": "microsoft.graph.deviceHealthScriptDailySchedule",
"interval": 8,
"useUtc": true,
"time": "11:58:36.2550000"
}
}
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 201 Created
Content-Type: application/json
Content-Length: 639
{
"@odata.type": "#microsoft.graph.deviceHealthScriptAssignment",
"id": "c08c4eb1-4eb1-c08c-b14e-8cc0b14e8cc0",
"target": {
"@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget",
"deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value",
"deviceAndAppManagementAssignmentFilterType": "include",
"collectionId": "Collection Id value"
},
"runRemediationScript": true,
"runSchedule": {
"@odata.type": "microsoft.graph.deviceHealthScriptDailySchedule",
"interval": 8,
"useUtc": true,
"time": "11:58:36.2550000"
}
}