MSIXパッケージの作成とインストール

MSIXとは、MSIの後継となるパッケージ形式です。

制約

アプリケーションのインストールディレクトリには書き込めません。代わりに%LOCALAPPDATA%以下などに保存します。デスクトップアプリケーションのパッケージ化の準備 (MSIX) - MSIX | Microsoft Learn

パッケージ化の手順

UWPでは既定のプロジェクトからMSIXパッケージを作成できますが、デスクトップアプリでは別途パッケージ用のプロジェクトが必要です。

プロジェクトの作成

新しいプロジェクトとして[Windows アプリケーションパッケージプロジェクト]を追加します。そのときこれが存在しないならば、Visual Studioのインストーラから【.NET デスクトップ開発 → オプション】などにある[MSIX Packaging Tools]をインストールします。必要な Visual Studio のバージョンとワークロード - Visual Studio を使用してソースコードからデスクトップアプリをパッケージ化する - MSIX | Microsoft Learn

プロジェクトは.wapprojファイルとして作成されますが、その実体はMSBuild プロジェクトファイルです。

なお既定のプロジェクト名として表示される"WapProjTemplate"は、おそらく"Windows Application Packaging Project template"の意味です。Required Visual Studio version and workload - Package a desktop app from source code using Visual Studio - MSIX | Microsoft Learn

開発者モードの有効化

プロジェクトの作成時に「この種類の Windows 用アプリを開発するには、このデバイスを正しく設定する必要があります。そうでない場合は、Windows Store に提出する前にアプリをインストールしてテストすることはできません。」「デバイスで開発者向けの設定にアクセスし、[開発者モード] を選択します。」と表示されるならば、そのリンクから開発者モードを有効にします。そのとき「開発者モードをオンにすると、Microsoft Store 以外からアプリをインストールして実行する場合などに、デバイスと個人データがセキュリティ上のリスクにさらされる可能性や、デバイスに問題が起こる可能性があります。」と警告され、Storeに提出前のアプリをテストできるようになります。この開発者モードは、[設定]の【システム → 開発者向け】から無効できます。

プラットフォームのバージョン

サポート対象とするプラットフォームの最小バージョンは、アプリケーションが依存するAPIなどから決定します。UWP バージョンの選択 - UWP applications | Microsoft Learn

配布方法を[サイドローディング]として自動更新を有効にするならば、最小バージョンを「Windows 10, version 1803 (10.0; ビルド 17134)」以降とします。visual studio - Automatic updates are not available for the configured target platform min version - Stack Overflow

参照に追加

パッケージプロジェクトの依存関係に、対象とするプロジェクトを追加します。

パッケージプロジェクトのビルド

パッケージプロジェクトをビルドし、エラーのないことを確認します。

マニフェストファイルの編集

パッケージプロジェクトに含まれるアプリマニフェストファイル (Package.appxmanifest) を開きます。そこではアイコンや署名を設定できます。プロジェクトを構成する - MSIX アプリのパッケージ化 - MSIX | Microsoft Learn

このファイルの実体はパッケージマニフェストファイル (package manifest file) であり、XMLとして編集できます。MSIX パッケージコンポーネントの生成 - MSIX | Microsoft Learn

これらの設定はインストーラや設定アプリに作用するものであり、実行ファイルに対しては別に設定が必要です。

[アプリケーション (Application)]タブ

項目	作用
表示名 (Display name)	スタートメニューや、[設定]のインストールされているアプリで表示される名前
エントリポイント (Entry Point)
既定の言語 (Default language)
説明 (Description)
信頼レベル (Trust level)	MediumIL … 完全信頼 (full trust)。プロセスは中程度の整合性レベル (integrity level) で実行される AppContainer … 軽量のアプリコンテナで実行される
サポートされる回転 (Supported rotations)

既定の言語

多言語対応させるならば、それらをリソースファイル (.resw) で定義しms-resource URIスキームで参照します。アプリパッケージマニフェストの文字列リソース識別子を参照する - UI とアプリパッケージマニフェスト内の文字列をローカライズする - UWP applications | Microsoft Learn 文字列を多言語化対応するには？［Win 8］：WinRT／Metro TIPS - ＠IT 山本康彦 (2012/11/01)

それにはパッケージプロジェクトに次のようにフォルダを作成して、言語ごとのリソースファイルを作成します。

