diff --git a/windows/client-management/mdm/data-structures-windows-store-for-business.md b/windows/client-management/mdm/data-structures-windows-store-for-business.md index b1e8b42c40..b20c4ce200 100644 --- a/windows/client-management/mdm/data-structures-windows-store-for-business.md +++ b/windows/client-management/mdm/data-structures-windows-store-for-business.md @@ -6,7 +6,7 @@ MS-HAID: ms.assetid: ABE44EC8-CBE5-4775-BA8A-4564CB73531B ms.reviewer: manager: dansimp -description: +description: Learn about data structures for Microsoft Store for Business. ms.author: dansimp ms.topic: article ms.prod: w10 @@ -17,7 +17,6 @@ ms.date: 09/18/2017 # Data structures for Microsoft Store for Business - Here's the list of data structures used in the Microsoft Store for Business REST APIs: - [AlternateIdentifier](#alternateidentifier) @@ -54,1067 +53,262 @@ Here's the list of data structures used in the Microsoft Store for Business REST Specifies the properties of the alternate identifier. - ----- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

type

string

LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId

value

string

- - +|Name|Type|Description| +|--- |--- |--- | +|Type|String|LegacyWindowStoreProductId, LegacyWindowsPhoneProductId, RedirectToThresholdProductId| +|Value|String|| ## BulkSeatOperationResultSet - - ---- - - - - - - - - - - - - - - - - -
NameType

seatDetails

collection of SeatDetails

failedSeatOperations

collection of FailedSeatRequest

