Listar configurações do Windows

Artigo
04/22/2024

Namespace: microsoft.graph

Obtenha uma lista de objetos windowsSetting e suas propriedades para o usuário conectado.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	UserWindowsSettings.Read	Indisponível.
Delegado (conta pessoal da Microsoft)	UserWindowsSettings.Read	Indisponível.
Aplicativo	Sem suporte.	Sem suporte.

Solicitação HTTP

GET /me/settings/windows

Parâmetros de consulta opcionais

Esse método dá suporte ao $filter parâmetro de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Você pode filtrar os resultados pelas seguintes propriedades:

windowsDeviceId: um valor de cadeia de caracteres que representa o identificador exclusivo de um dispositivo Windows. Esse identificador pode ser encontrado no corpo da resposta. Ao filtrar no windowsDeviceId, você pode obter uma lista de configurações específicas para esse dispositivo. Há suporte apenas para a comparação de igualdade (eq) para esse parâmetro.
settingType: uma enumeração com os seguintes valores válidos: roaming e backup. A propriedade settingType permite que você reduza os resultados a configurações relacionadas a roaming ou backup. Há suporte apenas para a comparação de igualdade (eq) para esse parâmetro. Para obter mais informações, consulte windowsSettingType.

Para obter mais detalhes sobre como usar esse parâmetro de consulta, consulte a seção Exemplos .

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Preferir	Opcional. Essa API dá suporte ao parâmetro odata.maxpagesize por meio desse cabeçalho para fins de paginação. Os valores mínimos e máximos válidos para odata.maxpagesize são 1 e 200 , respectivamente. Se nenhum valor for passado, o valor padrão será 110.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos windowsSetting no corpo da resposta.

Se a resposta contiver mais de uma página de dados, o corpo da resposta conterá uma @odata.nextLink propriedade. Essa propriedade conterá uma URL que pode ser usada para solicitar a próxima página de dados. A URL deve ser usada sem nenhuma modificação.

Exemplos

Exemplo 1: Solicitar sem nenhum filtro

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/settings/windows


// 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.GetAsync();


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users settings windows list --user-id {user-id}



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



windows, err := graphClient.Me().Settings().Windows().Get(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

WindowsSettingCollectionResponse result = graphClient.me().settings().windows().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let windows = await client.api('/me/settings/windows')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->me()->settings()->windows()->get()->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserSettingWindows -UserId $userId


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.me.settings.windows.get()

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.windowsSetting",
      "id": "default$windows.data.fileexplorerclassic.searchsettings",
      "windowsDeviceId": "c9e0f7d8-2b1a-4f6e-9b7c-8e3a1a3e5b0d",
      "settingType": "backup",
      "payloadType": "windows.data.fileexplorerclassic.searchsettings",
      "instances": [
                {
                    "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.windowsSetting",
      "id": "default$windows.data.input.devices.pensyncedsettings",
      "windowsDeviceId": "a4b9d6e7-8f3c-4d2a-b1e0-6c5f0e9a7d8b",
      "settingType": "backup",
      "payloadType": "windows.data.input.devices.pensyncedsettings",
      "instances": [
                {
                    "id": "666dcb9b-49d1-4b94-041b-443ac419d417",
                    "payload": "VGhpcyBpcyBhbm90aGVyIGp1c3QgYW4gZXhhbXBsZSE=",
                    "lastModifiedDateTime": "2024-10-31T23:30:41Z",
                    "createdDateTime": "2024-02-12T19:34:35.223Z",
                    "expirationDateTime": "2034-02-09T19:34:33.771Z"
                }
            ]
    }
  ],
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/settings/windows?$skiptoken=eyJzZXRhZyI6ImJmY2I2ZjQwLWM5ZGQtMTFlZS05MTE3LTAxMDIwMzA1MDcwZCIsImlldGFnIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIiwiZW5kRVRhZyI6IjEwMDJkOGYwLWM2NTItMTRkYy05MTE3LTAxMDIwMzA1MDcwZCIsImV0YWciOiJjMDMzZjUxMC1jOWRkLTExZWUtOTExNy0wMTAyMDMwNTA3MGQiLCJsdHNsIjoiYzAzM2Y1MTAtYzlkZC0xMWVlLTkxMTctMDEwMjAzMDUwNzBkIiwibmV4dCI6dHJ1ZX0%3d"
}

