DISM を使ったアプリのプレインストール

[アーティクル]
05/09/2023

Note

Microsoft Storeアプリのプレインストールに関心がありますが、OEMではありませんか。組織でアプリをサイドロードする方法の詳細については、「DISM を使用してアプリをサイドロードする」を参照してください。

このトピックでは、アプリをプレインストールして Windows イメージの一部として含まれるようにする方法について説明します。

ヒント

ハードウェアサポートアプリ (HSA) は Microsoft Store アプリであり、以下の手順が適用されます。

アプリパッケージの操作

DISM を使用して、アプリをイメージにオフラインプロビジョニングします。 DISM は、コマンドプロンプトまたは Windows PowerShell の DISM コマンドレットから使用できます。

以前のバージョンの Windows 10 では、プレインストールされたユニバーサルアプリおよび Microsoft Store アプリをスタートメニューにピン留めする必要がありました。プレインストールされたがスタートメニューにピン留めされていないアプリは、Windows によって削除されました。

Windows 10 バージョン 1803 以降では、DISM /add-provisionedappxpackage オプションを指定して /region を使用すると、アプリをスタートメニューにピン留めせずにプレインストールできます。アプリをプレインストールする際に、LayoutModification.xml からそのアプリを除外するよう選択すると、アプリがスタートメニューのタイルとして表示されずに正常にインストールされます。領域のリストを指定しなかった場合、アプリは、スタートレイアウトにピン留めされている場合にのみプロビジョニングされます。

パッケージファイルを展開する

パートナーダッシュボードからダウンロードしたアプリパッケージが保存されているフォルダーに移動します。
アプリパッケージファイルが含まれる各 .zip フォルダーを右クリックします。 [すべて展開] をクリックし、パッケージファイルフォルダーを保存する場所を選択します。

このフォルダーには、パッケージの展開されたすべてのファイル (メインパッケージ、依存関係パッケージ、ライセンスファイルなど) が含まれます。

重要

パッケージファイルを展開した後は、このフォルダーを変更しないでください。このフォルダー内のファイルを変更、追加、削除すると、インストール中または起動中にアプリが失敗します。フォルダーの参照時にも問題が発生する可能性があります。

プロビジョニングされたイメージをテストするには、パッケージファイルのライセンスファイルを使用する必要があります。独自のカスタムデータファイルを作成しても、OEM によってプレインストールされたアプリを正確にテストできません。

アプリをイメージにオフラインプロビジョニングするには、Dism.exe ツールまたは Windows PowerShell の DISM コマンドレットを使用して、展開されたファイルのフォルダーからアプリを追加します。

DISM を使用して Microsoft Store 署名済みアプリをプレインストールする

管理者としてコマンドプロンプトを開きます。

サービスする Windows イメージをマウントします。

Dism /Mount-Image /ImageFile:c:\images\myimage.wim /Index:1 /mountdir:c:\test\offline

マウントされたイメージにアプリを追加します。 /PackagePath オプションと /DependencyPackagePath オプションを使用します。
- Packagepath は、.appx バンドルまたはパッケージファイルのパスです。
- DependencyPackagePath は、各依存関係パッケージを指定するためのパスです。 1 つのコマンドに複数の依存関係を設定できます。
- Windows 10 バージョン 1803 からの新機能: アプリを追加するときに Region オプションを使用します。 Region を使用すると、アプリをスタートメニューにピン留めしなくてもアプリを追加できます。
```
Dism /Image:c:\test\offline /Add-ProvisionedAppxPackage /PackagePath:c:\downloads\package.appxbundle /DependencyPackagePath:c:\downloads\dependency1.appx /DependencyPackagePath:c:\downloads\dependency2.appx /LicensePath=c:\downloads\package_License1.xml /region=all"
```
新しい /region オプションも含めたアプリパッケージの操作の詳細については、DISM アプリパッケージサービスコマンドラインオプションに関するページを参照してください。
スタートメニューにアプリをピン留めします。
- アプリのプレインストール時に /region を指定しなかった場合は、LayoutModification.xml を使用してアプリをスタートメニューにピン留めします。
  
  or
