windowsKioskConfiguration resource type

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

This entity provides descriptions of the declared methods, properties and relationships exposed by the kiosk resource.

Inherits from deviceConfiguration

Methods

Method	Return Type	Description
List windowsKioskConfigurations	windowsKioskConfiguration collection	List properties and relationships of the windowsKioskConfiguration objects.
Get windowsKioskConfiguration	windowsKioskConfiguration	Read properties and relationships of the windowsKioskConfiguration object.
Create windowsKioskConfiguration	windowsKioskConfiguration	Create a new windowsKioskConfiguration object.
Delete windowsKioskConfiguration	None	Deletes a windowsKioskConfiguration.
Update windowsKioskConfiguration	windowsKioskConfiguration	Update the properties of a windowsKioskConfiguration object.

Properties

Property	Type	Description
id	String	Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime	DateTimeOffset	DateTime the object was last modified. Inherited from deviceConfiguration
roleScopeTagIds	String collection	List of Scope Tags for this Entity instance. Inherited from deviceConfiguration
supportsScopeTags	Boolean	Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	The OS edition applicability for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	The OS version applicability rule for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	The device mode applicability rule for this Policy. 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
kioskProfiles	windowsKioskProfile collection	This policy setting allows to define a list of Kiosk profiles for a Kiosk configuration. This collection can contain a maximum of 3 elements.
kioskBrowserDefaultUrl	String	Specify the default URL the browser should navigate to on launch.
kioskBrowserEnableHomeButton	Boolean	Enable the kiosk browser's home button. By default, the home button is disabled.
kioskBrowserEnableNavigationButtons	Boolean	Enable the kiosk browser's navigation buttons(forward/back). By default, the navigation buttons are disabled.
kioskBrowserEnableEndSessionButton	Boolean	Enable the kiosk browser's end session button. By default, the end session button is disabled.
kioskBrowserRestartOnIdleTimeInMinutes	Int32	Specify the number of minutes the session is idle until the kiosk browser restarts in a fresh state. Valid values are 1-1440. Valid values 1 to 1440
kioskBrowserBlockedURLs	String collection	Specify URLs that the kiosk browsers should not navigate to
kioskBrowserBlockedUrlExceptions	String collection	Specify URLs that the kiosk browser is allowed to navigate to
edgeKioskEnablePublicBrowsing	Boolean	Enable public browsing kiosk mode for the Microsoft Edge browser. The Default is false.
windowsKioskForceUpdateSchedule	windowsKioskForceUpdateSchedule	force update schedule for Kiosk devices.

Relationships

Relationship	Type	Description
groupAssignments	deviceConfigurationGroupAssignment collection	The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
assignments	deviceConfigurationAssignment collection	The list of assignments for the device configuration profile. Inherited from deviceConfiguration
deviceStatuses	deviceConfigurationDeviceStatus collection	Device configuration installation status by device. Inherited from deviceConfiguration
userStatuses	deviceConfigurationUserStatus collection	Device configuration installation status by user. Inherited from deviceConfiguration
deviceStatusOverview	deviceConfigurationDeviceOverview	Device Configuration devices status overview Inherited from deviceConfiguration
userStatusOverview	deviceConfigurationUserOverview	Device Configuration users status overview Inherited from deviceConfiguration
deviceSettingStateSummaries	settingStateDeviceSummary collection	Device Configuration Setting State Device Summary Inherited from deviceConfiguration

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.windowsKioskConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "String"
    ],
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "String",
    "maxOSVersion": "String",
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "String",
    "name": "String",
    "ruleType": "String"
  },
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "version": 1024,
  "kioskProfiles": [
    {
      "@odata.type": "microsoft.graph.windowsKioskProfile",
      "profileId": "String",
      "profileName": "String",
      "appConfiguration": {
        "@odata.type": "microsoft.graph.windowsKioskMultipleApps",
        "apps": [
          {
            "@odata.type": "microsoft.graph.windowsKioskUWPApp",
            "startLayoutTileSize": "String",
            "name": "String",
            "appType": "String",
            "autoLaunch": true,
            "appUserModelId": "String",
            "appId": "String",
            "containedAppId": "String"
          }
        ],
        "showTaskBar": true,
        "allowAccessToDownloadsFolder": true,
        "disallowDesktopApps": true,
        "startMenuLayoutXml": "binary"
      },
      "userAccountsConfiguration": [
        {
          "@odata.type": "microsoft.graph.windowsKioskVisitor"
        }
      ]
    }
  ],
  "kioskBrowserDefaultUrl": "String",
  "kioskBrowserEnableHomeButton": true,
  "kioskBrowserEnableNavigationButtons": true,
  "kioskBrowserEnableEndSessionButton": true,
  "kioskBrowserRestartOnIdleTimeInMinutes": 1024,
  "kioskBrowserBlockedURLs": [
    "String"
  ],
  "kioskBrowserBlockedUrlExceptions": [
    "String"
  ],
  "edgeKioskEnablePublicBrowsing": true,
  "windowsKioskForceUpdateSchedule": {
    "@odata.type": "microsoft.graph.windowsKioskForceUpdateSchedule",
    "startDateTime": "String (timestamp)",
    "recurrence": "String",
    "dayofWeek": "String",
    "dayofMonth": 1024,
    "runImmediatelyIfAfterStartDateTime": true
  }
}