Strings/en-US/Resources.resw
Strings/ja-JP/Resources.resw

そしてそれぞれに同名のリソースを追加して、そのニュートラル値にそれぞれの言語の文字列を設定します。または同一のフォルダに

Resources.lang-en-US.resw
Resources.lang-ja-JP.resw

のように言語ごとの名前を付けてファイルを作成し、追加したリソースの言語ごとに文字列を設定します。

リソースの定義を誤ると「エラー 0x80073B17: *** 文字列リソースをローカライズできるかどうかを確認しているときに次のエラーが発生したため、*** パッケージを登録できません: NamedResource が見つかりません。文字列リソースが定義されていることと、このパッケージに含まれる resources.pri ファイルで少なくとも 1 つのインスタンスが定義されていることを確認してください。」として失敗します。

たとえば名前を"AppName"としたリソースを表示名に適用するには、その定義を"ms-resource:AppName"とします。

このように定義した言語は、設定の優先する言語を変更することで、適用されることを確認できます。

作成したリソースファイルが適用されないときには、そのプロパティを開き[項目の種類]が"リソース"であることを確認します。

ふりがな

Resources.altform-msft-phonetic.reswのように名付けたリソースファイルを作成し、そこで定義します。並べ替えることができる日本語文字列のふりがなのサポート - アプリをローカライズ可能にする - Windows apps | Microsoft Learn

Strings/ja-JP/Resources.resw
Strings/ja-JP/Resources.altform-msft-phonetic.resw

"希蒼"の名前にふりがなを設定しないと"ま"の位置に並ぶとドキュメントでは解説されていますが、Windows 11 24H2では設定しなくても"の"の位置に並び、ふりがなの指定は無視されます。

[ビジュアル資産 (Visual Assets)]タブ

アプリのアイコンなどを指定します。

アイコンには16x16、24x24、32x32、48x48、256x256のサイズが必要 Windows アプリのアイコンを作成する - Windows apps | Microsoft Learn
アイコンの設計 (Design) は、アプリの概念が伝わるものとする Windows アプリアイコンの設計ガイドライン - Windows apps | Microsoft Learn
アイコンの背景を透明にしていると、インストーラーで表示されるアイコンの背景がWindowsのアクセントカラーになることがある [BUG] The installation wizard displays a blue background color beneath the app icon. · Issue #258 · YehudaKremer/msix · GitHub

実行時のアプリに表示されるアイコンは、FormならばそのIconプロパティで指定します。

[機能 (Capabilities)]タブ

ここでチェックした項目が、[機能]としてインストーラで表示されます。

<Capabilities>
  <Capability Name="internetClient" />
  <rescap:Capability Name="runFullTrust" />
</Capabilities>

アプリ機能の宣言 - UWP applications | Microsoft Learn

制限付き機能 (Restricted capabilities)

Microsoft Storeでの承認を得るのに、追加の情報を必要とする機能です。制限付き機能 - アプリ機能の宣言 - UWP applications | Microsoft Learn

完全信頼のアクセス許可レベル (Full Trust Permission Level)

Win32などDesktop Bridgeを用いるアプリケーションが必要とする、"runFullTrust"と呼ばれる機能です。そして完全信頼 (full trust) なアプリケーションではuap10:TrustLevelがmediumILに設定され、中程度の整合性レベルで実行されるプロセスがあります。 A simpler and faster way to publish your Desktop Bridge applications on the Microsoft Store | Microsoft Learn 制限付き機能の一覧 - アプリ機能の宣言 - UWP applications | Microsoft Learn

この機能を必要とする場合は、Storeでの申請時に「The following restricted capabilities require approval before you can use them in your app: runFullTrust.」と警告されます。

[宣言 (Declarations)]タブ

次のような宣言をできます。

App Service
Web アカウントプロバイダー
アカウントの画像プロバイダー
アプリ拡張機能ホスト
アラーム
カメラ設定
キャッシュファイル更新プログラム
ダイヤルプロトコル
パーソナルアシスタントの起動
バックグラウンドタスク
ファイルオープンピッカー
ファイルの種類の関連付け
ファイル保存ピッカー
プリント 3D ワークフロー
プロトコル
メディア再生
ロック画面
印刷タスク設定
共有ターゲット
検索
更新されたタスク
事前インストールされた構成
自動再生コンテンツ
自動再生デバイス
証明書
制限された起動
予定プロバイダー