- アプリのプレインストール時に /region を指定しており、特定の領域のスタートメニューにアプリをピン留めする場合は、LayoutModification.xml の RequiredStartGroups Region="region1|region2" 要素を使用して、アプリを表示する領域を指定します。
変更を保存し、イメージのマウントを解除します。コマンドプロンプトに、次のコマンドを入力します。
```
Dism /Unmount-Image /mountdir:c:\test\offline /commit
```

Note

Microsoft Store アプリは、監査モードでは実行されません。展開をテストするには、Windows を実行し、新しいユーザープロファイルを作成します。監査モードの詳細については、「監査モードの概要」を参照してください。

重要: モバイルブロードバンドデバイスアプリをプレインストールする場合は、Sysprep の specialize フェーズを実行する前に SIM カードを挿入する必要があります。モバイルブロードバンドデバイスアプリのプレインストールの詳細については、モバイルブロードバンドアプリケーションエクスペリエンスに必要なコンポーネントのプレインストールに関する説明を参照してください。

パッケージの更新または削除

DISM.exe ツールまたは Windows PowerShell の DISM コマンドレットを使用して、プレインストールされるアプリ (ライセンスおよびカスタムデータファイルを含む) を Windows イメージから削除できます。新しいバージョンをインストールする前に、古いバージョンのアプリを削除する必要があります。

DISM を使用してプレインストールされるアプリを削除する

Windows ADK と共にインストールされた [Deployment ツールのコマンドプロンプト] を管理者特権で開きます。スタート画面で、「展開およびイメージングツール環境」と入力し、アイコンを右クリックして、[管理者として実行] を選択します。
サービス用のオフラインイメージをマウントします。コマンドプロンプトに、次のコマンドを入力します。
```
Dism /Mount-Image /ImageFile:c:\images\myimage.wim /Index:1 /mountdir:c:\test\offline
```
削除するアプリの完全なパッケージ名を検索します。コマンドプロンプトに、次のコマンドを入力します。
```
Dism /Image:C:\test\offline /Get-ProvisionedAppxPackages
```
マウントされたイメージからアプリを削除します。たとえば、コマンドプロンプトで次のように入力します。
```
Dism /Image:c:\test\offline /Remove-ProvisionedAppxPackage /PackageName:microsoft.devx.appx.app1_1.0.0.0_neutral_en-us_ac4zc6fex2zjp
```
アプリを更新する場合は、更新されたバージョンの Microsoft Store 署名済みアプリをプレインストールできます。コマンドプロンプトに次のように入力します。
```
Dism /Image:c:\test\offline /Add-ProvisionedAppxPackage/FolderPath:c:\downloads\appxpackage
```
変更を保存し、イメージのマウントを解除します。コマンドプロンプトに、次のコマンドを入力します。
```
Dism /Unmount-Image /mountdir:c:\test\offline /commit
```

カスタムデータファイルの使用

PC にプレインストールされたアプリは、インストールに固有のカスタムデータにアクセスできます。このカスタムデータは、プレインストール時にアプリに追加され、実行時に使用可能になります。開発者はカスタムデータを使用して、レポート機能を提供するなど、アプリの機能をカスタマイズできます。

Windows イメージにカスタムデータファイルを追加する

DISM ツールまたは Windows PowerShell の Add-AppxProvisionedPackage コマンドレットを使用してアプリをプレインストールする際には、カスタムデータファイルを指定する必要があります。次のコマンドは、DISM ツールを使用してこれを行う方法を示しています。

Dism /Image:C:\test\offline /Add-ProvisionedAppxPackage / FolderPath:f:\Apps\Fabrikam_KnowMyPC /CustomDataPath:f:\Contoso_Promotion.xml

アプリのデータストアにカスタムデータファイルが既に存在する場合 (パッケージが既にイメージに追加されている場合など) 、既存のファイルは上書きされます。インストールが失敗した場合、ファイルは復元されません。

注: Microsoft Store を通じて、カスタムデータファイルを失うことなくアプリの更新プログラムをリリースできます。ただし、ユーザーがアプリを削除した場合、ユーザーがアプリを再インストールしてもカスタムデータファイルは使用できなくなります。

プレインストールされたアプリのカスタムデータをテストする

PC にプレインストールされたアプリは、インストールに固有のカスタムデータにアクセスできます。このカスタムデータはプレインストール時にアプリに追加され、実行時にアプリで使用可能になります。開発者はカスタムデータを使用して、レポート機能を提供するなど、アプリの機能をカスタマイズできます。

