跳轉到主要內容
XBOX CLI 不需要組態檔。其設定來自內建於可執行檔中的預設值,您可以使用環境變數針對殼層進行覆寫,或使用選項針對單一命令進行覆寫。

組態來源和優先順序

設定來自三個來源,後面的來源會覆寫前面的來源:
  1. 編譯到可執行檔中的內建預設值。請參閱設定。
  2. 環境變數。請參閱環境變數。
  3. 命令列選項。請參閱CLI 選項覆寫。
新版本會帶有自己的預設值,因此沒有需要沿用的設定檔。 賣方、PlayFab 遊戲、XBOX 遊戲和沙箱不是設定;如需命令從何處取得這些值,請參閱內容。

設定

  • AzureAd:* 用於設定使用者登入;請參閱驗證。
  • PlayFab:StudioBaseUrl 是 Studio API (/Studio/*) 的 PlayFab 端點,例如 playfab service-principal 所呼叫的 API。
  • XboxPartner:TimeoutSeconds 是 game 等命令的要求逾時 (以秒為單位),且必須是正數。
  • XblPCSandbox:Path 是 pc sandbox 命令所執行的 XblPCSandbox.exe。未設定時,CLI 會先在其本身的目錄中尋找,然後在 PATH 中尋找。
  • AuditLog:Enabled 會開啟稽核記錄。
  • Telemetry:* 的說明請參閱遙測。
當 PlayFab:BaseUrlTemplate、PlayFab:StudioBaseUrl 或 XboxPartner:BaseUrl 不是內建預設值時,每個將權杖傳送至該端點的命令都會先將警告寫入 stderr。

環境變數

設定的變數是 XBOX_ 加上其索引鍵,並以 __ (兩個底線) 取代每個 :,因此 Telemetry:Enabled 為 XBOX_TELEMETRY__ENABLED。名稱請以大寫撰寫。變數會套用至設定它的殼層,以及該殼層啟動的每個命令:
設定中的每個設定都有變數。CLI 也會讀取下列變數: XBOX_AUTHENTICATION__ 設定只會從環境變數讀取,絕不會從內建預設值或選項讀取。請參閱自動化 (服務主體) 驗證。

CLI 選項覆寫

選項會針對單一命令覆寫其他所有來源。 如需其他全域選項,請參閱命令。

遙測組態

除非您將其關閉,否則正式版本會收集有限的匿名遙測。若要針對單一命令關閉:
若要針對殼層關閉:
如需收集的內容,請參閱遙測。

從讀取 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日