[パッケージ化 (Packaging)]タブ

項目	作用
パッケージ名 (Package name)	C:\Program Files\WindowsAppsにインストールされるときの、フォルダ名の先頭の文字列
パッケージ表示名 (Package display name)	インストーラで表示される「`パッケージ表示名` をインストールしますか?」の`パッケージ表示名`
バージョン (Version)	インストーラおよび[設定]のインストールされているアプリで表示される、バージョン番号
公開者 (Publisher)	インストーラで表示される、発行元
公開者表示名 (Publisher display name)	[設定]のインストールされているアプリで表示される、発行元
パッケージファミリ名 (Package family name)	%LOCALAPPDATA%\Packagesに作成されるアプリのフォルダ名

パッケージ ID (Package identity) は名前、バージョン、アーキテクチャ、ResourceId、公開元の5つの要素から構成される識別子です。パッケージ ID とは - Windows アプリのパッケージ ID の概要 - Windows apps | Microsoft Learn

パッケージ名

パッケージ名には、英数字と「-」「.」しか使用できません。これに反すると「error APPX0501: 検証エラー。error C00CE169: App manifest validation error: The app manifest must be valid as per schema: Line **, Column **, Reason: '***' が、'[-.A-Za-z0-9]+' の 'pattern' 制約に違反しています。値 '***' を持つ属性 'Name' を解析できませんでした。」としてエラーとなります。

Microsoft Storeでは、"発行元表示名.アプリ名"がパッケージ名となります。

公開者

公開者は空白にできません。これに反すると「error APPX0501: 検証エラー。error C00CE169: App manifest validation error: The app manifest must be valid as per schema: Line **, Column **, Reason: '' が、'1' の 'minLength' 制約に違反しています。値 '' を持つ属性 'Publisher' を解析できませんでした。」としてエラーとなります。

[証明書の選択]から、証明書を適用できます。そのときアプリケーションがMicrosoft Storeに関連づけられているならば[ストアから選択]を、さもなくば[作成]から[発行者共通名]にパッケージ IDの発行元 (publisher ID) を設定して作成します。

パッケージファミリ名

パッケージファミリ名は、実行時にはPackageId.FamilyNameから取得できます。 PackageId.FamilyName プロパティ (Windows.ApplicationModel) - Windows apps | Microsoft Learn c# - Is there a way to find the PackageFamilyName at runtime? - Stack Overflow

パッケージファミリ名 - Windows アプリのパッケージ ID の概要 - Windows apps | Microsoft Learn

アプリパッケージの作成

ソリューションエクスプローラーでパッケージプロジェクトのコンテキストメニューを開き、【公開 → アプリパッケージの作成】を実行します。

配布方法

Store以外で配布

Microsoft Storeを経由せずインストールできるようにするには、配布方法を[サイドローディング (Sideloading)]とします。基幹業務アプリのサイドロード | Microsoft Learn サイドローディング | 日経クロステック（xTECH）井原敏宏 (2014/04/18)

そのときパッケージプロジェクトがサポート対象とするプラットフォームの最小バージョンがビルド17134より前だと「構成されたターゲットプラットフォームの最小バージョンでは、自動更新を利用できません。(Automatic updates are not available for the configured Target Platform Minimum Version.)」として、自動更新を有効にできません。

Storeで配布

Microsoft Storeで配布するには[新しいアプリ名で Microsoft Store に]を選択します。ストアと関連付けられると、パッケージプロジェクトのフォルダにPackage.StoreAssociation.xmlが作成されます。

アプリ一覧を取得できない

[アプリケーション名を選択]で「予期しないネットワークエラーが発生しました。アプリ一覧を取得できません。[最新の情報に更新] ボタンを押してもう一度お試しください。(An unexpected network error has occurred. The app list cannot be retrieved. Retry by pressing the Refresh button.)」として、アプリ名の取得に失敗することがあります。この問題が発生したときは、次のように対処します。

アプリ一覧を、VPNなどを用いて異なる地域からアクセスして取得する The microsoft store is experiencing network issues - Developer Community
アプリ一覧の取得を断念し、手作業でアプリケーションをストアと関連付ける cannot associate app with store - Developer Community
アプリ一覧を取得できるようになるまで待つ

