Edit

Share via

windowsSetting resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents settings from the Windows operating system that are stored in the cloud for a given user.

Warning

The structure of the ID of a windowsSetting is not guaranteed and the caller should not take any dependency on it. The ID should be treated as an opaque string.

Windows settings can be of the following two types: roaming and backup.

Inherits from entity.

Methods

Method Return type Description
List windowsSetting collection Get a list of the windowsSetting objects and their properties.
Get windowsSetting Read the properties and relationships of a windowsSetting object.
List instances windowsSettingInstance collection Read the properties and relationships of a windowsSettingInstance object by passing the Windows setting ID and Windows setting instance ID in the URL.

Properties

Property Type Description
id String The unique identifier of the object.
payloadType String The type of setting payloads contained in the instances navigation property.
settingType windowsSettingType The type of setting. Possible values are: roaming, backup, unknownFutureValue.
windowsDeviceId String A unique identifier for the device the setting might belong to if it is of the settingType backup.

Relationships

Relationship Type Description
instances windowsSettingInstance collection A collection of setting values for a given windowsSetting.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.windowsSetting",
  "id": "{67585f9f-ee4b-4dd8-808e-d88375d66ef7}$windows.data.apps.devicemetadata",
  "windowsDeviceId": "67585f9f-ee4b-4dd8-808e-d88375d66ef7",
  "settingType": "backup",
  "payloadType": "windows.data.apps.devicemetadata",
  "instances": [
            {
                "id": "14b50191-10e5-4da5-9099-8c909b8458bd",
                "payload": "VGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUh",
                "lastModifiedDateTime": "2024-10-31T23:30:41Z",
                "createdDateTime": "2024-02-12T19:34:35.223Z",
                "expirationDateTime": "2034-02-09T19:34:33.771Z"
            }
        ]
}