- - +|Name|Type| +|--- |--- | +|seatDetails|Collection of [SeatDetails](#seatdetails)| +|failedSeatOperations|Collection of [FailedSeatRequest](#failedseatrequest)| ## FailedSeatRequest - - ---- - - - - - - - - - - - - - - - - - - - - -
NameType

failureReason

string

productKey

ProductKey

userName

string

- - +|Name|Type| +|--- |--- | +|failureReason|String| +|productKey|[ProductKey](#productkey)| +|userName|String| ## FrameworkPackageDetails - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

packageId

string

contentId

string

Identifies a specific application.

location

PackageLocation

packageFullName

string

packageIdentityName

string

architectures

collection of ProductArchitectures

packageFormat

ProductPackageFormat

platforms

collection of ProductPlatform

fileSize

integer-64

Size of the file.

packageRank

integer-32

Optional

- - +|Name|Type|Description| +|--- |--- |--- | +|packageId|String|| +|contentId|String|Identifies a specific application.| +|Location|[PackageLocation](#packagelocation)|| +|packageFullName|String|| +|packageIdentityName|String|| +|Architectures|Collection of [ProductArchitectures](#productarchitectures)|| +|packageFormat|[ProductPackageFormat](#productpackageformat)|| +|Platforms|Collection of [ProductPlatform](#productplatform)|| +|fileSize|integer-64|Size of the file.| +|packageRank|integer-32|Optional| ## InventoryDistributionPolicy - - ---- - - - - - - - - - - - - - - - - -
NameDescription

open

Open distribution policy - licenses/seats can be assigned/consumed without limit

restricted

Restricted distribution policy - licenses/seats must be assigned/consumed according to the available count

- - +|Name|Description| +|--- |--- | +|Open|Open distribution policy - licenses/seats can be assigned/consumed without limit| +|Restricted|Restricted distribution policy - licenses/seats must be assigned/consumed according to the available count| ## InventoryEntryDetails - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

productKey

ProductKey

Identifier used on subsequent requests to get additional content including product descriptions, offline license, and download URLs.

seatCapacity

integer-64

Total number of seats that have been purchased for an application.

availableSeats

integer-64

Number of available seats remaining for an application.

lastModified

dateTime

Specifies the last modified date for an application. Modifications for an application includes updated product details, updates to an application, and updates to the quantity of an application.

licenseType

LicenseType

Indicates whether the set of seats for a given application supports online or offline licensing.

distributionPolicy

InventoryDistributionPolicy

status

InventoryStatus

- - +|Name|Type|Description| +|--- |--- |--- | +|productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get more content including product descriptions, offline license, and download URLs.| +|seatCapacity|integer-64|Total number of seats that have been purchased for an application.| +|availableSeats|integer-64|Number of available seats remaining for an application.| +|lastModified|dateTime|Specifies the last modified date for an application. Modifications for an application include updated product details, updates to an application, and updates to the quantity of an application.| +|licenseType|[LicenseType](#licensetype)|Indicates whether the set of seats for a given application supports online or offline licensing.| +|distributionPolicy|[InventoryDistributionPolicy](#inventorydistributionpolicy)|| +|Status|[InventoryStatus](#inventorystatus)|| ## InventoryResultSet - ----- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

continuationToken

string

Only available if there is a next page.

inventoryEntries

collection of InventoryEntryDetails

- +|Name|Type|Description| +|--- |--- |--- | +|continuationToken|String|Only available if there is a next page.| +|inventoryEntries|Collection of [InventoryEntryDetails](#inventoryentrydetails)|| - ## InventoryStatus - - ---- - - - - - - - - - - - - - - - - -
NameDescription

active

Entry is available in the organization’s inventory.

removed

Entry has been removed from the organization’s inventory.

- - +|Name|Description| +|--- |--- | +|Active|Entry is available in the organization’s inventory.| +|Removed|Entry has been removed from the organization’s inventory.| ## LicenseType - - ---- - - - - - - - - - - - - - - - - -
NameDescription

online

Online license application.

offline

Offline license application.

- - +|Name|Description| +|--- |--- | +|Online|Online license application.| +|Offline|Offline license application.| ## LocalizedProductDetail Specifies the properties of the localized product. - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

language

string

Language or fallback language if the specified language is not available.

displayName

string

Display name of the application.

description

string

App description provided by developer can be up to 10,000 characters.

images

collection of ProductImage

Artwork and icon associated with the application.

publisher

PublisherDetails

Publisher of the application.

- - +|Name|Type|Description| +|--- |--- |--- | +|Language|String|Language or fallback language if the specified language is not available.| +|displayName|String|Display name of the application.| +|Description|String|App description provided by developer can be up to 10,000 characters.| +|Images|Collection of [ProductImage](#productimage)|Artwork and icon associated with the application.| +|Publisher|[PublisherDetails](#publisherdetails)|Publisher of the application.| ## OfflineLicense - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

productKey

ProductKey

Identifies a set of seats associated with an application.

licenseBlob

string

Base-64 encoded offline license that can be installed via a CSP.

licenseInstanceId

string

Version of the license.

requestorId

string

Organization requesting the license.

contentId

string

Identifies the specific license required by an application.

- - +|Name|Type|Description| +|--- |--- |--- | +|productKey|[ProductKey](#productkey)|Identifies a set of seats associated with an application.| +|licenseBlob|String|Base-64 encoded offline license that can be installed via a CSP.| +|licenseInstanceId|String|Version of the license.| +|requestorId|String|Organization requesting the license.| +|contentId|String|Identifies the specific license required by an application.| ## PackageContentInfo - ---- - - - - - - - - - - - - - - - - -
NameType

productPlatforms

collection of ProductPlatform

packageFormat

string

- - +|Name|Type| +|--- |--- | +|productPlatforms|Collection of ProductPlatform| +|packageFormat|String| ## PackageLocation - ----- - - - - - - - - - - - - - - -
NameTypeDescription

url

URI

CDN location of the packages. URL expiration is based on the estimated time to download the package.

+|Name|Type|Description| +|--- |--- |--- | +|Url|URI|CDN location of the packages. URL expiration is based on the estimated time to download the package.| - ## ProductArchitectures - - --- - - - - - - - - - - - - - - - - - - - -
Name

neutral

arm

x86

x64

- - +|Name| +|--- | +|Neutral| +|Arm| +|x86| +|x64| ## ProductDetails +|Name|Type|Description| +|--- |--- |--- | +|productKey|[ProductKey](#productkey)|Identifier used on subsequent requests to get more content including product descriptions, offline license, and download URLs.| +|productType|String|Type of product.| +|supportedLanguages|Collection of string|The set of localized languages for an application.| +|publisherId|String|Publisher identifier.| +|Category|String|Application category.| +|alternateIds|Collection of [AlternateIdentifier](#alternateidentifier)|The identifiers that can be used to instantiate the installation of on online application.| +|packageFamilyName|String|| +|supportedPlatforms|Collection of [ProductPlatform](#productplatform)|| - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

productKey

ProductKey

Identifier used on subsequent requests to get additional content including product descriptions, offline license, and download URLs.

productType

string

Type of product.

supportedLanguages

collection of string

The set of localized languages for an application.

publisherId

string

Publisher identifier.

category

string

Application category.

alternateIds

collection of AlternateIdentifier

The identifiers that can be used to instantiate the installation of on online application.

packageFamilyName

string

supportedPlatforms

collection of ProductPlatform

- - ## ProductImage - Specifies the properties of the product image. - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

location

URI

Location of the download image.

purpose

string

Tag for the purpose of the image, e.g. "screenshot" or "logo".

height

string

Height of the image in pixels.

width

string

Width of the image in pixels.

caption

string

Unlimited length.

backgroundColor

string

Format "#RRGGBB"

foregroundColor

string

Format "#RRGGBB"

fileSize

integer-64

Size of the file.

- - +|Name|Type|Description| +|--- |--- |--- | +|Location|URI|Location of the download image.| +|Purpose|String|Tag for the purpose of the image, for example "screenshot" or "logo".| +|Height|String|Height of the image in pixels.| +|Width|String|Width of the image in pixels.| +|Caption|String|Unlimited length.| +|backgroundColor|String|Format "#RRGGBB"| +|foregroundColor|String|Format "#RRGGBB"| +|fileSize|integer-64|Size of the file.| ## ProductKey - Specifies the properties of the product key. - ----- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

productId

string

Product identifier for an application that is used by the Store for Business.

skuId

string

Product identifier that specifies a specific SKU of an application.

- - +|Name|Type|Description| +|--- |--- |--- | +|productId|String|Product identifier for an application that is used by the Store for Business.| +|skuId|String|Product identifier that specifies a specific SKU of an application.| ## ProductPackageDetails - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

frameworkDependencyPackages

collection of FrameworkPackageDetails

packageId

string

contentId

string

Identifies a specific application.

location

PackageLocation

packageFullName

string

example, Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe

packageIdentityName

string

example, Microsoft.BingTranslator

architectures

collection of ProductArchitectures

Values {x86, x64, arm, neutral}

packageFormat

ProductPackageFormat

Extension of the package file.

platforms

collection of ProductPlatform

fileSize

integer-64

Size of the file.

packageRank

integer-32

Optional

- - +|Name|Type|Description| +|--- |--- |--- | +|frameworkDependencyPackages|Collection of [FrameworkPackageDetails](#frameworkpackagedetails)|| +|packageId|String|| +|contentId|String|Identifies a specific application.| +|Location|[PackageLocation](#packagelocation)|| +|packageFullName|String|Example, Microsoft.BingTranslator_1.1.10917.2059_x86__8wekyb3d8bbwe| +|packageIdentityName|String|Example, Microsoft.BingTranslator| +|Architectures|Collection of [ProductArchitectures](#productarchitectures)|Values {x86, x64, arm, neutral}| +|packageFormat|[ProductPackageFormat](#productpackageformat)|Extension of the package file.| +|Platforms|Collection of [ProductPlatform](#productplatform)|| +|fileSize|integer-64|Size of the file.| +|packageRank|integer-32|Optional| ## ProductPackageFormat - - --- - - - - - - - - - - - - - - - - -
Name

appx

appxBundle

xap

- - +|Name| +|--- | +|Appx| +|appxBundle| +|Xap| ## ProductPackageSet - - ----- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

packageSetId

string

An identifier for the particular combination of application packages.

productPackages

collection of ProductPackageDetails

A collection of application packages.

- - +|Name|Type|Description| +|--- |--- |--- | +|packageSetId|String|An identifier for the particular combination of application packages.| +|productPackages|Collection of [ProductPackageDetails](#productpackagedetails)|A collection of application packages.| ## ProductPlatform - - ---- - - - - - - - - - - - - - - - - - - - - -
NameType

platformName

string

minVersion

VersionInfo

maxTestedVersion

VersionInfo

- - +|Name|Type| +|--- |--- | +|platformName|String| +|minVersion|[VersionInfo](#versioninfo)| +|maxTestedVersion|[VersionInfo](#versioninfo)| ## PublisherDetails - Specifies the properties of the publisher details. - ----- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

publisherName

string

Name of the publisher.

publisherWebsite

string

Website of the publisher.

- - +|Name|Type|Description| +|--- |--- |--- | +|publisherName|String|Name of the publisher.| +|publisherWebsite|String|Website of the publisher.| ## SeatAction - --- - - - - - - - - - - - - - -
Name

assign

reclaim

- - +|Name| +|--- | +|Assign| +|Reclaim| ## SeatDetails - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription

assignedTo

string

Format = UPN (user@domain)

dateAssigned

datetime

state

SeatState

productKey

ProductKey

- - +|Name|Type|Description| +|--- |--- |--- | +|assignedTo|String|Format = UPN (user@domain)| +|dateAssigned|Datetime|| +|State|[SeatState](#seatstate)|| +|productKey|[ProductKey](#productkey)|| ## SeatDetailsResultSet - - ---- - - - - - - - - - - - - - - - - -
NameType

seats

collection of SeatDetails

continuationToken

string

- - +|Name|Type| +|--- |--- | +|Seats|Collection of [SeatDetails](#seatdetails)| +|continuationToken|String| ## SeatState - - --- - - - - - - - - - - - - - -
Name

active

revoked

- - +|Name| +|--- | +|Active| +|Revoked| ## SupportedProductPlatform - - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType

platformName

string

minVersion

VersionInfo

maxTestedVersion

VersionInfo

architectures

collection of ProductArchitectures

- - +|Name|Type| +|--- |--- | +|platformName|String| +|minVersion|[VersionInfo](#versioninfo)| +|maxTestedVersion|[VersionInfo](#versioninfo)| +|Architectures|Collection of [ProductArchitectures](#productarchitectures)| ## VersionInfo - - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType

major

integer-32

minor

integer-32

build

integer-32

revision

integer-32

+|Name|Type| +|--- |--- | +|Major|integer-32| +|Minor|integer-32| +|Build|integer-32| +|Revision|integer-32| diff --git a/windows/client-management/mdm/device-update-management.md b/windows/client-management/mdm/device-update-management.md index b41ccfecfa..b1d7b62247 100644 --- a/windows/client-management/mdm/device-update-management.md +++ b/windows/client-management/mdm/device-update-management.md @@ -356,57 +356,30 @@ If the **Specify intranet Microsoft update service location** policy is enabled, If the **Allow Telemetry** policy is enabled and the Options value is set to 0, then the **Defer upgrades by**, **Defer updates by** and **Pause Updates and Upgrades** settings have no effect. - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Update categoryMaximum deferralDeferral incrementUpdate type/notes

OS upgrade

8 months

1 month

Upgrade - 3689BDC8-B205-4AF4-8D4A-A63924C5E9D5

Update

1 month

1 week

-Note -If a machine has Microsoft Update enabled, any Microsoft Updates in these categories will also observe Defer / Pause logic. -
-
    -
  • Security Update - 0FA1201D-4330-4FA8-8AE9-B877473B6441
  • -
  • Critical Update - E6CF1350-C01B-414D-A61F-263D14D133B4
  • -
  • Update Rollup - 28BC880E-0592-4CBF-8F95-C79B17911D5F
  • -
  • Service Pack - 68C5B0A3-D1A6-4553-AE49-01D3A7827828
  • -
  • Tools - B4832BD8-E735-4761-8DAF-37F882276DAB
  • -
  • Feature Pack - B54E7D24-7ADD-428F-8B75-90A396FA584F
  • -
  • Update - CD5FFD1E-E932-4E3A-BF74-18BF0B1BBD83
  • -
  • Driver - EBFC1FC5-71A4-4F7B-9ACA-3B9A503104A0
  • -

Other/cannot defer

No deferral

No deferral

Any update category not enumerated above falls into this category.

-

Definition Update - E0789628-CE08-4437-BE74-2495B842F43B

+- **Update category**: OS upgrade + - **Maximum deferral**: 8 months + - **Deferral increment**: 1 month + - **Update type/notes**: Upgrade - 3689BDC8-B205-4AF4-8D4A-A63924C5E9D5 +- **Update category**: Update + - **Maximum deferral**: 1 month + - **Deferral increment**: 1 week + - **Update type/notes**: If a machine has Microsoft Update enabled, any Microsoft Updates in these categories will also observe Defer / Pause logic. + + - Security Update - 0FA1201D-4330-4FA8-8AE9-B877473B6441 + - Critical Update - E6CF1350-C01B-414D-A61F-263D14D133B4 + - Update Rollup - 28BC880E-0592-4CBF-8F95-C79B17911D5F + - Service Pack - 68C5B0A3-D1A6-4553-AE49-01D3A7827828 + - Tools - B4832BD8-E735-4761-8DAF-37F882276DAB + - Feature Pack - B54E7D24-7ADD-428F-8B75-90A396FA584F + - Update - CD5FFD1E-E932-4E3A-BF74-18BF0B1BBD83 + - Driver - EBFC1FC5-71A4-4F7B-9ACA-3B9A503104A0 + +- **Update category**: Other/cannot defer + - **Maximum deferral**: No deferral + - **Deferral increment**: No deferral + - **Update type/notes**: Any update category not enumerated above falls into this category. + - Definition Update - E0789628-CE08-4437-BE74-2495B842F43B **Update/DeferUpgradePeriod** > [!NOTE] @@ -878,71 +851,16 @@ Here are the new policies added in Windows 10, version 1607 in [Policy CSP](pol Here's the list of corresponding Group Policy settings in HKLM\\Software\\Policies\\Microsoft\\Windows\\WindowsUpdate. - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GPO keyTypeValue

BranchReadinessLevel

REG_DWORD

16: systems take Feature Updates on the Current Branch (CB) train

-

32: systems take Feature Updates on the Current Branch for Business

-

Other value or absent: receive all applicable updates (CB)

DeferQualityUpdates

REG_DWORD

1: defer quality updates

-

Other value or absent: don’t defer quality updates

DeferQualityUpdatesPeriodInDays

REG_DWORD

0-30: days to defer quality updates

PauseQualityUpdates

REG_DWORD

1: pause quality updates

-

Other value or absent: don’t pause quality updates

DeferFeatureUpdates

REG_DWORD

1: defer feature updates

-

Other value or absent: don’t defer feature updates

DeferFeatureUpdatesPeriodInDays

REG_DWORD

0-180: days to defer feature updates

PauseFeatureUpdates

REG_DWORD

1: pause feature updates

-

Other value or absent: don’t pause feature updates

ExcludeWUDriversInQualityUpdate

REG_DWORD

1: exclude WU drivers

-

Other value or absent: offer WU drivers

- - +|GPO key|Type|Value| +|--- |--- |--- | +|BranchReadinessLevel|REG_DWORD|16: systems take Feature Updates on the Current Branch (CB) train

32: systems take Feature Updates on the Current Branch for Business

Other value or absent: receive all applicable updates (CB)| +|DeferQualityUpdates|REG_DWORD|1: defer quality updates

Other value or absent: don’t defer quality updates| +|DeferQualityUpdatesPeriodInDays|REG_DWORD|0-30: days to defer quality updates| +|PauseQualityUpdates|REG_DWORD|1: pause quality updates

Other value or absent: don’t pause quality updates| +|DeferFeatureUpdates|REG_DWORD|1: defer feature updates

Other value or absent: don’t defer feature updates| +|DeferFeatureUpdatesPeriodInDays|REG_DWORD|0-180: days to defer feature updates| +|PauseFeatureUpdates|REG_DWORD|1: pause feature updates

Other value or absent: don’t pause feature updates| +|ExcludeWUDriversInQualityUpdate|REG_DWORD|1: exclude WU drivers

Other value or absent: offer WU drivers| Here's the list of older policies that are still supported for backward compatibility. You can use these older policies for Windows 10, version 1511 devices. diff --git a/windows/client-management/mdm/dmclient-csp.md b/windows/client-management/mdm/dmclient-csp.md index 797a8ff619..592daf59ec 100644 --- a/windows/client-management/mdm/dmclient-csp.md +++ b/windows/client-management/mdm/dmclient-csp.md @@ -328,220 +328,50 @@ If there's no infinite schedule set, then a 24-hour schedule is created and sche **Valid poll schedule: sigmoid polling schedule with infinite schedule (Recommended).** - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Schedule nameSchedule set by the serverActual value queried on device

IntervalForFirstSetOfRetries

15

15

NumberOfFirstRetries

5

5

IntervalForSecondSetOfRetries

60

60

NumberOfSecondRetries

10

10

IntervalForRemainingScheduledRetries

1440

1440

NumberOfRemainingScheduledRetries

0

0

+|Schedule name|Schedule set by the server|Actual value queried on device| +|--- |--- |--- | +|IntervalForFirstSetOfRetries|15|15| +|NumberOfFirstRetries|5|5| +|IntervalForSecondSetOfRetries|60|60| +|NumberOfSecondRetries|10|10| +|IntervalForRemainingScheduledRetries|1440|1440| +|NumberOfRemainingScheduledRetries|0|0| - +**Valid poll schedule: initial enrollment only [no infinite schedule]** -**Valid poll schedule: initial enrollment only \[no infinite schedule\]** - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Schedule nameSchedule set by the serverActual value queried on device

IntervalForFirstSetOfRetries

15

15

NumberOfFirstRetries

5

5

IntervalForSecondSetOfRetries

60

60

NumberOfSecondRetries

10

10

IntervalForRemainingScheduledRetries

0

0

NumberOfRemainingScheduledRetries

0

0

- - +|Schedule name|Schedule set by the server|Actual value queried on device| +|--- |--- |--- | +|IntervalForFirstSetOfRetries|15|15| +|NumberOfFirstRetries|5|5| +|IntervalForSecondSetOfRetries|60|60| +|NumberOfSecondRetries|10|10| +|IntervalForRemainingScheduledRetries|0|0| +|NumberOfRemainingScheduledRetries|0|0| **Invalid poll schedule: disable all poll schedules** > [!NOTE] > Disabling poll schedules results in UNDEFINED behavior and enrollment may fail if poll schedules are all set to zero. +|Schedule name|Schedule set by the server|Actual value queried on device| +|--- |--- |--- | +|IntervalForFirstSetOfRetries|0|0| +|NumberOfFirstRetries|0|0| +|IntervalForSecondSetOfRetries|0|0| +|NumberOfSecondRetries|0|0| +|IntervalForRemainingScheduledRetries|0|0| +|NumberOfRemainingScheduledRetries|0|0| - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Schedule nameSchedule set by the serverActual value queried on device

IntervalForFirstSetOfRetries

0

0

NumberOfFirstRetries

0

0

IntervalForSecondSetOfRetries

0

0

NumberOfSecondRetries

0

0

IntervalForRemainingScheduledRetries

0

0

NumberOfRemainingScheduledRetries

0

0

- - - **Invalid poll schedule: two infinite schedules** - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Schedule nameSchedule set by serverActual schedule set on deviceActual experience

IntervalForFirstSetOfRetries

15

15

Device polls

NumberOfFirstRetries

5

5

Device polls

IntervalForSecondSetOfRetries

1440

1440

Device polls the server once in 24 hours

NumberOfSecondRetries

0

0

Device polls the server once in 24 hours

IntervalForRemainingScheduledRetries

1440

0

Third schedule is disabled

NumberOfRemainingScheduledRetries

0

0

Third schedule is disabled

- - +|Schedule name|Schedule set by server|Actual schedule set on device|Actual experience| +|--- |--- |--- |--- | +|IntervalForFirstSetOfRetries|15|15|Device polls| +|NumberOfFirstRetries|5|5|Device polls| +|IntervalForSecondSetOfRetries|1440|1440|Device polls the server once in 24 hours| +|NumberOfSecondRetries|0|0|Device polls the server once in 24 hours| +|IntervalForRemainingScheduledRetries|1440|0|Third schedule is disabled| +|NumberOfRemainingScheduledRetries|0|0|Third schedule is disabled| If the device was previously enrolled in MDM with polling schedule configured using the registry key values directly, the MDM provider that supports using DMClient CSP to update polling schedule must first send an Add command to add a **./Vendor/MSFT/DMClient/Enrollment/<ProviderID>/Poll** node before it sends a Get/Replace command to query or update polling parameters using the DMClient CSP @@ -654,58 +484,17 @@ Supported operation is Get. The status error mapping is listed below. - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
StatusDescription

0

Success

1

Failure: invalid PFN

2

Failure: invalid or expired device authentication with MSA

3

Failure: WNS client registration failed due to an invalid or revoked PFN

4

Failure: no Channel URI assigned

5

Failure: Channel URI has expired

6

Failure: Channel URI failed to be revoked

7

Failure: push notification received, but unable to establish an OMA-DM session due to power or connectivity limitations.

8

Unknown error

- - +|Status|Description| +|--- |--- | +|0|Success| +|1|Failure: invalid PFN| +|2|Failure: invalid or expired device authentication with MSA| +|3|Failure: WNS client registration failed due to an invalid or revoked PFN| +|4|Failure: no Channel URI assigned| +|5|Failure: Channel URI has expired| +|6|Failure: Channel URI failed to be revoked| +|7|Failure: push notification received, but unable to establish an OMA-DM session due to power or connectivity limitations.| +|8|Unknown error| **Provider/*ProviderID*/CustomEnrollmentCompletePage** Optional. Added in Windows 10, version 1703. diff --git a/windows/client-management/mdm/dmprocessconfigxmlfiltered.md b/windows/client-management/mdm/dmprocessconfigxmlfiltered.md index ece8bfd765..1dbe4932a9 100644 --- a/windows/client-management/mdm/dmprocessconfigxmlfiltered.md +++ b/windows/client-management/mdm/dmprocessconfigxmlfiltered.md @@ -92,42 +92,13 @@ If **DMProcessConfigXMLFiltered** retrieves a document, the *pbstrXmlOut* holds Returns the standard **HRESULT** value **S\_OK** to indicate success. The following table shows more error codes that can be returned: - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Return codeDescription

CONFIG_E_OBJECTBUSY

Another instance of the configuration management service is currently running.

CONFIG_E_ENTRYNOTFOUND

No metabase entry was found.

CONFIG_E_CSPEXCEPTION

An exception occurred in one of the configuration service providers.

CONFIG_E_TRANSACTIONINGFAILURE

A configuration service provider failed to roll back properly. The affected settings might be in an unknown state.

CONFIG_E_BAD_XML

The XML input is invalid or malformed.

- - +|Return code|Description| +|--- |--- | +|**CONFIG_E_OBJECTBUSY**|Another instance of the configuration management service is currently running.| +|**CONFIG_E_ENTRYNOTFOUND**|No metabase entry was found.| +|**CONFIG_E_CSPEXCEPTION**|An exception occurred in one of the configuration service providers.| +|**CONFIG_E_TRANSACTIONINGFAILURE**|A configuration service provider failed to roll back properly. The affected settings might be in an unknown state.| +|**CONFIG_E_BAD_XML**|The XML input is invalid or malformed.| ## Remarks @@ -190,38 +161,14 @@ if ( bstr != NULL ) ## Requirements - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

Minimum supported client

None supported

Minimum supported server

None supported

Minimum supported phone

Windows Phone 8.1

Header

Dmprocessxmlfiltered.h

Library

Dmprocessxmlfiltered.lib

DLL

Dmprocessxmlfiltered.dll

+|Requirement|Support| +|--- |--- | +|Minimum supported client|None supported| +|Minimum supported server|None supported| +|Minimum supported phone|Windows Phone 8.1| +|Header|Dmprocessxmlfiltered.h| +|Library|Dmprocessxmlfiltered.lib| +|DLL|Dmprocessxmlfiltered.dll| ## See also diff --git a/windows/client-management/mdm/enterpriseappmanagement-csp.md b/windows/client-management/mdm/enterpriseappmanagement-csp.md index f5132cb038..1910df9821 100644 --- a/windows/client-management/mdm/enterpriseappmanagement-csp.md +++ b/windows/client-management/mdm/enterpriseappmanagement-csp.md @@ -17,7 +17,8 @@ ms.date: 06/26/2017 The EnterpriseAppManagement enterprise configuration service provider is used to handle enterprise application management tasks such as installing an enterprise application token, the first auto-downloadable app link, querying installed enterprise applications (name and version), auto updating already installed enterprise applications, and removing all installed enterprise apps (including the enterprise app token) during unenrollment. -> **Note**   The EnterpriseAppManagement CSP is only supported in Windows 10 Mobile. +> [!NOTE] +> The EnterpriseAppManagement CSP is only supported in Windows 10 Mobile. @@ -81,7 +82,8 @@ Optional. The character string that contains the search criteria to search for t Supported operations are Get and Add. -> **Note**   Do NOT use Subject=CN%3DB1C43CD0-1624-5FBB-8E54-34CF17DFD3A1\\x00. The server must replace this value in the supplied client certificate. If your server returns a client certificate containing the same Subject value, this can cause unexpected behavior. The server should always override the subject value and not use the default device-provided Device ID Subject= Subject=CN%3DB1C43CD0-1624-5FBB-8E54-34CF17DFD3A1\\x00 +> [!NOTE] +> Do NOT use Subject=CN%3DB1C43CD0-1624-5FBB-8E54-34CF17DFD3A1\\x00. The server must replace this value in the supplied client certificate. If your server returns a client certificate containing the same Subject value, this can cause unexpected behavior. The server should always override the subject value and not use the default device-provided Device ID Subject= Subject=CN%3DB1C43CD0-1624-5FBB-8E54-34CF17DFD3A1\\x00 @@ -158,48 +160,16 @@ Supported operations are Get, Add, and Replace. **/Download/*ProductID*/Status** Required. The integer value that indicates the status of the current download process. The following table shows the possible values. - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

0: CONFIRM

Waiting for confirmation from user.

1: QUEUED

Waiting for download to start.

2: DOWNLOADING

In the process of downloading.

3: DOWNLOADED

Waiting for installation to start.

4: INSTALLING

Handed off for installation.

5: INSTALLED

Successfully installed

6: FAILED

Application was rejected (not signed properly, bad XAP format, not enrolled properly, etc.)

7:DOWNLOAD_FAILED

Unable to connect to server, file doesn't exist, etc.

- - +|Value|Description| +|--- |--- | +|0: CONFIRM|Waiting for confirmation from user.| +|1: QUEUED|Waiting for download to start.| +|2: DOWNLOADING|In the process of downloading.| +|3: DOWNLOADED|Waiting for installation to start.| +|4: INSTALLING|Handed off for installation.| +|5: INSTALLED|Successfully installed| +|6: FAILED|Application was rejected (not signed properly, bad XAP format, not enrolled properly, etc.)| +|7:DOWNLOAD_FAILED|Unable to connect to server, file doesn't exist, etc.| Scope is dynamic. Supported operations are Get, Add, and Replace. @@ -463,10 +433,10 @@ Install or update the installed app with the product ID “{B316008A-141D-4A79-8 To perform an XAP update, create the Name, URL, Version, and DownloadInstall nodes first, then perform an “execute” on the “DownloadInstall” node (all within an “Atomic” operation). If the application does not exist, the application will be silently installed without any user interaction. If the application cannot be installed, the user will be notified with an Alert dialog. -> **Note**   -> 1. If a previous app-update node existed for this product ID (the node can persist for up to 1 week or 7 days after an installation has completed), then a 418 (already exist) error would be returned on the “Add”. To get around the 418 error, the server should issue a Replace command for the Name, URL, and Version nodes, and then execute on the “DownloadInstall” (within an “Atomic” operation). - -2. The application product ID curly braces need to be escaped where { is %7B and } is %7D. +> [!NOTE] +> - If a previous app-update node existed for this product ID (the node can persist for up to 1 week or 7 days after an installation has completed), then a 418 (already exist) error would be returned on the “Add”. To get around the 418 error, the server should issue a Replace command for the Name, URL, and Version nodes, and then execute on the “DownloadInstall” (within an “Atomic” operation). +> +> - The application product ID curly braces need to be escaped where { is %7B and } is %7D. diff --git a/windows/client-management/mdm/enterpriseassignedaccess-csp.md b/windows/client-management/mdm/enterpriseassignedaccess-csp.md index ee057f96bd..db8f48e055 100644 --- a/windows/client-management/mdm/enterpriseassignedaccess-csp.md +++ b/windows/client-management/mdm/enterpriseassignedaccess-csp.md @@ -17,12 +17,14 @@ ms.date: 07/12/2017 The EnterpriseAssignedAccess configuration service provider allows IT administrators to configure settings, such as language and themes, lock down a device, and configure custom layouts on a device. For example, the administrator can lock down a device so that only applications specified in an Allow list are available. Apps not on the Allow list remain installed on the device, but are hidden from view and blocked from launching. -> **Note**   The EnterpriseAssignedAccess CSP is only supported in Windows 10 Mobile. +> [!NOTE] +> The EnterpriseAssignedAccess CSP is only supported in Windows 10 Mobile. For more information about how to interact with the lockdown XML at runtime, see [**DeviceLockdownProfile class**](/uwp/api/Windows.Embedded.DeviceLockdown.DeviceLockdownProfile). The following shows the EnterpriseAssignedAccess configuration service provider in tree format as used by both the Open Mobile Alliance (OMA) Device Management (DM) and OMA Client Provisioning. -``` + +```console ./Vendor/MSFT EnterpriseAssignedAccess ----AssignedAccess @@ -38,6 +40,7 @@ EnterpriseAssignedAccess ----Locale --------Language ``` + The following list shows the characteristics and parameters. **./Vendor/MSFT/EnterpriseAssignedAccess/** @@ -631,110 +634,30 @@ Supported operations are Get and Replace. **Theme/ThemeAccentColorID** The accent color to apply as the foreground color for tiles, controls, and other visual elements on the device. The following table shows the possible values. - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription

0

Lime

1

Green

2

Emerald

3

Teal (Viridian)

4

Cyan (Blue)

5

Cobalt

6

Indigo

7

Violet (Purple)

8

Pink

9

Magenta

10

Crimson

11

Red

12

Orange (Mango)

13

Amber

14

Yellow

15

Brown

16

Olive

17

Steel

18

Mauve

19

Sienna

101 through 104

Optional colors, as defined by the OEM

151

Custom accent color for Enterprise

- - +|Value|Description| +|--- |--- | +|0|Lime| +|1|Green| +|2|Emerald| +|3|Teal (Viridian)| +|4|Cyan (Blue)| +|5|Cobalt| +|6|Indigo| +|7|Violet (Purple)| +|8|Pink| +|9|Magenta| +|10|Crimson| +|11|Red| +|12|Orange (Mango)| +|13|Amber| +|14|Yellow| +|15|Brown| +|16|Olive| +|17|Steel| +|18|Mauve| +|19|Sienna| +|101 through 104|Optional colors, as defined by the OEM| +|151|Custom accent color for Enterprise| Supported operations are Get and Replace. @@ -758,440 +681,119 @@ An integer that specifies the time zone of the device. The following table shows Supported operations are Get and Replace. - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueTime zone

0

UTC-12 International Date Line West

100

UTC+13 Samoa

110

UTC-11 Coordinated Universal Time-11

200

UTC-10 Hawaii

300

UTC-09 Alaska

400

UTC-08 Pacific Time (US & Canada)

410

UTC-08 Baja California

500

UTC-07 Mountain Time (US & Canada)

510

UTC-07 Chihuahua, La Paz, Mazatlan

520

UTC-07 Arizona

600

UTC-06 Saskatchewan

610

UTC-06 Central America

620

UTC-06 Central Time (US & Canada)

630

UTC-06 Guadalajara, Mexico City, Monterrey

700

UTC-05 Eastern Time (US & Canada)

710

UTC-05 Bogota, Lima, Quito

720

UTC-05 Indiana (East)

800

UTC-04 Atlantic Time (Canada)

810

UTC-04 Cuiaba

820

UTC-04 Santiago

830

UTC-04 Georgetown, La Paz, Manaus, San Juan

840

UTC-04 Caracas

850

UTC-04 Asuncion

900

UTC-03:30 Newfoundland

910

UTC-03 Brasilia

920

UTC-03 Greenland

930

UTC-03 Montevideo

940

UTC-03 Cayenne, Fortaleza

950

UTC-03 Buenos Aires

960

UTC-03 Salvador

1000

UTC-02 Mid-Atlantic

1010

UTC-02 Coordinated Universal Time-02

1100

UTC-01 Azores

1110

UTC-01 Cabo Verde

1200

UTC Dublin, Edinburgh, Lisbon, London

1210

UTC Monrovia, Reykjavik

1220

UTC Casablanca

1230

UTC Coordinated Universal Time

1300

UTC+01 Belgrade, Bratislava, Budapest, Ljubljana, Prague

1310

UTC+01 Sarajevo, Skopje, Warsaw, Zagreb

1320

UTC+01 Brussels, Copenhagen, Madrid, Paris

1330

UTC+01 West Central Africa

1340

UTC+01 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna

1350

UTC+01 Windhoek

1360

UTC+01 Tripoli

1400

UTC+02 E. Europe

1410

UTC+02 Cairo

1420

UTC+02 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius

1430

UTC+02 Athens, Bucharest

1440

UTC+02 Jerusalem

1450

UTC+02 Amman

1460

UTC+02 Beirut

1470

UTC+02 Harare, Pretoria

1480

UTC+02 Damascus

1490

UTC+02 Istanbul

1500

UTC+03 Kuwait, Riyadh

1510

UTC+03 Baghdad

1520

UTC+03 Nairobi

1530

UTC+03 Kaliningrad, Minsk

1540

UTC+04 Moscow, St. Petersburg, Volgograd

1550

UTC+03 Tehran

1600

UTC+04 Abu Dhabi, Muscat

1610

UTC+04 Baku

1620

UTC+04 Yerevan

1630

UTC+04 Kabul

1640

UTC+04 Tbilisi

1650

UTC+04 Port Louis

1700

UTC+06 Ekaterinburg

1710

UTC+05 Tashkent

1720

UTC+05 Chennai, Kolkata, Mumbai, New Delhi

1730

UTC+05 Sri Jayawardenepura

1740

UTC+05 Kathmandu

1750

UTC+05 Islamabad, Karachi

1800

UTC+06 Astana

1810

UTC+07 Novosibirsk

1820

UTC+06 Yangon (Rangoon)

1830

UTC+06 Dhaka

1900

UTC+08 Krasnoyarsk

1910

UTC+07 Bangkok, Hanoi, Jakarta

1900

UTC+08 Krasnoyarsk

2000

UTC+08 Beijing, Chongqing, Hong Kong SAR, Urumqi

2010

UTC+09 Irkutsk

2020

UTC+08 Kuala Lumpur, Singapore

2030

UTC+08 Taipei

2040

UTC+08 Perth

2050

UTC+08 Ulaanbaatar

2100

UTC+09 Seoul

2110

UTC+09 Osaka, Sapporo, Tokyo

2120

UTC+10 Yakutsk

2130

UTC+09 Darwin

2140

UTC+09 Adelaide

2200

UTC+10 Canberra, Melbourne, Sydney

2210

UTC+10 Brisbane

2220

UTC+10 Hobart

2230

UTC+11 Vladivostok

2240

UTC+10 Guam, Port Moresby

2300

UTC+11 Solomon Is., New Caledonia

2310

UTC+12 Magadan

2400

UTC+12 Fiji

2410

UTC+12 Auckland, Wellington

2420

UTC+12 Petropavlovsk-Kamchatsky

2430

UTC+12 Coordinated Universal Time +12

2500

UTC+13 Nuku'alofa

- +|Value|Time zone| +|--- |--- | +|0|UTC-12 International Date Line West| +|100|UTC+13 Samoa| +|110|UTC-11 Coordinated Universal Time-11| +|200|UTC-10 Hawaii| +|300|UTC-09 Alaska| +|400|UTC-08 Pacific Time (US & Canada)| +|410|UTC-08 Baja California| +|500|UTC-07 Mountain Time (US & Canada)| +|510|UTC-07 Chihuahua, La Paz, Mazatlan| +|520|UTC-07 Arizona| +|600|UTC-06 Saskatchewan| +|610|UTC-06 Central America| +|620|UTC-06 Central Time (US & Canada)| +|630|UTC-06 Guadalajara, Mexico City, Monterrey| +|700|UTC-05 Eastern Time (US & Canada)| +|710|UTC-05 Bogota, Lima, Quito| +|720|UTC-05 Indiana (East)| +|800|UTC-04 Atlantic Time (Canada)| +|810|UTC-04 Cuiaba| +|820|UTC-04 Santiago| +|830|UTC-04 Georgetown, La Paz, Manaus, San Juan| +|840|UTC-04 Caracas| +|850|UTC-04 Asuncion| +|900|UTC-03:30 Newfoundland| +|910|UTC-03 Brasilia| +|920|UTC-03 Greenland| +|930|UTC-03 Montevideo| +|940|UTC-03 Cayenne, Fortaleza| +|950|UTC-03 Buenos Aires| +|960|UTC-03 Salvador| +|1000|UTC-02 Mid-Atlantic| +|1010|UTC-02 Coordinated Universal Time-02| +|1100|UTC-01 Azores| +|1110|UTC-01 Cabo Verde| +|1200|UTC Dublin, Edinburgh, Lisbon, London| +|1210|UTC Monrovia, Reykjavik| +|1220|UTC Casablanca| +|1230|UTC Coordinated Universal Time| +|1300|UTC+01 Belgrade, Bratislava, Budapest, Ljubljana, Prague| +|1310|UTC+01 Sarajevo, Skopje, Warsaw, Zagreb| +|1320|UTC+01 Brussels, Copenhagen, Madrid, Paris| +|1330|UTC+01 West Central Africa| +|1340|UTC+01 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna| +|1350|UTC+01 Windhoek| +|1360|UTC+01 Tripoli| +|1400|UTC+02 E. Europe| +|1410|UTC+02 Cairo| +|1420|UTC+02 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius| +|1430|UTC+02 Athens, Bucharest| +|1440|UTC+02 Jerusalem| +|1450|UTC+02 Amman| +|1460|UTC+02 Beirut| +|1470|UTC+02 Harare, Pretoria| +|1480|UTC+02 Damascus| +|1490|UTC+02 Istanbul| +|1500|UTC+03 Kuwait, Riyadh| +|1510|UTC+03 Baghdad| +|1520|UTC+03 Nairobi| +|1530|UTC+03 Kaliningrad, Minsk| +|1540|UTC+04 Moscow, St. Petersburg, Volgograd| +|1550|UTC+03 Tehran| +|1600|UTC+04 Abu Dhabi, Muscat| +|1610|UTC+04 Baku| +|1620|UTC+04 Yerevan| +|1630|UTC+04 Kabul| +|1640|UTC+04 Tbilisi| +|1650|UTC+04 Port Louis| +|1700|UTC+06 Ekaterinburg| +|1710|UTC+05 Tashkent| +|1720|UTC+05 Chennai, Kolkata, Mumbai, New Delhi| +|1730|UTC+05 Sri Jayawardenepura| +|1740|UTC+05 Kathmandu| +|1750|UTC+05 Islamabad, Karachi| +|1800|UTC+06 Astana| +|1810|UTC+07 Novosibirsk| +|1820|UTC+06 Yangon (Rangoon)| +|1830|UTC+06 Dhaka| +|1900|UTC+08 Krasnoyarsk| +|1910|UTC+07 Bangkok, Hanoi, Jakarta| +|1900|UTC+08 Krasnoyarsk| +|2000|UTC+08 Beijing, Chongqing, Hong Kong SAR, Urumqi| +|2010|UTC+09 Irkutsk| +|2020|UTC+08 Kuala Lumpur, Singapore| +|2030|UTC+08 Taipei| +|2040|UTC+08 Perth| +|2050|UTC+08 Ulaanbaatar| +|2100|UTC+09 Seoul| +|2110|UTC+09 Osaka, Sapporo, Tokyo| +|2120|UTC+10 Yakutsk| +|2130|UTC+09 Darwin| +|2140|UTC+09 Adelaide| +|2200|UTC+10 Canberra, Melbourne, Sydney| +|2210|UTC+10 Brisbane| +|2220|UTC+10 Hobart| +|2230|UTC+11 Vladivostok| +|2240|UTC+10 Guam, Port Moresby| +|2300|UTC+11 Solomon Is., New Caledonia| +|2310|UTC+12 Magadan| +|2400|UTC+12 Fiji| +|2410|UTC+12 Auckland, Wellington| +|2420|UTC+12 Petropavlovsk-Kamchatsky| +|2430|UTC+12 Coordinated Universal Time +12| +|2500|UTC+13 Nuku'alofa| **Locale/Language/** The culture code that identifies the language to display on a device, and specifies the formatting of numbers, currencies, time, and dates. For language values, see [Locale IDs Assigned by Microsoft](/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c). The language setting is configured in the Default User profile only. -> **Note**  Apply the Locale ID only after the corresponding language packs are built into and supported for the OS image running on the device. The specified language will be applied as the phone language and a restart may be required. +> [!NOTE] +> Apply the Locale ID only after the corresponding language packs are built into and supported for the OS image running on the device. The specified language will be applied as the phone language and a restart may be required. Supported operations are Get and Replace. @@ -1200,7 +802,8 @@ Supported operations are Get and Replace. The XML examples in this section show how to perform various tasks by using OMA client provisioning. -> **Note**  These examples are XML snippets and do not include all sections that are required for a complete lockdown XML file. +> [!NOTE] +> These examples are XML snippets and do not include all sections that are required for a complete lockdown XML file. @@ -1469,212 +1072,45 @@ The following example shows how to set the language. ## Product IDs in Windows 10 Mobile - The following table lists the product ID and AUMID for each app that is included in Windows 10 Mobile. - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AppProduct IDAUMID
Alarms and clock44F7D2B4-553D-4BEC-A8B7-634CE897ED5FMicrosoft.WindowsAlarms_8wekyb3d8bbwe!App
CalculatorB58171C6-C70C-4266-A2E8-8F9C994F4456Microsoft.WindowsCalculator_8wekyb3d8bbwe!App
CameraF0D8FEFD-31CD-43A1-A45A-D0276DB069F1Microsoft.WindowsCamera_8wekyb3d8bbwe!App
Contact Support0DB5FCFF-4544-458A-B320-E352DFD9CA2BWindows.ContactSupport_cw5n1h2txyewy!App
CortanaFD68DCF4-166F-4C55-A4CA-348020F71B94Microsoft.Windows.Cortana_cw5n1h2txyewy!CortanaUI
ExcelEAD3E7C0-FAE6-4603-8699-6A448138F4DCMicrosoft.Office.Excel_8wekyb3d8bbwe!microsoft.excel
Facebook82A23635-5BD9-DF11-A844-00237DE2DB9EMicrosoft.MSFacebook_8wekyb3d8bbwe!x82a236355bd9df11a84400237de2db9e
File ExplorerC5E2524A-EA46-4F67-841F-6A9465D9D515c5e2524a-ea46-4f67-841f-6a9465d9d515_cw5n1h2txyewy!App
FM RadioF725010E-455D-4C09-AC48-BCDEF0D4B626N/A
Get StartedB3726308-3D74-4A14-A84C-867C8C735C3CMicrosoft.Getstarted_8wekyb3d8bbwe!App
Groove MusicD2B6A184-DA39-4C9A-9E0A-8B589B03DEC0Microsoft.ZuneMusic_8wekyb3d8bbwe!Microsoft.ZuneMusic
MapsED27A07E-AF57-416B-BC0C-2596B622EF7DMicrosoft.WindowsMaps_8wekyb3d8bbwe!App
Messaging27E26F40-E031-48A6-B130-D1F20388991AMicrosoft.Messaging_8wekyb3d8bbwe!x27e26f40ye031y48a6yb130yd1f20388991ax
Microsoft Edge395589FB-5884-4709-B9DF-F7D558663FFDMicrosoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge
Money1E0440F1-7ABF-4B9A-863D-177970EEFB5EMicrosoft.BingFinance_8wekyb3d8bbwe!AppexFinance
Movies and TV6AFFE59E-0467-4701-851F-7AC026E21665Microsoft.ZuneVideo_8wekyb3d8bbwe!Microsoft.ZuneVideo
News9C3E8CAD-6702-4842-8F61-B8B33CC9CAF1Microsoft.BingNews_8wekyb3d8bbwe!AppexNews
OneDriveAD543082-80EC-45BB-AA02-FFE7F4182BA8Microsoft.MicrosoftSkydrive_8wekyb3d8bbwe!App
OneNoteCA05B3AB-F157-450C-8C49-A1F127F5E71DMicrosoft.Office.OneNote_8wekyb3d8bbwe!microsoft.onenoteim
Outlook Calendar

A558FEBA-85D7-4665-B5D8-A2FF9C19799B

Microsoft.WindowsCommunicationsApps_8wekyb3d8bbwe!Microsoft.WindowsLive.Calendar

Outlook Mail

A558FEBA-85D7-4665-B5D8-A2FF9C19799B

Microsoft.WindowsCommunicationsApps_8wekyb3d8bbwe!Microsoft.WindowsLive.Mail

People60BE1FB8-3291-4B21-BD39-2221AB166481Microsoft.People_8wekyb3d8bbwe!xb94d6231y84ddy49a8yace3ybc955e769e85x
Phone (dialer)F41B5D0E-EE94-4F47-9CFE-3D3934C5A2C7Microsoft.CommsPhone_8wekyb3d8bbwe!App
PhotosFCA55E1B-B9A4-4289-882F-084EF4145005Microsoft.Windows.Photos_8wekyb3d8bbwe!App
PodcastsC3215724-B279-4206-8C3E-61D1A9D63ED3Microsoft.MSPodcast_8wekyb3d8bbwe!xc3215724yb279y4206y8c3ey61d1a9d63ed3x
PowerPointB50483C4-8046-4E1B-81BA-590B24935798Microsoft.Office.PowerPoint_8wekyb3d8bbwe!microsoft.pptim
Settings2A4E62D8-8809-4787-89F8-69D0F01654FB2a4e62d8-8809-4787-89f8-69d0f01654fb_8wekyb3d8bbwe!App
SkypeC3F8E570-68B3-4D6A-BDBB-C0A3F4360A51Microsoft.SkypeApp_kzf8qxf38zg5c!Skype.AppId
Skype Video27E26F40-E031-48A6-B130-D1F20388991AMicrosoft.Messaging_8wekyb3d8bbwe!App
Sports0F4C8C7E-7114-4E1E-A84C-50664DB13B17Microsoft.BingSports_8wekyb3d8bbwe!AppexSports
Storage5B04B775-356B-4AA0-AAF8-6491FFEA564DN/A
Store7D47D89A-7900-47C5-93F2-46EB6D94C159Microsoft.WindowsStore_8wekyb3d8bbwe!App
Voice recorder7311B9C5-A4E9-4C74-BC3C-55B06BA95AD0Microsoft.WindowsSoundRecorder_8wekyb3d8bbwe!App
Wallet587A4577-7868-4745-A29E-F996203F1462Microsoft.MicrosoftWallet_8wekyb3d8bbwe!App
Weather63C2A117-8604-44E7-8CEF-DF10BE3A57C8Microsoft.BingWeather_8wekyb3d8bbwe!App
Windows Feedback7604089D-D13F-4A2D-9998-33FC02B63CE3Microsoft.WindowsFeedback_8wekyb3d8bbwe!App
Word258F115C-48F4-4ADB-9A68-1387E634459BMicrosoft.Office.Word_8wekyb3d8bbwe!microsoft.word
XboxB806836F-EEBE-41C9-8669-19E243B81B83Microsoft.XboxApp_8wekyb3d8bbwe!Microsoft.XboxApp
\ No newline at end of file +|App|Product ID|AUMID| +|--- |--- |--- | +|Alarms and clock|44F7D2B4-553D-4BEC-A8B7-634CE897ED5F|Microsoft.WindowsAlarms_8wekyb3d8bbwe!App| +|Calculator|B58171C6-C70C-4266-A2E8-8F9C994F4456|Microsoft.WindowsCalculator_8wekyb3d8bbwe!App| +|Camera|F0D8FEFD-31CD-43A1-A45A-D0276DB069F1|Microsoft.WindowsCamera_8wekyb3d8bbwe!App| +|Contact Support|0DB5FCFF-4544-458A-B320-E352DFD9CA2B|Windows.ContactSupport_cw5n1h2txyewy!App| +|Cortana|FD68DCF4-166F-4C55-A4CA-348020F71B94|Microsoft.Windows.Cortana_cw5n1h2txyewy!CortanaUI| +|Excel|EAD3E7C0-FAE6-4603-8699-6A448138F4DC|Microsoft.Office.Excel_8wekyb3d8bbwe!microsoft.excel| +|Facebook|82A23635-5BD9-DF11-A844-00237DE2DB9E|Microsoft.MSFacebook_8wekyb3d8bbwe!x82a236355bd9df11a84400237de2db9e| +|File Explorer|C5E2524A-EA46-4F67-841F-6A9465D9D515|c5e2524a-ea46-4f67-841f-6a9465d9d515_cw5n1h2txyewy!App| +|FM Radio|F725010E-455D-4C09-AC48-BCDEF0D4B626|N/A| +|Get Started|B3726308-3D74-4A14-A84C-867C8C735C3C|Microsoft.Getstarted_8wekyb3d8bbwe!App| +|Groove Music|D2B6A184-DA39-4C9A-9E0A-8B589B03DEC0|Microsoft.ZuneMusic_8wekyb3d8bbwe!Microsoft.ZuneMusic| +|Maps|ED27A07E-AF57-416B-BC0C-2596B622EF7D|Microsoft.WindowsMaps_8wekyb3d8bbwe!App| +|Messaging|27E26F40-E031-48A6-B130-D1F20388991A|Microsoft.Messaging_8wekyb3d8bbwe!x27e26f40ye031y48a6yb130yd1f20388991ax| +|Microsoft Edge|395589FB-5884-4709-B9DF-F7D558663FFD|Microsoft.MicrosoftEdge_8wekyb3d8bbwe!MicrosoftEdge| +|Money|1E0440F1-7ABF-4B9A-863D-177970EEFB5E|Microsoft.BingFinance_8wekyb3d8bbwe!AppexFinance| +|Movies and TV|6AFFE59E-0467-4701-851F-7AC026E21665|Microsoft.ZuneVideo_8wekyb3d8bbwe!Microsoft.ZuneVideo| +|News|9C3E8CAD-6702-4842-8F61-B8B33CC9CAF1|Microsoft.BingNews_8wekyb3d8bbwe!AppexNews| +|OneDrive|AD543082-80EC-45BB-AA02-FFE7F4182BA8|Microsoft.MicrosoftSkydrive_8wekyb3d8bbwe!App| +|OneNote|CA05B3AB-F157-450C-8C49-A1F127F5E71D|Microsoft.Office.OneNote_8wekyb3d8bbwe!microsoft.onenoteim| +|Outlook Calendar|A558FEBA-85D7-4665-B5D8-A2FF9C19799B|Microsoft.WindowsCommunicationsApps_8wekyb3d8bbwe!Microsoft.WindowsLive.Calendar| +|Outlook Mail|A558FEBA-85D7-4665-B5D8-A2FF9C19799B|Microsoft.WindowsCommunicationsApps_8wekyb3d8bbwe!Microsoft.WindowsLive.Mail| +|People|60BE1FB8-3291-4B21-BD39-2221AB166481|Microsoft.People_8wekyb3d8bbwe!xb94d6231y84ddy49a8yace3ybc955e769e85x| +|Phone (dialer)|F41B5D0E-EE94-4F47-9CFE-3D3934C5A2C7|Microsoft.CommsPhone_8wekyb3d8bbwe!App| +|Photos|FCA55E1B-B9A4-4289-882F-084EF4145005|Microsoft.Windows.Photos_8wekyb3d8bbwe!App| +|Podcasts|C3215724-B279-4206-8C3E-61D1A9D63ED3|Microsoft.MSPodcast_8wekyb3d8bbwe!xc3215724yb279y4206y8c3ey61d1a9d63ed3x| +|PowerPoint|B50483C4-8046-4E1B-81BA-590B24935798|Microsoft.Office.PowerPoint_8wekyb3d8bbwe!microsoft.pptim| +|Settings|2A4E62D8-8809-4787-89F8-69D0F01654FB|2a4e62d8-8809-4787-89f8-69d0f01654fb_8wekyb3d8bbwe!App| +|Skype|C3F8E570-68B3-4D6A-BDBB-C0A3F4360A51|Microsoft.SkypeApp_kzf8qxf38zg5c!Skype.AppId| +|Skype Video|27E26F40-E031-48A6-B130-D1F20388991A|Microsoft.Messaging_8wekyb3d8bbwe!App| +|Sports|0F4C8C7E-7114-4E1E-A84C-50664DB13B17|Microsoft.BingSports_8wekyb3d8bbwe!AppexSports| +|Storage|5B04B775-356B-4AA0-AAF8-6491FFEA564D|N/A| +|Store|7D47D89A-7900-47C5-93F2-46EB6D94C159|Microsoft.WindowsStore_8wekyb3d8bbwe!App| +|Voice recorder|7311B9C5-A4E9-4C74-BC3C-55B06BA95AD0|Microsoft.WindowsSoundRecorder_8wekyb3d8bbwe!App| +|Wallet|587A4577-7868-4745-A29E-F996203F1462|Microsoft.MicrosoftWallet_8wekyb3d8bbwe!App| +|Weather|63C2A117-8604-44E7-8CEF-DF10BE3A57C8|Microsoft.BingWeather_8wekyb3d8bbwe!App| +|Windows Feedback|7604089D-D13F-4A2D-9998-33FC02B63CE3|Microsoft.WindowsFeedback_8wekyb3d8bbwe!App| +|Word|258F115C-48F4-4ADB-9A68-1387E634459B|Microsoft.Office.Word_8wekyb3d8bbwe!microsoft.word| +|Xbox|B806836F-EEBE-41C9-8669-19E243B81B83|Microsoft.XboxApp_8wekyb3d8bbwe!Microsoft.XboxApp| diff --git a/windows/client-management/mdm/enterprisedataprotection-csp.md b/windows/client-management/mdm/enterprisedataprotection-csp.md index 3b596b6652..07388f0b79 100644 --- a/windows/client-management/mdm/enterprisedataprotection-csp.md +++ b/windows/client-management/mdm/enterprisedataprotection-csp.md @@ -30,7 +30,8 @@ To learn more about WIP, see the following articles: - [General guidance and best practices for Windows Information Protection (WIP)](/windows/security/information-protection/windows-information-protection/guidance-and-best-practices-wip) The following shows the EnterpriseDataProtection CSP in tree format. -``` + +```console ./Device/Vendor/MSFT EnterpriseDataProtection ----Settings @@ -45,6 +46,7 @@ EnterpriseDataProtection --------EDPShowIcons ----Status ``` + **./Device/Vendor/MSFT/EnterpriseDataProtection** The root node for the CSP. @@ -71,7 +73,6 @@ Changing the primary enterprise ID is not supported and may cause unexpected beh > [!Note] > The client requires domain name to be canonical, otherwise the setting will be rejected by the client. - Here are the steps to create canonical domain names: @@ -111,7 +112,6 @@ The CSP checks the current edition and hardware support (TPM), and returns an er > [!Note] > This setting is only supported in Windows 10 Mobile. - Supported operations are Add, Get, Replace, and Delete. Value type is integer. @@ -124,7 +124,7 @@ Specifies a recovery certificate that can be used for data recovery of encrypted DRA information from MDM policy must be a serialized binary blob identical to what we expect from GP. The binary blob is the serialized version of following structure: -``` syntax +```cpp // //  Recovery Policy Data Structures // @@ -243,7 +243,6 @@ typedef enum _PUBLIC_KEY_SOURCE_TAG { EfsCertificate, EfsCertificateThumbprint } PUBLIC_KEY_SOURCE_TAG, *PPUBLIC_KEY_SOURCE_TAG; - ``` For EFSCertificate KeyTag, it is expected to be a DER ENCODED binary certificate. @@ -300,36 +299,9 @@ A read-only bit mask that indicates the current state of WIP on the Device. The Suggested values: - ------- - - - - - - - - - - - - - - - - -

Reserved for future use

WIP mandatory settings

-

Set = 1

-

Not set = 0

Reserved for future use

AppLocker configured

-

Yes = 1

-

No = 0

WIP on = 1

-

WIP off = 0

4

3

2

1

0

+|Reserved for future use|WIP mandatory settings
Set = 1
Not set = 0|Reserved for future use|AppLocker configured
Yes = 1
No = 0|WIP on = 1
WIP off = 0| +|--- |--- |--- |--- |--- | +|4|3|2|1|0| diff --git a/windows/client-management/mdm/enterprisedesktopappmanagement-csp.md b/windows/client-management/mdm/enterprisedesktopappmanagement-csp.md index 78f0b5cb28..70beb72229 100644 --- a/windows/client-management/mdm/enterprisedesktopappmanagement-csp.md +++ b/windows/client-management/mdm/enterprisedesktopappmanagement-csp.md @@ -259,41 +259,12 @@ The following table describes the fields in the previous sample: The following table describes the fields in the previous sample: - ---- - - - - - - - - - - - - - - - - +|Name|Description| +|--- |--- | +|Add|This is required to precede the Exec command.
  • CmdID - Input value used to reference the request. Responses includes this value, which can be use to match the request and response.
  • LocURI - Path to Win32 CSP command processor, including the Product ID (in this example, 1803A630-3C38-4D2B-9B9A-0CB37243539C) property escaped for XML formatting.| +|Exec|The Exec node includes the parameters and properties requires to locate, download, validate and perform product installation.
  • CmdID - Input value used to reference the request. Responses will include this value which can be used to match request and response.
  • LocURI - Path to Win32 CSP command processor, including the Product ID (in this example, 1803A630-3C38-4D2B-9B9A-0CB37243539C) property escaped for XML formatting.
  • Data - The Data node contains an embedded XML, of type “MsiInstallJob”
  • MsiInstallJob - Contains all information required for the successful download, validation and execution of the MSI installation process (see section at the end of this document for details on this embedded data object).|
  • NameDescription
    AddThis is required to precede the Exec command. -
      -
    • CmdID - Input value used to reference the request. Responses includes this value, which can be use to match the request and response.
    • -
    • LocURI - Path to Win32 CSP command processor, including the Product ID (in this example, 1803A630-3C38-4D2B-9B9A-0CB37243539C) property escaped for XML formatting.
    • -
    ExecThe Exec node includes the parameters and properties requires to locate, download, validate and perform product installation. -
      -
    • CmdID - Input value used to reference the request. Responses will include this value which can be used to match request and response.
    • -
    • LocURI - Path to Win32 CSP command processor, including the Product ID (in this example, 1803A630-3C38-4D2B-9B9A-0CB37243539C) property escaped for XML formatting.
    • -
    • Data - The Data node contains an embedded XML, of type “MsiInstallJob”
    • -
    • MsiInstallJob - Contains all information required for the successful download, validation and execution of the MSI installation process (see section at the end of this document for details on this embedded data object).
    • -
    - - > [!Note] > Information status on the MSI job will be reported using standard OMA-DM notification mechanism. The status reported is represented using standard MSIEXEC return codes as HRESULT as defined in the MSIEXEC topic on Microsoft TechNet at [Msiexec (command-line options)](https://technet.microsoft.com/library/cc759262%28v=ws.10%29.aspx). @@ -353,70 +324,20 @@ The following table describes the fields in the previous sample: The following table MsiInstallJob describes the schema elements. - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ElementDescription
    MsiInstallJobroot element -

    "Attribute: "id - the application identifier of the application being installed

    Productchild element of MsiInstallJob -

    Attribute: “Version” – string representation of application version

    Downloadchild element of Product. Container for download configuration information.
    ContentURLListchild element of Download. Contains list of 1 or more content download URL locators in the form of ContentURL elements.
    ContentURLLocation content should be downloaded from. Must be a property formatted URL that points to the .MSI file.
    ValidationContains information used to validate contend authenticity. • FileHash – SHA256 hash value of file content
    FileHashSHA256 hash value of file content
    Enforcementinstallation properties to be used when installing this MSI
    CommandLineCommand-line options to be used when calling MSIEXEC.exe
    TimeOutAmount of time, in minutes that the installation process can run before the installer considers the installation may have failed and no longer monitors the installation operation.
    RetryCountThe number of times the download and installation operation will be retried before the installation will be marked as failed.
    RetryIntervalAmount of time, in minutes between retry operations.
    +|Element|Description| +|--- |--- | +|MsiInstallJob|root element
    "Attribute: "id - the application identifier of the application being installed| +|Product|child element of MsiInstallJob
    Attribute: “Version” – string representation of application version| +|Download|child element of Product. Container for download configuration information.| +|ContentURLList|child element of Download. Contains list of 1 or more content download URL locators in the form of ContentURL elements.| +|ContentURL|Location content should be downloaded from. Must be a property formatted URL that points to the .MSI file.| +|Validation|Contains information used to validate contend authenticity. • FileHash – SHA256 hash value of file content| +|FileHash|SHA256 hash value of file content| +|Enforcement|installation properties to be used when installing this MSI| +|CommandLine|Command-line options to be used when calling MSIEXEC.exe| +|TimeOut|Amount of time, in minutes that the installation process can run before the installer considers the installation may have failed and no longer monitors the installation operation.| +|RetryCount|The number of times the download and installation operation will be retried before the installation will be marked as failed.| +|RetryInterval|Amount of time, in minutes between retry operations.| @@ -453,85 +374,17 @@ The following tables shows how app targeting and MSI package type (per-user, per For Intune standalone environment, the MSI package will determine the MSI execution context. - ------ - - - - - - - - - - - - - - - - - - - - - - -
    TargetPer-user MSIPer-machine MSIDual mode MSI
    UserInstall the MSI per-user -

    LocURI contains a User prefix, such as ./User

    Install the MSI per-device -

    LocURI contains a Device prefix, such as ./Device

    Install the MSI per-user -

    LocURI contains a User prefix, such as ./User

    SystemInstall the MSI per-user -

    LocURI contains a User prefix, such as ./User

    Install the MSI per-device -

    LocURI contains a Device prefix, such as ./Device

    Install the MSI per-user -

    LocURI contains a User prefix, such as ./User

    - - +|Target|Per-user MSI|Per-machine MSI|Dual mode MSI| +|--- |--- |--- |--- | +|User|Install the MSI per-user
    LocURI contains a User prefix, such as ./User|Install the MSI per-device
    LocURI contains a Device prefix, such as ./Device|Install the MSI per-user
    LocURI contains a User prefix, such as ./User| +|System|Install the MSI per-user
    LocURI contains a User prefix, such as ./User|Install the MSI per-device
    LocURI contains a Device prefix, such as ./Device|Install the MSI per-user
    LocURI contains a User prefix, such as ./User| The following table applies to SCCM hybrid environment. - ------ - - - - - - - - - - - - - - - - - - - - - - -
    TargetPer-user MSIPer-machine MSIDual mode MSI
    UserInstall the MSI per-user -

    LocURI contains a User prefix, such as ./User

    Install the MSI per-device -

    LocURI contains a Device prefix, such as ./Device

    Install the MSI per-user -

    LocURI contains a User prefix, such as ./User

    SystemInstall the MSI per-user -

    LocURI contains a User prefix, such as ./User

    Install the MSI per-device -

    LocURI contains a Device prefix, such as ./Device

    Install the MSI per- system context -

    LocURI contains a Device prefix, such as ./Device

    - - +|Target|Per-user MSI|Per-machine MSI|Dual mode MSI| +|--- |--- |--- |--- | +|User|Install the MSI per-user
    LocURI contains a User prefix, such as ./User|Install the MSI per-device
    LocURI contains a Device prefix, such as ./Device|Install the MSI per-user
    LocURI contains a User prefix, such as ./User| +|System|Install the MSI per-user
    LocURI contains a User prefix, such as ./User|Install the MSI per-device
    LocURI contains a Device prefix, such as ./Device|Install the MSI per- system context
    LocURI contains a Device prefix, such as ./Device| ## How to determine the package type from the MSI package diff --git a/windows/client-management/mdm/get-inventory.md b/windows/client-management/mdm/get-inventory.md index 94c9465267..4c01145bb3 100644 --- a/windows/client-management/mdm/get-inventory.md +++ b/windows/client-management/mdm/get-inventory.md @@ -21,143 +21,34 @@ The **Get Inventory** operation retrieves information from the Microsoft Store f ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Inventory?continuationToken={ContinuationToken}&modifiedSince={ModifiedSince}&licenseTypes={LicenseType}&maxResults={MaxResults}

    - - - +**GET:** +```http +https://bspmts.mp.microsoft.com/V1/Inventory?continuationToken={ContinuationToken}&modifiedSince={ModifiedSince}&licenseTypes={LicenseType}&maxResults={MaxResults} +``` ### URI parameters The following parameters may be specified in the request URI. - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDefault valueDescription

    continuationToken

    string

    Null

    modifiedSince

    datetime

    Null

    Optional. Used to determine changes since a specific date.

    licenseTypes

    collection of LicenseType

    {online,offline}

    Optional. A collection of license types

    maxResults

    integer-32

    25

    Optional. Specifies the maximum number of applications returned in a single query.

    - - - +|Parameter|Type|Default value|Description| +|--- |--- |--- |--- | +|continuationToken|string|Null|| +|modifiedSince|datetime|Null|Optional. Used to determine changes since a specific date.| +|licenseTypes|collection of [LicenseType](data-structures-windows-store-for-business.md#licensetype)|{online,offline}|Optional. A collection of license types| +|maxResults|integer-32|25|Optional. Specifies the maximum number of applications returned in a single query.| Here are some examples. - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
    Query typeExample query

    Online and offline

    https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&licenseTypes=offline&maxResults=25

    Online only

    https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&maxResults=25

    Offline only

    https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=offline&maxResults=25

    Both license types and a time filter

    https://bspmts.mp.microsoft.com/V1/Inventory?modifiedSince=2015-07-13T14%3a02%3a25.6863382-07%3a00&licenseTypes=online&licenseTypes=offline&maxResults=25

    - - - - - ------ - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData field

    400

    Invalid parameters

    No

    Parameter name

    -

    Invalid modified date, license, or continuationToken

    -

    Details: String

    - - +|Query type|Example query| +|--- |--- | +|Online and offline|[https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&licenseTypes=offline&maxResults=25](https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&licenseTypes=offline&maxResults=25)| +|Online only|[https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&maxResults=25](https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=online&maxResults=25)| +|Offline only|[https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=offline&maxResults=25](https://bspmts.mp.microsoft.com/V1/Inventory?licenseTypes=offline&maxResults=25)| +|Both license types and a time filter|[https://bspmts.mp.microsoft.com/V1/Inventory?modifiedSince=2015-07-13T14%3a02%3a25.6863382-07%3a00&licenseTypes=online&licenseTypes=offline&maxResults=25](https://bspmts.mp.microsoft.com/V1/Inventory?modifiedSince=2015-07-13T14%3a02%3a25.6863382-07%3a00&licenseTypes=online&licenseTypes=offline&maxResults=25)| +|Error code|Description|Retry|Data field| +|--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name

    Invalid modified date, license, or continuationToken

    Details: String| ## Response diff --git a/windows/client-management/mdm/get-localized-product-details.md b/windows/client-management/mdm/get-localized-product-details.md index 52848ed620..3e13a8f8e4 100644 --- a/windows/client-management/mdm/get-localized-product-details.md +++ b/windows/client-management/mdm/get-localized-product-details.md @@ -18,97 +18,27 @@ The **Get localized product details** operation retrieves the localization infor ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Products/{ProductId}/{SkuId}/LocalizedDetails/{language}

    +**GET:** + +```http +https://bspmts.mp.microsoft.com/V1/Products/{ProductId}/{SkuId}/LocalizedDetails/{language} +``` ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    productId

    string

    Required. Product identifier for an application that is used by the Store for Business.

    skuId

    string

    Required. Product identifier that specifies a specific SKU of an application.

    language

    string

    Required. Language in ISO format, such as en-us, en-ca.

    +|Parameter|Type|Description| +|--- |--- |--- | +|productId|string|Required. Product identifier for an application that is used by the Store for Business.| +|skuId|string|Required. Product identifier that specifies a specific SKU of an application.| +|language|string|Required. Language in ISO format, such as en-us, en-ca.| - - ------ - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData field

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Missing parameter or invalid parameter

    -

    Details: String

    404

    Not found

    Item type: productId, skuId, language

    - -  +|Error code|Description|Retry|Data field| +|--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name
    Reason: Missing parameter or invalid parameter
    Details: String| +|404|Not found||Item type: productId, skuId, language| ## Response diff --git a/windows/client-management/mdm/get-offline-license.md b/windows/client-management/mdm/get-offline-license.md index 87699a8b11..0f60251a1c 100644 --- a/windows/client-management/mdm/get-offline-license.md +++ b/windows/client-management/mdm/get-offline-license.md @@ -18,102 +18,27 @@ The **Get offline license** operation retrieves the offline license information ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    POST

    https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/OfflineLicense/{contentId}

    +**POST:** + +```http +https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/OfflineLicense/{contentId} +``` -  ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    productId

    string

    Required. Identifies a specific product that has been acquired.

    skuId

    string

    Required. The SKU identifier.

    contentId

    string

    Required. Identifies a specific application.

    +|Parameter|Type|Description| +|--- |--- |--- | +|productId|string|Required. Identifies a specific product that has been acquired.| +|skuId|string|Required. The SKU identifier.| +|contentId|string|Required. Identifies a specific application.| - - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData field

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Missing parameter or invalid parameter

    -

    Details: String

    404

    Not found

    409

    Conflict

    Reason: Not owned, Not offline

    - +|Error code|Description|Retry|Data field| +|--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name
    Reason: Missing parameter or invalid parameter
    Details: String| +|404|Not found||| +|409|Conflict||Reason: Not owned, Not offline| ## Response diff --git a/windows/client-management/mdm/get-product-details.md b/windows/client-management/mdm/get-product-details.md index 18a0174509..9b32395cbd 100644 --- a/windows/client-management/mdm/get-product-details.md +++ b/windows/client-management/mdm/get-product-details.md @@ -18,92 +18,26 @@ The **Get product details** operation retrieves the product information from the ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}

    +**GET:** +```http +https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId} +``` ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    productId

    string

    Required. Product identifier for an application that is used by the Store for Business.

    skuId

    string

    Required. Product identifier that specifies a specific SKU of an application.

    +|Parameter|Type|Description| +|--- |--- |--- | +|productId|string|Required. Product identifier for an application that is used by the Store for Business.| +|skuId|string|Required. Product identifier that specifies a specific SKU of an application.| +|Error code|Description|Retry|Data field| +|--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name
    Reason: Missing parameter or invalid parameter
    Details: String| +|404|Not found||| - ------ - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData field

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Missing parameter or invalid parameter

    -

    Details: String

    404

    Not found

    - -  ## Response ### Response body diff --git a/windows/client-management/mdm/get-product-package.md b/windows/client-management/mdm/get-product-package.md index 662580acde..d08a8b434a 100644 --- a/windows/client-management/mdm/get-product-package.md +++ b/windows/client-management/mdm/get-product-package.md @@ -18,108 +18,27 @@ The **Get product package** operation retrieves the information about a specific ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/Packages/{packageId}

    +**GET:** -  +```http +https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/Packages/{packageId} +``` ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    productId

    string

    Required. Product identifier for an application that is used by the Store for Business.

    skuId

    string

    Required. Product identifier that specifies a specific SKU of an application.

    packageId

    string

    Required.

    - - - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData fieldDetails

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Invalid parameter

    -

    Details: String

    Can be productId, skuId, or packageId

    404

    Not found

    Item type: Product/SKU

    409

    Conflict

    Reason: Not owned

    +|Parameter|Type|Description| +|--- |--- |--- | +|productId|string|Required. Product identifier for an application that is used by the Store for Business.| +|skuId|string|Required. Product identifier that specifies a specific SKU of an application.| +|packageId|string|Required.| +|Error code|Description|Retry|Data field|Details| +|--- |--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name

    Reason: Invalid parameter

    Details: String|Can be productId, skuId, or packageId| +|404|Not found|||Item type: Product/SKU| +|409|Conflict||Reason: Not owned|| ## Response diff --git a/windows/client-management/mdm/get-product-packages.md b/windows/client-management/mdm/get-product-packages.md index 5ad2851bc5..6dede5eb3e 100644 --- a/windows/client-management/mdm/get-product-packages.md +++ b/windows/client-management/mdm/get-product-packages.md @@ -18,97 +18,27 @@ The **Get product packages** operation retrieves the information about applicati ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/Packages

    +**GET:** + +```http +https://bspmts.mp.microsoft.com/V1/Products/{productId}/{skuId}/Packages +```   ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    productId

    string

    Required. Product identifier for an application that is used by the Store for Business.

    skuId

    string

    Required. Product identifier that specifies a specific SKU of an application.

    - -  - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData field

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Missing parameter or invalid parameter

    -

    Details: String

    404

    Not found

    409

    Conflict

    Reason: Not owned

    +|Parameter|Type|Description| +|--- |--- |--- | +|productId|string|Required. Product identifier for an application that is used by the Store for Business.| +|skuId|string|Required. Product identifier that specifies a specific SKU of an application.| +|Error code|Description|Retry|Data field| +|--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name

    Reason: Missing parameter or invalid parameter

    Details: String| +|404|Not found||| +|409|Conflict||Reason: Not owned| ## Response diff --git a/windows/client-management/mdm/get-seat.md b/windows/client-management/mdm/get-seat.md index 598d24ea19..920c40c4e5 100644 --- a/windows/client-management/mdm/get-seat.md +++ b/windows/client-management/mdm/get-seat.md @@ -18,61 +18,21 @@ The **Get seat** operation retrieves the information about an active seat for a ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Inventory/{productId}/{skuId}/Seats/{username}

    +**GET:** +```http +https://bspmts.mp.microsoft.com/V1/Inventory/{productId}/{skuId}/Seats/{username} +``` ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    productId

    string

    Required. Product identifier for an application that is used by the Store for Business.

    skuId

    string

    Required. Product identifier that specifies a specific SKU of an application.

    username

    string

    Requires UserPrincipalName (UPN). User name of the target user account.

    +|Parameter|Type|Description| +|--- |--- |--- | +|productId|string|Required. Product identifier for an application that is used by the Store for Business.| +|skuId|string|Required. Product identifier that specifies a specific SKU of an application.| +|username|string|Requires UserPrincipalName (UPN). User name of the target user account.|   ## Response @@ -81,56 +41,8 @@ The following parameters may be specified in the request URI. The response body contains [SeatDetails](data-structures-windows-store-for-business.md#seatdetails). - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData fieldDetails

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Missing parameter or invalid parameter

    -

    Details: String

    Invalid can include productId, skuId or username

    404

    Not found

    ItemType: Inventory, User, Seat

    -

    Values: ProductId/SkuId, UserName, ProductId/SkuId/Username

    409

    Conflict

    Reason: Not online

    - -  - -  - - - - - +|Error code|Description|Retry|Data field|Details| +|--- |--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name

    Reason: Missing parameter or invalid parameter

    Details: String|Invalid can include productId, skuId or username| +|404|Not found|||ItemType: Inventory, User, Seat

    Values: ProductId/SkuId, UserName, ProductId/SkuId/Username| +|409|Conflict||Reason: Not online|| diff --git a/windows/client-management/mdm/get-seats-assigned-to-a-user.md b/windows/client-management/mdm/get-seats-assigned-to-a-user.md index 016e2a8711..099ad10917 100644 --- a/windows/client-management/mdm/get-seats-assigned-to-a-user.md +++ b/windows/client-management/mdm/get-seats-assigned-to-a-user.md @@ -18,61 +18,21 @@ The **Get seats assigned to a user** operation retrieves information about assig ## Request - ---- - - - - - - - - - - - - -
    MethodRequest URI

    GET

    https://bspmts.mp.microsoft.com/V1/Users/{username}/Seats?continuationToken={ContinuationToken}&maxResults={MaxResults}

    +**GET:** +```http +https://bspmts.mp.microsoft.com/V1/Users/{username}/Seats?continuationToken={ContinuationToken}&maxResults={MaxResults} +``` ### URI parameters The following parameters may be specified in the request URI. - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
    ParameterTypeDescription

    useName

    string

    Requires UserPrincipalName (UPN). User name of the target user account.

    continuationToken

    string

    Optional.

    maxResults

    inteter-32

    Optional. Default = 25, Maximum = 100

    +|Parameter|Type|Description| +|--- |--- |--- | +|useName|string|Requires UserPrincipalName (UPN). User name of the target user account.| +|continuationToken|string|Optional.| +|maxResults|inteter-32|Optional. Default = 25, Maximum = 100|   ## Response @@ -81,39 +41,10 @@ The following parameters may be specified in the request URI. The response body contain [SeatDetailsResultSet](data-structures-windows-store-for-business.md#seatdetailsresultset). - ------ - - - - - - - - - - - - - - - - - - - - - - -
    Error codeDescriptionRetryData field

    400

    Invalid parameters

    No

    Parameter name

    -

    Reason: Invalid parameter

    -

    Details: String

    404

    Not found

    Item type: User

    -

    Values: UserName

    +|Error code|Description|Retry|Data field| +|--- |--- |--- |--- | +|400|Invalid parameters|No|Parameter name

    Reason: Invalid parameter

    Details: String| +|404|Not found||Item type: User

    Values: UserName|