署名方法

パッケージの構成

バージョン

新しいバージョンは、つねに大きな数字のバージョンとなるようにします。これに反するとインストール時に「このパッケージの新しいバージョンが既にインストールされています。こちらの古いパッケージを代わりにインストールするには、現在システムにあるパッケージをアンインストールしてください (0x80073D06)」としてインストールに失敗します。

[自動的に増加]をチェックするか、大きな数字のバージョン番号を付けないと、アプリを更新しても適用されません。そのときは[再インストール]を実行しても同じバージョンがインストールされるため、アンインストールしてからインストールし直します。

ただしVisual Studioでパッケージプロジェクトを配置 (デプロイ) するときは、バージョン番号を増加させる必要はありません。

アプリバンドル (app bundle)

アプリバンドル (.msixbundleまたは.appxbundleファイル) を利用すると、必要なリソースのみをダウンロードさせるようにできます。アップバンドル - MSIX アプリのアプリパッケージ要件 - Windows apps | Microsoft Learn

この.msixbundleや.appxbundleも、.msixや.appx同様に複数のファイルがZIPで書庫化 (archive) された形式のため、抽出する (extraction) ことで内容を確認できます。

アーキテクチャ

アーキテクチャの[Neutral]はすべてのアーキテクチャで動作する場合に指定するもので、それ以外とは排他です。アプリパッケージのアーキテクチャ - MSIX | Microsoft Learn パッケージ ID のプロセッサアーキテクチャについて - Windows アプリのパッケージ ID の概要 - Windows apps | Microsoft Learn

更新設定

[インストーラーの場所]には、オンラインで公開するならばそのURL、ローカルならばパッケージの出力場所などのパスを指定します。

作成の完了

アプリパッケージを作成すると、パッケージの出力場所に*_TestフォルダとAPPINSTALLER ファイル (.appinstaller) が作成されます。同時に作成されるHTMLファイルの[アプリを取得する]は、このファイルへのリンクとなっています。アプリインストーラーファイルの概要 - MSIX | Microsoft Learn

プロジェクトのビルド時に「RI249: 0xdef00520 - Invalid qualifier: ***」のように出力されるならば、その文字列が含まれるファイルの名前を確認します。これは*.*-*.*のように、ピリオドに挟まれる位置にハイフンがあると無効と見なされるようです。

参考

Visual Studio でアプリを MSIX としてパッケージ化する - MSIX | Microsoft Learn

MSIXからのインストール

ms-appinstallerプロトコルからのインストール

アプリパッケージとして作成されたAppPackages/index.htmlを開き、そこにある[アプリを取得する]のリンクからインストールする方法です。

プロトコルが無効

このリンク先となっているms-appinstallerプロトコルからは、アプリインストーラーが1.21.3421.0以降だと「ms-appinstaller プロトコルが無効になっています。Web リンクを更新するようにベンダーに依頼してください。詳細については、aka.ms/ms-appinstaller-disabled を参照してください。」としてインストールできません。 Microsoft、「ms-appinstaller」プロトコルハンドラーを既定で無効化～マルウェアの標的に - 窓の杜樽井秀人 (2024/01/12) Why has the ms-appinstaller protocol been disabled? - Microsoft Q&A

APPINSTALLERファイルからのインストール

*.appinstallerファイルを実行してインストールする方法です。

発行元が不明

インストール画面で「このアプリパッケージの発行元証明書を検証できませんでした。確認済みの証明書を含む新しいアプリパッケージを取得するには、システム管理者またはアプリ開発者に問い合わせてください。アプリパッケージ内の署名のルート証明書とすべての即時証明書を確認する必要があります (0x800B010A)」として[インストール]ボタンがグレーアウトして実行できないならば、先に証明書をインストールします。アプリパッケージ署名エラーのトラブルシューティング方法 - Win32 apps | Microsoft Learn

証明書を用意していないならば、[アプリパッケージの作成]のウィザード、またはPackage.appxmanifestの[パッケージ化]タブの[証明書の選択]で作成できます。

証明書のインストール

証明書をインストールするには、アプリパッケージに含まれるセキュリティ証明書 (.cerファイル) のコンテキストメニューを開き、[証明書のインストール]を実行します。そして保存場所を[ローカルコンピューター]として、[証明書をすべて次のストアに配置する]を選択し[信頼されたユーザー (Trusted People)]を指定します。

