List instances

2025-04-16

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.

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

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

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.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	UserWindowsSettings.Read	UserWindowsSettings.Read.All
Delegated (personal Microsoft account)	UserWindowsSettings.Read	Not available.
Application	Not supported.	Not supported.

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.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Settings.Windows["{windowsSetting-id}"].Instances.GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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 major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
instances, err := graphClient.Me().Settings().Windows().ByWindowsSettingId("windowsSetting-id").Instances().Get(context.Background(), nil)

Important

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);

WindowsSettingInstanceCollectionResponse result = graphClient.me().settings().windows().byWindowsSettingId("{windowsSetting-id}").instances().get();

Important

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);

let instances = await client.api('/me/settings/windows/{windowsSettingId}/instances')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->settings()->windows()->byWindowsSettingId('windowsSetting-id')->instances()->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Users

# A UPN can also be used as -UserId.
Get-MgBetaUserSettingWindowsInstance -UserId $userId -WindowsSettingId $windowsSettingId

Important

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 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.settings.windows.by_windows_setting_id('windowsSetting-id').instances.get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the 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"
    }
  ]
}

Share via

List instances

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources