Update windows10TeamGeneralConfiguration
Article 08/01/2024
13 contributors
Feedback
In this article
Namespace: microsoft.graph
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Update the properties of a windows10TeamGeneralConfiguration object.
This API is available in the following national cloud deployments .
Global service
US Government L4
US Government L5 (DOD)
China operated by 21Vianet
✅
✅
✅
✅
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions .
Permission type
Permissions (from least to most privileged)
Delegated (work or school account)
DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account)
Not supported.
Application
DeviceManagementConfiguration.ReadWrite.All
HTTP Request
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}
Request body
In the request body, supply a JSON representation for the windows10TeamGeneralConfiguration object.
The following table shows the properties that are required when you create the windows10TeamGeneralConfiguration .
Property
Type
Description
id
String
Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime
DateTimeOffset
DateTime the object was last modified. Inherited from deviceConfiguration
createdDateTime
DateTimeOffset
DateTime the object was created. Inherited from deviceConfiguration
description
String
Admin provided description of the Device Configuration. Inherited from deviceConfiguration
displayName
String
Admin provided name of the device configuration. Inherited from deviceConfiguration
version
Int32
Version of the device configuration. Inherited from deviceConfiguration
azureOperationalInsightsBlockTelemetry
Boolean
Indicates whether or not to Block Azure Operational Insights.
azureOperationalInsightsWorkspaceId
String
The Azure Operational Insights workspace id.
azureOperationalInsightsWorkspaceKey
String
The Azure Operational Insights Workspace key.
connectAppBlockAutoLaunch
Boolean
Specifies whether to automatically launch the Connect app whenever a projection is initiated.
maintenanceWindowBlocked
Boolean
Indicates whether or not to Block setting a maintenance window for device updates.
maintenanceWindowDurationInHours
Int32
Maintenance window duration for device updates. Valid values 0 to 5
maintenanceWindowStartTime
TimeOfDay
Maintenance window start time for device updates.
miracastChannel
miracastChannel
The channel. Possible values are: userDefined
, one
, two
, three
, four
, five
, six
, seven
, eight
, nine
, ten
, eleven
, thirtySix
, forty
, fortyFour
, fortyEight
, oneHundredFortyNine
, oneHundredFiftyThree
, oneHundredFiftySeven
, oneHundredSixtyOne
, oneHundredSixtyFive
.
miracastBlocked
Boolean
Indicates whether or not to Block wireless projection.
miracastRequirePin
Boolean
Indicates whether or not to require a pin for wireless projection.
settingsBlockMyMeetingsAndFiles
Boolean
Specifies whether to disable the "My meetings and files" feature in the Start menu, which shows the signed-in user's meetings and files from Office 365.
settingsBlockSessionResume
Boolean
Specifies whether to allow the ability to resume a session when the session times out.
settingsBlockSigninSuggestions
Boolean
Specifies whether to disable auto-populating of the sign-in dialog with invitees from scheduled meetings.
settingsDefaultVolume
Int32
Specifies the default volume value for a new session. Permitted values are 0-100. The default is 45. Valid values 0 to 100
settingsScreenTimeoutInMinutes
Int32
Specifies the number of minutes until the Hub screen turns off.
settingsSessionTimeoutInMinutes
Int32
Specifies the number of minutes until the session times out.
settingsSleepTimeoutInMinutes
Int32
Specifies the number of minutes until the Hub enters sleep mode.
welcomeScreenBlockAutomaticWakeUp
Boolean
Indicates whether or not to Block the welcome screen from waking up automatically when someone enters the room.
welcomeScreenBackgroundImageUrl
String
The welcome screen background image URL. The URL must use the HTTPS protocol and return a PNG image.
welcomeScreenMeetingInformation
welcomeScreenMeetingInformation
The welcome screen meeting information shown. Possible values are: userDefined
, showOrganizerAndTimeOnly
, showOrganizerAndTimeAndSubject
.
Response
If successful, this method returns a 200 OK
response code and an updated windows10TeamGeneralConfiguration object in the response body.
Example
Request
Here is an example of the request.
PATCH https://graph.microsoft.com/v1.0/deviceManagement/deviceConfigurations/{deviceConfigurationId}
Content-type: application/json
Content-length: 1150
{
"@odata.type": "#microsoft.graph.windows10TeamGeneralConfiguration",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"azureOperationalInsightsBlockTelemetry": true,
"azureOperationalInsightsWorkspaceId": "Azure Operational Insights Workspace Id value",
"azureOperationalInsightsWorkspaceKey": "Azure Operational Insights Workspace Key value",
"connectAppBlockAutoLaunch": true,
"maintenanceWindowBlocked": true,
"maintenanceWindowDurationInHours": 0,
"maintenanceWindowStartTime": "11:59:09.3130000",
"miracastChannel": "one",
"miracastBlocked": true,
"miracastRequirePin": true,
"settingsBlockMyMeetingsAndFiles": true,
"settingsBlockSessionResume": true,
"settingsBlockSigninSuggestions": true,
"settingsDefaultVolume": 5,
"settingsScreenTimeoutInMinutes": 14,
"settingsSessionTimeoutInMinutes": 15,
"settingsSleepTimeoutInMinutes": 13,
"welcomeScreenBlockAutomaticWakeUp": true,
"welcomeScreenBackgroundImageUrl": "https://example.com/welcomeScreenBackgroundImageUrl/",
"welcomeScreenMeetingInformation": "showOrganizerAndTimeOnly"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new Windows10TeamGeneralConfiguration
{
OdataType = "#microsoft.graph.windows10TeamGeneralConfiguration",
Description = "Description value",
DisplayName = "Display Name value",
Version = 7,
AzureOperationalInsightsBlockTelemetry = true,
AzureOperationalInsightsWorkspaceId = "Azure Operational Insights Workspace Id value",
AzureOperationalInsightsWorkspaceKey = "Azure Operational Insights Workspace Key value",
ConnectAppBlockAutoLaunch = true,
MaintenanceWindowBlocked = true,
MaintenanceWindowDurationInHours = 0,
MaintenanceWindowStartTime = new Time(DateTime.Parse("11:59:09.3130000")),
MiracastChannel = MiracastChannel.One,
MiracastBlocked = true,
MiracastRequirePin = true,
SettingsBlockMyMeetingsAndFiles = true,
SettingsBlockSessionResume = true,
SettingsBlockSigninSuggestions = true,
SettingsDefaultVolume = 5,
SettingsScreenTimeoutInMinutes = 14,
SettingsSessionTimeoutInMinutes = 15,
SettingsSleepTimeoutInMinutes = 13,
WelcomeScreenBlockAutomaticWakeUp = true,
WelcomeScreenBackgroundImageUrl = "https://example.com/welcomeScreenBackgroundImageUrl/",
WelcomeScreenMeetingInformation = WelcomeScreenMeetingInformation.ShowOrganizerAndTimeOnly,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.DeviceConfigurations["{deviceConfiguration-id}"].PatchAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
mgc device-management device-configurations patch --device-configuration-id {deviceConfiguration-id} --body '{\
"@odata.type": "#microsoft.graph.windows10TeamGeneralConfiguration",\
"description": "Description value",\
"displayName": "Display Name value",\
"version": 7,\
"azureOperationalInsightsBlockTelemetry": true,\
"azureOperationalInsightsWorkspaceId": "Azure Operational Insights Workspace Id value",\
"azureOperationalInsightsWorkspaceKey": "Azure Operational Insights Workspace Key value",\
"connectAppBlockAutoLaunch": true,\
"maintenanceWindowBlocked": true,\
"maintenanceWindowDurationInHours": 0,\
"maintenanceWindowStartTime": "11:59:09.3130000",\
"miracastChannel": "one",\
"miracastBlocked": true,\
"miracastRequirePin": true,\
"settingsBlockMyMeetingsAndFiles": true,\
"settingsBlockSessionResume": true,\
"settingsBlockSigninSuggestions": true,\
"settingsDefaultVolume": 5,\
"settingsScreenTimeoutInMinutes": 14,\
"settingsSessionTimeoutInMinutes": 15,\
"settingsSleepTimeoutInMinutes": 13,\
"welcomeScreenBlockAutomaticWakeUp": true,\
"welcomeScreenBackgroundImageUrl": "https://example.com/welcomeScreenBackgroundImageUrl/",\
"welcomeScreenMeetingInformation": "showOrganizerAndTimeOnly"\
}\
'
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 $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewDeviceConfiguration()
description := "Description value"
requestBody.SetDescription(&description)
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName)
version := int32(7)
requestBody.SetVersion(&version)
azureOperationalInsightsBlockTelemetry := true
requestBody.SetAzureOperationalInsightsBlockTelemetry(&azureOperationalInsightsBlockTelemetry)
azureOperationalInsightsWorkspaceId := "Azure Operational Insights Workspace Id value"
requestBody.SetAzureOperationalInsightsWorkspaceId(&azureOperationalInsightsWorkspaceId)
azureOperationalInsightsWorkspaceKey := "Azure Operational Insights Workspace Key value"
requestBody.SetAzureOperationalInsightsWorkspaceKey(&azureOperationalInsightsWorkspaceKey)
connectAppBlockAutoLaunch := true
requestBody.SetConnectAppBlockAutoLaunch(&connectAppBlockAutoLaunch)
maintenanceWindowBlocked := true
requestBody.SetMaintenanceWindowBlocked(&maintenanceWindowBlocked)
maintenanceWindowDurationInHours := int32(0)
requestBody.SetMaintenanceWindowDurationInHours(&maintenanceWindowDurationInHours)
maintenanceWindowStartTime := 11:59:09.3130000
requestBody.SetMaintenanceWindowStartTime(&maintenanceWindowStartTime)
miracastChannel := graphmodels.ONE_MIRACASTCHANNEL
requestBody.SetMiracastChannel(&miracastChannel)
miracastBlocked := true
requestBody.SetMiracastBlocked(&miracastBlocked)
miracastRequirePin := true
requestBody.SetMiracastRequirePin(&miracastRequirePin)
settingsBlockMyMeetingsAndFiles := true
requestBody.SetSettingsBlockMyMeetingsAndFiles(&settingsBlockMyMeetingsAndFiles)
settingsBlockSessionResume := true
requestBody.SetSettingsBlockSessionResume(&settingsBlockSessionResume)
settingsBlockSigninSuggestions := true
requestBody.SetSettingsBlockSigninSuggestions(&settingsBlockSigninSuggestions)
settingsDefaultVolume := int32(5)
requestBody.SetSettingsDefaultVolume(&settingsDefaultVolume)
settingsScreenTimeoutInMinutes := int32(14)
requestBody.SetSettingsScreenTimeoutInMinutes(&settingsScreenTimeoutInMinutes)
settingsSessionTimeoutInMinutes := int32(15)
requestBody.SetSettingsSessionTimeoutInMinutes(&settingsSessionTimeoutInMinutes)
settingsSleepTimeoutInMinutes := int32(13)
requestBody.SetSettingsSleepTimeoutInMinutes(&settingsSleepTimeoutInMinutes)
welcomeScreenBlockAutomaticWakeUp := true
requestBody.SetWelcomeScreenBlockAutomaticWakeUp(&welcomeScreenBlockAutomaticWakeUp)
welcomeScreenBackgroundImageUrl := "https://example.com/welcomeScreenBackgroundImageUrl/"
requestBody.SetWelcomeScreenBackgroundImageUrl(&welcomeScreenBackgroundImageUrl)
welcomeScreenMeetingInformation := graphmodels.SHOWORGANIZERANDTIMEONLY_WELCOMESCREENMEETINGINFORMATION
requestBody.SetWelcomeScreenMeetingInformation(&welcomeScreenMeetingInformation)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
deviceConfigurations, err := graphClient.DeviceManagement().DeviceConfigurations().ByDeviceConfigurationId("deviceConfiguration-id").Patch(context.Background(), requestBody, nil)
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);
Windows10TeamGeneralConfiguration deviceConfiguration = new Windows10TeamGeneralConfiguration();
deviceConfiguration.setOdataType("#microsoft.graph.windows10TeamGeneralConfiguration");
deviceConfiguration.setDescription("Description value");
deviceConfiguration.setDisplayName("Display Name value");
deviceConfiguration.setVersion(7);
deviceConfiguration.setAzureOperationalInsightsBlockTelemetry(true);
deviceConfiguration.setAzureOperationalInsightsWorkspaceId("Azure Operational Insights Workspace Id value");
deviceConfiguration.setAzureOperationalInsightsWorkspaceKey("Azure Operational Insights Workspace Key value");
deviceConfiguration.setConnectAppBlockAutoLaunch(true);
deviceConfiguration.setMaintenanceWindowBlocked(true);
deviceConfiguration.setMaintenanceWindowDurationInHours(0);
LocalTime maintenanceWindowStartTime = LocalTime.parse("11:59:09.3130000");
deviceConfiguration.setMaintenanceWindowStartTime(maintenanceWindowStartTime);
deviceConfiguration.setMiracastChannel(MiracastChannel.One);
deviceConfiguration.setMiracastBlocked(true);
deviceConfiguration.setMiracastRequirePin(true);
deviceConfiguration.setSettingsBlockMyMeetingsAndFiles(true);
deviceConfiguration.setSettingsBlockSessionResume(true);
deviceConfiguration.setSettingsBlockSigninSuggestions(true);
deviceConfiguration.setSettingsDefaultVolume(5);
deviceConfiguration.setSettingsScreenTimeoutInMinutes(14);
deviceConfiguration.setSettingsSessionTimeoutInMinutes(15);
deviceConfiguration.setSettingsSleepTimeoutInMinutes(13);
deviceConfiguration.setWelcomeScreenBlockAutomaticWakeUp(true);
deviceConfiguration.setWelcomeScreenBackgroundImageUrl("https://example.com/welcomeScreenBackgroundImageUrl/");
deviceConfiguration.setWelcomeScreenMeetingInformation(WelcomeScreenMeetingInformation.ShowOrganizerAndTimeOnly);
DeviceConfiguration result = graphClient.deviceManagement().deviceConfigurations().byDeviceConfigurationId("{deviceConfiguration-id}").patch(deviceConfiguration);
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);
const deviceConfiguration = {
'@odata.type': '#microsoft.graph.windows10TeamGeneralConfiguration',
description: 'Description value',
displayName: 'Display Name value',
version: 7,
azureOperationalInsightsBlockTelemetry: true,
azureOperationalInsightsWorkspaceId: 'Azure Operational Insights Workspace Id value',
azureOperationalInsightsWorkspaceKey: 'Azure Operational Insights Workspace Key value',
connectAppBlockAutoLaunch: true,
maintenanceWindowBlocked: true,
maintenanceWindowDurationInHours: 0,
maintenanceWindowStartTime: '11:59:09.3130000',
miracastChannel: 'one',
miracastBlocked: true,
miracastRequirePin: true,
settingsBlockMyMeetingsAndFiles: true,
settingsBlockSessionResume: true,
settingsBlockSigninSuggestions: true,
settingsDefaultVolume: 5,
settingsScreenTimeoutInMinutes: 14,
settingsSessionTimeoutInMinutes: 15,
settingsSleepTimeoutInMinutes: 13,
welcomeScreenBlockAutomaticWakeUp: true,
welcomeScreenBackgroundImageUrl: 'https://example.com/welcomeScreenBackgroundImageUrl/',
welcomeScreenMeetingInformation: 'showOrganizerAndTimeOnly'
};
await client.api('/deviceManagement/deviceConfigurations/{deviceConfigurationId}')
.update(deviceConfiguration);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Windows10TeamGeneralConfiguration;
use Microsoft\Kiota\Abstractions\Types\Time;
use Microsoft\Graph\Generated\Models\MiracastChannel;
use Microsoft\Graph\Generated\Models\WelcomeScreenMeetingInformation;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new Windows10TeamGeneralConfiguration();
$requestBody->setOdataType('#microsoft.graph.windows10TeamGeneralConfiguration');
$requestBody->setDescription('Description value');
$requestBody->setDisplayName('Display Name value');
$requestBody->setVersion(7);
$requestBody->setAzureOperationalInsightsBlockTelemetry(true);
$requestBody->setAzureOperationalInsightsWorkspaceId('Azure Operational Insights Workspace Id value');
$requestBody->setAzureOperationalInsightsWorkspaceKey('Azure Operational Insights Workspace Key value');
$requestBody->setConnectAppBlockAutoLaunch(true);
$requestBody->setMaintenanceWindowBlocked(true);
$requestBody->setMaintenanceWindowDurationInHours(0);
$requestBody->setMaintenanceWindowStartTime(new Time('11:59:09.3130000'));
$requestBody->setMiracastChannel(new MiracastChannel('one'));
$requestBody->setMiracastBlocked(true);
$requestBody->setMiracastRequirePin(true);
$requestBody->setSettingsBlockMyMeetingsAndFiles(true);
$requestBody->setSettingsBlockSessionResume(true);
$requestBody->setSettingsBlockSigninSuggestions(true);
$requestBody->setSettingsDefaultVolume(5);
$requestBody->setSettingsScreenTimeoutInMinutes(14);
$requestBody->setSettingsSessionTimeoutInMinutes(15);
$requestBody->setSettingsSleepTimeoutInMinutes(13);
$requestBody->setWelcomeScreenBlockAutomaticWakeUp(true);
$requestBody->setWelcomeScreenBackgroundImageUrl('https://example.com/welcomeScreenBackgroundImageUrl/');
$requestBody->setWelcomeScreenMeetingInformation(new WelcomeScreenMeetingInformation('showOrganizerAndTimeOnly'));
$result = $graphServiceClient->deviceManagement()->deviceConfigurations()->byDeviceConfigurationId('deviceConfiguration-id')->patch($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
Import-Module Microsoft.Graph.DeviceManagement
$params = @{
"@odata.type" = "#microsoft.graph.windows10TeamGeneralConfiguration"
description = "Description value"
displayName = "Display Name value"
version = 7
azureOperationalInsightsBlockTelemetry = $true
azureOperationalInsightsWorkspaceId = "Azure Operational Insights Workspace Id value"
azureOperationalInsightsWorkspaceKey = "Azure Operational Insights Workspace Key value"
connectAppBlockAutoLaunch = $true
maintenanceWindowBlocked = $true
maintenanceWindowDurationInHours =
maintenanceWindowStartTime = "11:59:09.3130000"
miracastChannel = "one"
miracastBlocked = $true
miracastRequirePin = $true
settingsBlockMyMeetingsAndFiles = $true
settingsBlockSessionResume = $true
settingsBlockSigninSuggestions = $true
settingsDefaultVolume =
settingsScreenTimeoutInMinutes =
settingsSessionTimeoutInMinutes =
settingsSleepTimeoutInMinutes =
welcomeScreenBlockAutomaticWakeUp = $true
welcomeScreenBackgroundImageUrl = "https://example.com/welcomeScreenBackgroundImageUrl/"
welcomeScreenMeetingInformation = "showOrganizerAndTimeOnly"
}
Update-MgDeviceManagementDeviceConfiguration -DeviceConfigurationId $deviceConfigurationId -BodyParameter $params
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 import GraphServiceClient
from msgraph.generated.models.windows10_team_general_configuration import Windows10TeamGeneralConfiguration
from msgraph.generated.models.miracast_channel import MiracastChannel
from msgraph.generated.models.welcome_screen_meeting_information import WelcomeScreenMeetingInformation
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Windows10TeamGeneralConfiguration(
odata_type = "#microsoft.graph.windows10TeamGeneralConfiguration",
description = "Description value",
display_name = "Display Name value",
version = 7,
azure_operational_insights_block_telemetry = True,
azure_operational_insights_workspace_id = "Azure Operational Insights Workspace Id value",
azure_operational_insights_workspace_key = "Azure Operational Insights Workspace Key value",
connect_app_block_auto_launch = True,
maintenance_window_blocked = True,
maintenance_window_duration_in_hours = 0,
maintenance_window_start_time = "11:59:09.3130000",
miracast_channel = MiracastChannel.One,
miracast_blocked = True,
miracast_require_pin = True,
settings_block_my_meetings_and_files = True,
settings_block_session_resume = True,
settings_block_signin_suggestions = True,
settings_default_volume = 5,
settings_screen_timeout_in_minutes = 14,
settings_session_timeout_in_minutes = 15,
settings_sleep_timeout_in_minutes = 13,
welcome_screen_block_automatic_wake_up = True,
welcome_screen_background_image_url = "https://example.com/welcomeScreenBackgroundImageUrl/",
welcome_screen_meeting_information = WelcomeScreenMeetingInformation.ShowOrganizerAndTimeOnly,
)
result = await graph_client.device_management.device_configurations.by_device_configuration_id('deviceConfiguration-id').patch(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation .
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1322
{
"@odata.type": "#microsoft.graph.windows10TeamGeneralConfiguration",
"id": "0c94aa20-aa20-0c94-20aa-940c20aa940c",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"azureOperationalInsightsBlockTelemetry": true,
"azureOperationalInsightsWorkspaceId": "Azure Operational Insights Workspace Id value",
"azureOperationalInsightsWorkspaceKey": "Azure Operational Insights Workspace Key value",
"connectAppBlockAutoLaunch": true,
"maintenanceWindowBlocked": true,
"maintenanceWindowDurationInHours": 0,
"maintenanceWindowStartTime": "11:59:09.3130000",
"miracastChannel": "one",
"miracastBlocked": true,
"miracastRequirePin": true,
"settingsBlockMyMeetingsAndFiles": true,
"settingsBlockSessionResume": true,
"settingsBlockSigninSuggestions": true,
"settingsDefaultVolume": 5,
"settingsScreenTimeoutInMinutes": 14,
"settingsSessionTimeoutInMinutes": 15,
"settingsSleepTimeoutInMinutes": 13,
"welcomeScreenBlockAutomaticWakeUp": true,
"welcomeScreenBackgroundImageUrl": "https://example.com/welcomeScreenBackgroundImageUrl/",
"welcomeScreenMeetingInformation": "showOrganizerAndTimeOnly"
}