Custom.data ファイルはアプリのインストール場所に表示されます。 Custom.data という名前はハードコーディングされており、変更できません。アプリはこのファイルの存在をチェックすることで、アプリが PC にプレインストールされたかどうかを確認できます。 Custom.data ファイルにアクセスする方法の例を次に示します。

var outputDiv = document.getElementById("CustomData");
Windows.ApplicationModel.Package.current.installedLocation.getFileAsync
     ("microsoft.system.package.metadata\\Custom.data").then(function (file) {
         // Read the file
         Windows.Storage.FileIO.readTextAsync(file).done(function (fileContent) {
            outputDiv.innerHTML = 
                 "App is preinstalled. CustomData contains:<br /><br />"
                 + fileContent;
         },
         function (error) {
             outputDiv.innerText = "Error reading CustomData " + error;
         });
     },
     function (error) {
         outputDiv.innerText = "CustomData was not available. App not preinstalled";
     });

Custom.data ファイルは任意のコンテンツを含めることができ、アプリに必要な任意の形式にすることができます。これはプレインストールプロセスによってアプリで簡単に使用できるようになります。開発者は、このデータファイルをプレインストールパートナーに提供するか、またはパートナーがこのコンテンツを生成できるような形式に同意することができます。

カスタムデータをテストする

Microsoft Visual Studio でのアプリのビルド中およびデバッグ中は、アプリがまだプレインストールされていないため、アプリのインストール場所から Custom.data ファイルにアクセスすることはできません。 Custom.data ファイルを使用してシミュレートするには、アプリ自体にテスト Custom.data ファイルを配置してから、アプリのローカルファイルを読み込んでテストします。これを行うには、次のコードサンプルに変更を加えます。

