Skip to content

windowssetting-list-instances.md

Latest commit

 

History

History
151 lines (115 loc) · 5.43 KB

windowssetting-list-instances.md

File metadata and controls

151 lines (115 loc) · 5.43 KB
title List instances
description Get a list of windowsSettingInstance objects and their properties for a user.
author MS-Arko
ms.localizationpriority medium
ms.subservice project-rome
doc_type apiPageType
ms.date 04/19/2024

List instances

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of windowsSettingInstance objects and their properties for a user.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

Note

  • The calling user must be assigned the Microsoft 365 Backup Administrator Microsoft Entra role.
  • The UserWindowsSettings.Read permission allows the app to read the settings of only the signed-in user.
  • The UserWindowsSettings.Read.All permission allows the app to read the settings of a specific user.

HTTP request

For a specific user:

GET /users/{user-id}@{tenant-id}/settings/windows/{windowsSettingId}/instances

Note

The {tenant-id} value must match the tenant ID of the calling user. To find your tenant ID, see How to find your Microsoft Entra tenant ID.

For the signed-in user:

GET /me/settings/windows/{windowsSettingId}/instances

Optional query parameters

This method doesn't support OData query parameters to customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of windowsSettingInstance objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId}/instances

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.windowsSettingInstance",
      "id": "9715f1d9-49d1-4b94-041b-443ac419d417",
      "payload": "VGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUh",
      "lastModifiedDateTime": "2024-10-31T23:30:41Z",
      "createdDateTime": "2024-02-12T19:34:35.223Z",
      "expirationDateTime": "2034-02-09T19:34:33.771Z"
    },
    {
      "@odata.type": "#microsoft.graph.windowsSettingInstance",
      "id": "6984732f-86b0-8e31-dc02-37fce0df6d61",
      "payload": "VGhpcyBpcyBhbm90aGVyIGp1c3QgYW4gZXhhbXBsZSE=",
      "lastModifiedDateTime": "2024-10-31T23:30:41Z",
      "createdDateTime": "2024-02-12T19:34:35.223Z",
      "expirationDateTime": "2034-02-09T19:34:33.771Z"
    }
  ]
}