この証明書のインストールは、certlm.msc (コンピューター証明書の管理) からも実行できます。そこでは【証明書 → 信頼されたユーザー → 証明書】のコンテキストメニューを開き、【すべてのタスク → インポート】を選択します。そしてセキュリティ証明書 (.cerファイル) を指定し、証明書ストアが[信頼されたユーザー]であることを確認してインポートします。そのとき「ストアが読み取り専用か、ストアがいっぱいか、ストアが正しく開かなかったため、インポートができませんでした。」として失敗するならば、certlm.mscを管理者権限で実行します。信頼できる証明書 - アプリインストーラーファイルを使ったインストールに関する問題のトラブルシューティング - MSIX | Microsoft Learn

証明書を正しくインストールできたならば、[インストール]ボタンからインストールできます。またインストールされた証明書は、certlm.mscを実行し【証明書 → 信頼されたユーザー → 証明書】で確認や削除をできます。

別のパッケージによって使用されている

「アプリをインストールできませんでした。エラーメッセージ: appinstaller URI ***.appinstallerは既に別のパッケージによって使用されているため、関連付けが削除されるまでパッケージ *** に適用できません。 (0x80004005)(App installation failed with error message: The appinstaller uri ***.appinstaller is already being used by another package and cannot be applied to package *** until the association is removed. (0x80004005))」

Get-AppxPackageでインストールされているアプリの一覧を取得し、そこにインストールできないアプリが含まれているならばRemove-AppxPackageで先にアンインストールします。FilesのInsider Previewをアップデートできない問題 - ろぼいんブログ Erro ao Instalar Arc - Microsoft Community

解決できないならば、パッケージプロジェクトを作成し直します。

ファイルの配置場所

既定ではC:\Program Files\WindowsApps\package_full_nameにインストールされ、そこに置かれたファイルは読み取り専用になります。このC:\Program Files\WindowsAppsはPackageVolumeと呼ばれ、設定から変更されることがあります。インストール - Windows でパッケージ化されたデスクトップアプリが動作するしくみについて - MSIX | Microsoft Learn

依存ファイルがパッケージ外にある場合には、それがパッケージ内のVFS (Virtual File System/仮想ファイルシステム) フォルダ内に配置されます。そして例えばC:\Windows\System32\vc10.dllへのアクセスがC:\Program Files\WindowsApps\package_full_name\VFS\SystemX86\vc10.dllにリダイレクトされます。

レジストリ

レジストリ内の必要な情報は、PackageVolume以下のregistry.datに格納され参照されます。

Visual Studioでの配置

ローカルで動作確認するだけならば、Visual Studioのソリューションエクスプローラーでパッケージプロジェクトのコンテキストメニューを開き、[配置]を実行するだけでプロジェクトのフォルダに実行ファイルなどが作成され、システムにインストールされます。

そのとき先にMSIXでインストールしていると「アプリケーション "***" は既にこのコンピューターにインストールされています。現在の配置を続行する場合、既存のアプリケーションはアンインストールされ、アプリケーションの現在の状態は削除されます。」と警告され、逆に後からMSIXでインストールするときは「アプリをインストールできませんでした。エラーメッセージ: 現在のユーザーが、このアプリのパッケージ化されていないバージョンを既にインストールしています。これをパッケージ化されたバージョンに置き換えることはできません。競合するパッケージは ***、その発行元は CN=*** です。 (0x80073cfb)」と警告され失敗します。

インストールディレクトリ

インストール先はパッケージプロジェクトの出力パスで指定されている場所であり、bin\x64\Release\AppX\ProjectNameのようなパスです。また%APPDATA%などへのアクセスは、パッケージごとのディレクトリへリダイレクトされません。

トラブル対処法

起動しない

インストールに成功しているはずなのに起動しないときは、アプリケーション側の問題である可能性が高いです。そのとき何もエラーが表示されないならば、イベントビューアーでエラーが記録されていないか確認します。

必要なファイルがない

必要なファイルが正しく配置されていないときは、インストールに用いた.msixファイルなどをアーカイバで開く、もしくは拡張子を.zipに変更した上で展開して、その内容を確認します。

参考

Microsoft Learnから検索