Create deviceCompliancePolicySettingStateSummary
Article
11/30/2023
11 contributors
Feedback
In this article
Namespace: microsoft.graph
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Create a new deviceCompliancePolicySettingStateSummary 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
Delegated (personal Microsoft account)
Not supported.
Application
DeviceManagementConfiguration.ReadWrite.All
HTTP Request
POST /deviceManagement/deviceCompliancePolicySettingStateSummaries
Request body
In the request body, supply a JSON representation for the deviceCompliancePolicySettingStateSummary object.
The following table shows the properties that are required when you create the deviceCompliancePolicySettingStateSummary.
Property
Type
Description
id
String
Key of the entity.
setting
String
The setting class name and property name.
settingName
String
Name of the setting.
platformType
policyPlatformType
Setting platform. Possible values are: android
, iOS
, macOS
, windowsPhone81
, windows81AndLater
, windows10AndLater
, androidWorkProfile
, all
.
unknownDeviceCount
Int32
Number of unknown devices
notApplicableDeviceCount
Int32
Number of not applicable devices
compliantDeviceCount
Int32
Number of compliant devices
remediatedDeviceCount
Int32
Number of remediated devices
nonCompliantDeviceCount
Int32
Number of NonCompliant devices
errorDeviceCount
Int32
Number of error devices
conflictDeviceCount
Int32
Number of conflict devices
Response
If successful, this method returns a 201 Created
response code and a deviceCompliancePolicySettingStateSummary object in the response body.
Example
Request
Here is an example of the request.
POST https://graph.microsoft.com/v1.0/deviceManagement/deviceCompliancePolicySettingStateSummaries
Content-type: application/json
Content-length: 391
{
"@odata.type": "#microsoft.graph.deviceCompliancePolicySettingStateSummary",
"setting": "Setting value",
"settingName": "Setting Name value",
"platformType": "iOS",
"unknownDeviceCount": 2,
"notApplicableDeviceCount": 8,
"compliantDeviceCount": 4,
"remediatedDeviceCount": 5,
"nonCompliantDeviceCount": 7,
"errorDeviceCount": 0,
"conflictDeviceCount": 3
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new DeviceCompliancePolicySettingStateSummary
{
OdataType = "#microsoft.graph.deviceCompliancePolicySettingStateSummary",
Setting = "Setting value",
SettingName = "Setting Name value",
PlatformType = PolicyPlatformType.IOS,
UnknownDeviceCount = 2,
NotApplicableDeviceCount = 8,
CompliantDeviceCount = 4,
RemediatedDeviceCount = 5,
NonCompliantDeviceCount = 7,
ErrorDeviceCount = 0,
ConflictDeviceCount = 3,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.DeviceCompliancePolicySettingStateSummaries.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc device-management device-compliance-policy-setting-state-summaries create --body '{\
"@odata.type": "#microsoft.graph.deviceCompliancePolicySettingStateSummary",\
"setting": "Setting value",\
"settingName": "Setting Name value",\
"platformType": "iOS",\
"unknownDeviceCount": 2,\
"notApplicableDeviceCount": 8,\
"compliantDeviceCount": 4,\
"remediatedDeviceCount": 5,\
"nonCompliantDeviceCount": 7,\
"errorDeviceCount": 0,\
"conflictDeviceCount": 3\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodels.NewDeviceCompliancePolicySettingStateSummary()
setting := "Setting value"
requestBody.SetSetting(&setting)
settingName := "Setting Name value"
requestBody.SetSettingName(&settingName)
platformType := graphmodels.IOS_POLICYPLATFORMTYPE
requestBody.SetPlatformType(&platformType)
unknownDeviceCount := int32(2)
requestBody.SetUnknownDeviceCount(&unknownDeviceCount)
notApplicableDeviceCount := int32(8)
requestBody.SetNotApplicableDeviceCount(¬ApplicableDeviceCount)
compliantDeviceCount := int32(4)
requestBody.SetCompliantDeviceCount(&compliantDeviceCount)
remediatedDeviceCount := int32(5)
requestBody.SetRemediatedDeviceCount(&remediatedDeviceCount)
nonCompliantDeviceCount := int32(7)
requestBody.SetNonCompliantDeviceCount(&nonCompliantDeviceCount)
errorDeviceCount := int32(0)
requestBody.SetErrorDeviceCount(&errorDeviceCount)
conflictDeviceCount := int32(3)
requestBody.SetConflictDeviceCount(&conflictDeviceCount)
deviceCompliancePolicySettingStateSummaries, err := graphClient.DeviceManagement().DeviceCompliancePolicySettingStateSummaries().Post(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);
DeviceCompliancePolicySettingStateSummary deviceCompliancePolicySettingStateSummary = new DeviceCompliancePolicySettingStateSummary();
deviceCompliancePolicySettingStateSummary.setOdataType("#microsoft.graph.deviceCompliancePolicySettingStateSummary");
deviceCompliancePolicySettingStateSummary.setSetting("Setting value");
deviceCompliancePolicySettingStateSummary.setSettingName("Setting Name value");
deviceCompliancePolicySettingStateSummary.setPlatformType(PolicyPlatformType.IOS);
deviceCompliancePolicySettingStateSummary.setUnknownDeviceCount(2);
deviceCompliancePolicySettingStateSummary.setNotApplicableDeviceCount(8);
deviceCompliancePolicySettingStateSummary.setCompliantDeviceCount(4);
deviceCompliancePolicySettingStateSummary.setRemediatedDeviceCount(5);
deviceCompliancePolicySettingStateSummary.setNonCompliantDeviceCount(7);
deviceCompliancePolicySettingStateSummary.setErrorDeviceCount(0);
deviceCompliancePolicySettingStateSummary.setConflictDeviceCount(3);
DeviceCompliancePolicySettingStateSummary result = graphClient.deviceManagement().deviceCompliancePolicySettingStateSummaries().post(deviceCompliancePolicySettingStateSummary);
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 deviceCompliancePolicySettingStateSummary = {
'@odata.type': '#microsoft.graph.deviceCompliancePolicySettingStateSummary',
setting: 'Setting value',
settingName: 'Setting Name value',
platformType: 'iOS',
unknownDeviceCount: 2,
notApplicableDeviceCount: 8,
compliantDeviceCount: 4,
remediatedDeviceCount: 5,
nonCompliantDeviceCount: 7,
errorDeviceCount: 0,
conflictDeviceCount: 3
};
await client.api('/deviceManagement/deviceCompliancePolicySettingStateSummaries')
.post(deviceCompliancePolicySettingStateSummary);
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\DeviceCompliancePolicySettingStateSummary;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new DeviceCompliancePolicySettingStateSummary();
$requestBody->setOdataType('#microsoft.graph.deviceCompliancePolicySettingStateSummary');
$requestBody->setSetting('Setting value');
$requestBody->setSettingName('Setting Name value');
$requestBody->setPlatformType(new PolicyPlatformType('iOS'));
$requestBody->setUnknownDeviceCount(2);
$requestBody->setNotApplicableDeviceCount(8);
$requestBody->setCompliantDeviceCount(4);
$requestBody->setRemediatedDeviceCount(5);
$requestBody->setNonCompliantDeviceCount(7);
$requestBody->setErrorDeviceCount(0);
$requestBody->setConflictDeviceCount(3);
$result = $graphServiceClient->deviceManagement()->deviceCompliancePolicySettingStateSummaries()->post($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.DeviceManagement
$params = @{
"@odata.type" = "#microsoft.graph.deviceCompliancePolicySettingStateSummary"
setting = "Setting value"
settingName = "Setting Name value"
platformType = "iOS"
unknownDeviceCount = 2
notApplicableDeviceCount = 8
compliantDeviceCount = 4
remediatedDeviceCount = 5
nonCompliantDeviceCount = 7
errorDeviceCount = 0
conflictDeviceCount = 3
}
New-MgDeviceManagementDeviceCompliancePolicySettingStateSummary -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
from msgraph import GraphServiceClient
from msgraph.generated.models.device_compliance_policy_setting_state_summary import DeviceCompliancePolicySettingStateSummary
graph_client = GraphServiceClient(credentials, scopes)
request_body = DeviceCompliancePolicySettingStateSummary(
odata_type = "#microsoft.graph.deviceCompliancePolicySettingStateSummary",
setting = "Setting value",
setting_name = "Setting Name value",
platform_type = PolicyPlatformType.IOS,
unknown_device_count = 2,
not_applicable_device_count = 8,
compliant_device_count = 4,
remediated_device_count = 5,
non_compliant_device_count = 7,
error_device_count = 0,
conflict_device_count = 3,
)
result = await graph_client.device_management.device_compliance_policy_setting_state_summaries.post(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 201 Created
Content-Type: application/json
Content-Length: 440
{
"@odata.type": "#microsoft.graph.deviceCompliancePolicySettingStateSummary",
"id": "7474d6d5-d6d5-7474-d5d6-7474d5d67474",
"setting": "Setting value",
"settingName": "Setting Name value",
"platformType": "iOS",
"unknownDeviceCount": 2,
"notApplicableDeviceCount": 8,
"compliantDeviceCount": 4,
"remediatedDeviceCount": 5,
"nonCompliantDeviceCount": 7,
"errorDeviceCount": 0,
"conflictDeviceCount": 3
}