メインコンテンツへスキップ
XBOX CLI には構成ファイルは必要ありません。設定は実行可能ファイルに組み込まれた既定値から取得され、 シェル単位では環境変数で、1 つのコマンド単位ではオプションでオーバーライドできます。

構成ソースと優先順位

設定は 3 つのソースから取得され、後のソースが前のソースをオーバーライドします。
  1. 実行可能ファイルにコンパイルされた組み込みの既定値。設定を参照してください。
  2. 環境変数。環境変数を参照してください。
  3. コマンド ライン オプション。CLI オプションによるオーバーライドを参照してください。
新しいリリースには独自の既定値が含まれているため、引き継ぐ必要のある設定ファイルはありません。 販売者、PlayFab タイトル、XBOX タイトル、サンドボックスは設定ではありません。コマンドがこれらを取得する場所については、 コンテキストを参照してください。

設定

  • AzureAd:* は、ユーザー サインインを構成します。認証を参照してください。
  • PlayFab:StudioBaseUrl は、playfab service-principal が 呼び出すものなど、スタジオ API (/Studio/*) 用の PlayFab エンドポイントです。
  • XboxPartner:TimeoutSeconds は、game などのコマンドのリクエスト タイムアウト (秒単位) であり、正の数である必要があります。
  • XblPCSandbox:Path は、pc sandbox コマンドが実行する XblPCSandbox.exe です。設定されていない場合、CLI は自身のディレクトリを検索し、次に PATH を検索します。
  • AuditLog:Enabled は、監査ログを有効にします。
  • Telemetry:* については、テレメトリで説明しています。
PlayFab:BaseUrlTemplate、PlayFab:StudioBaseUrl、または XboxPartner:BaseUrl が組み込みの既定値と 異なる場合、そのエンドポイントにトークンを送信するすべてのコマンドは、最初に stderr に警告を 書き込みます。

環境変数

設定の変数名は、XBOX_ にキーを続け、各 : を __ (アンダースコア 2 つ) に置き換えたものです。 たとえば、Telemetry:Enabled は XBOX_TELEMETRY__ENABLED になります。名前は大文字で記述します。変数は、 それを設定したシェルと、そのシェルが開始するすべてのコマンドに適用されます。
設定のすべての設定には変数があります。CLI は次の変数も読み取ります。 XBOX_AUTHENTICATION__ の設定は環境変数からのみ読み取られ、組み込みの既定値やオプションからは読み取られません。 自動化 (サービス プリンシパル) の認証を参照してください。

CLI オプションによるオーバーライド

オプションは、1 つのコマンドについて、他のすべてのソースをオーバーライドします。 その他のグローバル オプションについては、コマンドを参照してください。

テレメトリの構成

公式リリースでは、無効にしない限り、限られた匿名のテレメトリが収集されます。1 つのコマンドで 無効にするには、次のようにします。
シェルで無効にするには、次のようにします。
収集される内容については、テレメトリを参照してください。

appsettings.json を読み取っていたリリースからのアップグレード

以前のリリースでは、実行可能ファイルと同じ場所にある appsettings.json を読み取っていました。このファイルの値を変更していた場合は、 代わりに対応する XBOX_ 変数を設定してください。たとえば、"AzureAd": { "ClientId": "..." } は XBOX_AZUREAD__CLIENTID になります。移行が完了するまで、次のメッセージが表示される場合があります。
  • --config-env は次のエラーで失敗します。このオプションを削除し、代わりに XBOX_ 変数を設定してください。
  • 実行可能ファイルと同じ場所に appsettings*.json ファイルがある間は、コマンドが次のメモを stderr に書き込みます。このファイルを削除してください。
  • 以前のエラー メッセージに従って XBOX_PLAYFAB__REQUESTHEADERS__0__VALUE を設定した場合、PlayFab コマンドは この変数名を示すエラーで失敗します。この変数を削除してください。
最終更新日 2026年11月19日