("microsoft.system.package.metadata\\Custom.data").then(function (file) {

この行を次のように変更します。

("Custom.data").then(function (file) {

ファイルの形式とコンテンツを確認した後で、上の元の例で示したように、Custom.data ファイルの場所を最終的な場所に変更できます。

Custom.data ファイルをテストするには

Windows ADK と共にインストールされた [Deployment ツールのコマンドプロンプト] を管理者特権で開きます。スタート画面で、「展開およびイメージングツール環境」と入力し、アイコンを右クリックして、[管理者として実行] を選択します。
カスタムデータファイルを指定してアプリケーションを追加します。
```
dism /online /Add-ProvisionedAppxPackage /PackagePath:.\CustomData_1.0.0.1_AnyCPU_Debug.appx /CustomDataPath:.\Test.txt /SkipLicense
```
ここで、/PackagePath:.\CustomData_1.0.0.1_AnyCPU_Debug.appx はローカルアプリテストパッケージを指し、/CustomDataPath:.\Test.txt は Custom.data ファイルを指します。ここで指定したファイル名は、アプリにデータをインストールした後は使用されないことに注意してください。

これで、PC のスタート画面に、アプリのテストに使用するためのタイルが表示されます。アプリは Custom.data ファイルにアクセスできる必要があります。追加のデバッグが必要な場合は、スタート画面からアプリを起動した後にデバッガーをアタッチします。

注: アプリをスタート画面に表示するために、サインアウトしてもう一度サインインすることが必要になる場合があります。
アプリのテストが完了したら、開発環境を引き続き使用するために、プレインストールされたパッケージを削除する必要があります。プレインストールされたパッケージを Windows PowerShell を使用して削除するには、Get-AppxPackage コマンドレットを使用して、Remove-ProvisionedAppxPackage コマンドレットにパイプライン経由で完全なアプリパッケージ名を渡します。

Get-AppxPackage *CustomData* | Remove-ProvisionedAppxPackage

ここで、*CustomData* はアプリの名前の既知の部分です。

Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリのプレインストール

展開イメージのサービスと管理 (DISM) プラットフォームを使用して、Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリに必要なコンポーネントをプレインストールできます。

注: この記事は、自社のデバイスで Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリをサポートしようとしている OEM を対象としています。

正しい Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリを提供するために、アプリの種類ごとに次の 2 つをプレインストールする必要があります。

Microsoft Storeデバイスアプリ、プレインストール:
1. デバイスメタデータパッケージ
2. アプリ
Microsoft Storeモバイルブロードバンドアプリ、プレインストール:
1. サービスメタデータパッケージ
2. アプリ

重要: メタデータパッケージおよび対応するアプリは OOBE プロセスの完了後すぐに解析されますが、メタデータパッケージが解析される前にユーザーがアプリを起動できる場合があります。その場合、ユーザーにはアクセス拒否エラーが表示されます。これを回避するには、メタデータパッケージとアプリの両方をシステムイメージに適用します。

デバイスメタデータパッケージまたはサービスメタデータパッケージのプレインストール

デバイスメタデータパッケージまたはサービスメタデータパッケージをプレインストールするには

Microsoft Store デバイスアプリをプレインストールする場合は、デバイスメタデータパッケージを取得している必要があります。モバイルブロードバンドアプリをプレインストールする場合は、サービスメタデータパッケージを取得している必要があります。

注: デバイスメタデータパッケージとサービスメタデータパッケージには、同じファイル名拡張子 (.devicemetadata-ms) が使用されます。
デバイスメタデータパッケージまたはサービスメタデータパッケージ (devicemetadata-ms ファイル) を、%ProgramData%\Microsoft\Windows\DeviceMetadataStore フォルダー内のシステムイメージにコピーします。これは、次の方法のいずれかで実行できます。
- Sysprep の実行前にオンラインで
- Sysprep の実行後に DISM を使用してオフラインで手順は次のとおりです。
  1. サービス用のオフラインイメージをマウントします。
```
Dism /Mount-Image /ImageFile:C:\test\images\myimage.wim /index:1 /MountDir:C:\test\offline
```
  2. マウントされたイメージのデバイスメタデータストアにメタデータパッケージファイルをコピーします。たとえば、デバイスメタデータストア ProgramData\Microsoft\Windows\DeviceMetadataStore に 0ECF2029-2C6A-41AE-9E0A-63FFC9EAD877.devicemetadata-ms メタデータパッケージファイルをコピーするには、次のようにします。
```
copy 0ECF2029-2C6A-41AE-9E0A-63FFC9EAD877.devicemetadata-ms C:\test\offline\ProgramData\Microsoft\Windows\DeviceMetadataStore
```
  3. 変更を保存し、イメージのマウントを解除します。
```
dism /Unmount-Image /mountdir: c:\test\offline /commit
```
  オフラインのイメージサービスの詳細については、DISM の概要に関するページを参照してください。

サービスメタデータの詳細については、「サービスメタデータの概要」を参照してください。

Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリのプレインストール

Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリをプレインストールするには

サービス用のオフラインイメージをマウントします。

Dism /Mount-Image /ImageFile:C:\test\images\myimage.wim /index:1 /MountDir:C:\test\offline

イメージに Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリを追加します。
```
dism /Image:<mounted folder> /Add-ProvisionedAppxPackage /FolderPath:<appxpackage path>
```
変更を保存し、イメージのマウントを解除します。
```
dism /Unmount-Image /mountdir: c:\test\offline /commit
```

DISM を使ったアプリのプレインストール

アプリ パッケージの操作

パッケージ ファイルを展開する

DISM を使用して Microsoft Store 署名済みアプリをプレインストールする

パッケージの更新または削除

DISM を使用してプレインストールされるアプリを削除する

カスタム データ ファイルの使用

Windows イメージにカスタム データ ファイルを追加する

プレインストールされたアプリのカスタム データをテストする

カスタム データをテストする

Microsoft Store デバイス アプリまたはモバイル ブロードバンド アプリのプレインストール

デバイス メタデータ パッケージまたはサービス メタデータ パッケージのプレインストール

Microsoft Store デバイス アプリまたはモバイル ブロードバンド アプリのプレインストール

その他のリソース

アプリパッケージの操作

パッケージファイルを展開する

カスタムデータファイルの使用

Windows イメージにカスタムデータファイルを追加する

プレインストールされたアプリのカスタムデータをテストする

カスタムデータをテストする

Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリのプレインストール

デバイスメタデータパッケージまたはサービスメタデータパッケージのプレインストール

Microsoft Store デバイスアプリまたはモバイルブロードバンドアプリのプレインストール