Exemplo 2: Solicitar com filtro definindoType `roaming`

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=settingType eq 'roaming'


// 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.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "settingType eq 'roaming'";
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users settings windows list --user-id {user-id} --filter "settingType eq 'roaming'"



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestFilter := "settingType eq 'roaming'"

requestParameters := &graphusers.ItemSettingsWindowsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphusers.ItemSettingsWindowsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

windows, err := graphClient.Me().Settings().Windows().Get(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

WindowsSettingCollectionResponse result = graphClient.me().settings().windows().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "settingType eq 'roaming'";
});


const options = {
	authProvider,
};

const client = Client.init(options);

let windows = await client.api('/me/settings/windows')
	.filter('settingType eq \'roaming\'')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Settings\Windows\WindowsRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new WindowsRequestBuilderGetRequestConfiguration();
$queryParameters = WindowsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "settingType eq 'roaming'";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->settings()->windows()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserSettingWindows -UserId $userId -Filter "settingType eq 'roaming'"


from msgraph import GraphServiceClient
from msgraph.generated.users.item.settings.windows.windows_request_builder import WindowsRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = WindowsRequestBuilder.WindowsRequestBuilderGetQueryParameters(
		filter = "settingType eq 'roaming'",
)

request_configuration = WindowsRequestBuilder.WindowsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.settings.windows.get(request_configuration = request_configuration)

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.windowsSetting",
      "id": "default$windows.data.fileexplorerclassic.shellstatesettings",
      "settingType": "roaming",
      "payloadType": "windows.data.fileexplorerclassic.shellstatesettings",
      "instances": [
                {
                    "id": "0b3af867-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.windowsSetting",
      "id": "default$windows.data.fileexplorerclassic.cabinetstatesettings",
      "settingType": "roaming",
      "payloadType": "windows.data.fileexplorerclassic.cabinetstatesettings",
      "instances": [
                {
                    "id": "5038fa1b-49d1-4b94-041b-443ac419d417",
                    "payload": "VGhpcyBpcyBhbm90aGVyIGp1c3QgYW4gZXhhbXBsZSE=",
                    "lastModifiedDateTime": "2024-10-31T23:30:41Z",
                    "createdDateTime": "2024-02-12T19:34:35.223Z",
                    "expirationDateTime": "2034-02-09T19:34:33.771Z"
                }
            ]
    }
  ]
}

Exemplo 3: Solicitar com filtro definindoType `backup`

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=settingType eq 'backup'


// 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.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "settingType eq 'backup'";
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users settings windows list --user-id {user-id} --filter "settingType eq 'backup'"



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestFilter := "settingType eq 'backup'"

requestParameters := &graphusers.ItemSettingsWindowsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphusers.ItemSettingsWindowsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

windows, err := graphClient.Me().Settings().Windows().Get(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

WindowsSettingCollectionResponse result = graphClient.me().settings().windows().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "settingType eq 'backup'";
});


const options = {
	authProvider,
};

const client = Client.init(options);

let windows = await client.api('/me/settings/windows')
	.filter('settingType eq \'backup\'')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Settings\Windows\WindowsRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new WindowsRequestBuilderGetRequestConfiguration();
$queryParameters = WindowsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "settingType eq 'backup'";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->settings()->windows()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserSettingWindows -UserId $userId -Filter "settingType eq 'backup'"


from msgraph import GraphServiceClient
from msgraph.generated.users.item.settings.windows.windows_request_builder import WindowsRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = WindowsRequestBuilder.WindowsRequestBuilderGetQueryParameters(
		filter = "settingType eq 'backup'",
)

