windowsOfficeClientConfiguration resource type

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.

Entity that describes office policy settings for Windows.

Inherits from officeClientConfiguration

Methods

Method Return Type Description
List windowsOfficeClientConfigurations windowsOfficeClientConfiguration collection List properties and relationships of the windowsOfficeClientConfiguration objects.
Get windowsOfficeClientConfiguration windowsOfficeClientConfiguration Read properties and relationships of the windowsOfficeClientConfiguration object.
Create windowsOfficeClientConfiguration windowsOfficeClientConfiguration Create a new windowsOfficeClientConfiguration object.
Delete windowsOfficeClientConfiguration None Deletes a windowsOfficeClientConfiguration.
Update windowsOfficeClientConfiguration windowsOfficeClientConfiguration Update the properties of a windowsOfficeClientConfiguration object.

Properties

Property Type Description
id String Id of the office client configuration policy. Inherited from officeClientConfiguration
userPreferencePayload Stream Preference settings JSON string in binary format, these values can be overridden by the user. Inherited from officeClientConfiguration
policyPayload Stream Policy settings JSON string in binary format, these values cannot be changed by the user. Inherited from officeClientConfiguration
description String Admin provided description of the office client configuration policy. Inherited from officeClientConfiguration
displayName String Admin provided name of the office client configuration policy. Inherited from officeClientConfiguration
priority Int32 Priority value should be unique value for each policy under a tenant and will be used for conflict resolution, lower values mean priority is high. Inherited from officeClientConfiguration
lastModifiedDateTime DateTime Last modified datetime stamp of the policy. Inherited from officeClientConfiguration
userCheckinSummary officeUserCheckinSummary User check-in summary for the policy. Inherited from officeClientConfiguration
checkinStatuses officeClientCheckinStatus collection List of office Client check-in status. Inherited from officeClientConfiguration

Relationships

Relationship Type Description
assignments officeClientConfigurationAssignment collection The list of group assignments for the policy. Inherited from officeClientConfiguration

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.windowsOfficeClientConfiguration",
  "id": "String (identifier)",
  "userPreferencePayload": "<Unknown Primitive Type Edm.Stream>",
  "policyPayload": "<Unknown Primitive Type Edm.Stream>",
  "description": "String",
  "displayName": "String",
  "priority": 1024,
  "userCheckinSummary": {
    "@odata.type": "microsoft.graph.officeUserCheckinSummary",
    "succeededUserCount": 1024,
    "failedUserCount": 1024
  },
  "checkinStatuses": [
    {
      "@odata.type": "microsoft.graph.officeClientCheckinStatus",
      "userPrincipalName": "String",
      "deviceName": "String",
      "devicePlatform": "String",
      "devicePlatformVersion": "String",
      "wasSuccessful": true,
      "userId": "String",
      "checkinDateTime": "String (timestamp)",
      "errorMessage": "String",
      "appliedPolicies": [
        "String"
      ]
    }
  ]
}