request_configuration = WindowsRequestBuilder.WindowsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.settings.windows.get(request_configuration = request_configuration)

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "value": [
    {
      "@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": "VGhpcyBpcyBhbm90aGVyIGp1c3QgYW4gZXhhbXBsZSE=",
                    "lastModifiedDateTime": "2024-10-31T23:30:41Z",
                    "createdDateTime": "2024-02-12T19:34:35.223Z",
                    "expirationDateTime": "2034-02-09T19:34:33.771Z"
                }
            ]
    },
    {
      "@odata.type": "#microsoft.graph.windowsSetting",
      "id": "{55f26da7-5824-4937-9028-9bba274f049f}$windows.data.apps.devicemetadata",
      "windowsDeviceId": "55f26da7-5824-4937-9028-9bba274f049f",      
      "settingType": "backup",
      "payloadType": "windows.data.apps.devicemetadata",
      "instances": [
                {
                    "id": "da2f0307-2a8d-4242-846f-56abd95f7213",
                    "payload": "VGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUh",
                    "lastModifiedDateTime": "2024-10-31T23:30:41Z",
                    "createdDateTime": "2024-02-12T19:34:35.223Z",
                    "expirationDateTime": "2034-02-09T19:34:33.771Z"
                }
            ]
    }
  ]
}

Exemplo 4: Solicitar com filtro por `windowsDeviceId`

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'


// 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.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'";
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users settings windows list --user-id {user-id} --filter "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'"



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestFilter := "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'"

requestParameters := &graphusers.ItemSettingsWindowsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphusers.ItemSettingsWindowsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

windows, err := graphClient.Me().Settings().Windows().Get(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

WindowsSettingCollectionResponse result = graphClient.me().settings().windows().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'";
});


const options = {
	authProvider,
};

const client = Client.init(options);

let windows = await client.api('/me/settings/windows')
	.filter('windowsDeviceId eq \'67585f9f-ee4b-4dd8-808e-d88375d66ef7\'')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Settings\Windows\WindowsRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new WindowsRequestBuilderGetRequestConfiguration();
$queryParameters = WindowsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->settings()->windows()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserSettingWindows -UserId $userId -Filter "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'"


from msgraph import GraphServiceClient
from msgraph.generated.users.item.settings.windows.windows_request_builder import WindowsRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = WindowsRequestBuilder.WindowsRequestBuilderGetQueryParameters(
		filter = "windowsDeviceId eq '67585f9f-ee4b-4dd8-808e-d88375d66ef7'",
)

request_configuration = WindowsRequestBuilder.WindowsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.settings.windows.get(request_configuration = request_configuration)

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "value": [
    {
      "@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"
                }
            ]
    }
  ]
}

Listar configurações do Windows

Permissões

Solicitação HTTP

Parâmetros de consulta opcionais

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Exemplo 1: Solicitar sem nenhum filtro

Solicitação

Resposta

Exemplo 2: Solicitar com filtro definindoType `roaming`

Solicitação

Resposta

Exemplo 3: Solicitar com filtro definindoType `backup`

Solicitação

Resposta

Exemplo 4: Solicitar com filtro por `windowsDeviceId`

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais

Listar configurações do Windows

Permissões

Solicitação HTTP

Parâmetros de consulta opcionais

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplos

Exemplo 1: Solicitar sem nenhum filtro

Solicitação

Resposta

Exemplo 2: Solicitar com filtro definindoType roaming

Solicitação

Resposta

Exemplo 3: Solicitar com filtro definindoType backup

Solicitação

Resposta

Exemplo 4: Solicitar com filtro por windowsDeviceId

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais

Exemplo 2: Solicitar com filtro definindoType `roaming`

Exemplo 3: Solicitar com filtro definindoType `backup`

Exemplo 4: Solicitar com filtro por `windowsDeviceId`