> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 構成

> CLI が組み込みの既定値、環境変数、コマンド ライン オプションから設定を重ね合わせる方法について説明します。

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

## 構成ソースと優先順位

設定は 3 つのソースから取得され、後のソースが前のソースをオーバーライドします。

1. 実行可能ファイルにコンパイルされた組み込みの既定値。[設定](#settings)を参照してください。
2. 環境変数。[環境変数](#environment-variables)を参照してください。
3. コマンド ライン オプション。[CLI オプションによるオーバーライド](#cli-option-overrides)を参照してください。

新しいリリースには独自の既定値が含まれているため、引き継ぐ必要のある設定ファイルはありません。

販売者、PlayFab タイトル、XBOX タイトル、サンドボックスは設定ではありません。コマンドがこれらを取得する場所については、
[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください。

## 設定

| キー | 環境変数 | オプション | 組み込みの既定値 |
| - | - | - | - |
| `AzureAd:ClientId` | `XBOX_AZUREAD__CLIENTID` | `--client-id` | CLI 独自の Microsoft Entra ID アプリケーション |
| `AzureAd:TenantId` | `XBOX_AZUREAD__TENANTID` | `--tenant-id` | `common` |
| `AzureAd:Scopes` | `XBOX_AZUREAD__SCOPES` | `--scopes` | 組み込み |
| `PlayFab:BaseUrlTemplate` | `XBOX_PLAYFAB__BASEURLTEMPLATE` | なし | 組み込み |
| `PlayFab:StudioBaseUrl` | `XBOX_PLAYFAB__STUDIOBASEURL` | なし | 組み込み |
| `PlayFab:MaxRequestBodyBytes` | `XBOX_PLAYFAB__MAXREQUESTBODYBYTES` | なし | `1048576` (1 MiB) |
| `PlayFab:MaxResponseBytes` | `XBOX_PLAYFAB__MAXRESPONSEBYTES` | なし | `4194304` (4 MiB) |
| `XboxPartner:BaseUrl` | `XBOX_XBOXPARTNER__BASEURL` | `--base-url` (このオプションを受け付けるコマンドの場合) | 組み込み |
| `XboxPartner:TimeoutSeconds` | `XBOX_XBOXPARTNER__TIMEOUTSECONDS` | なし | `120` |
| `XblPCSandbox:Path` | `XBOX_XBLPCSANDBOX__PATH` | なし | 未設定 |
| `AuditLog:Enabled` | `XBOX_AUDITLOG__ENABLED` | なし | `false` |
| `Telemetry:Enabled` | `XBOX_TELEMETRY__ENABLED` | `--disable-telemetry` で `false` に設定 | `true` |

* `AzureAd:*` は、ユーザー サインインを構成します。[認証](https://docs.xbox.com/ja-jp/tools/xbox-cli/authentication.md#overriding-entra-id-settings)を参照してください。
* `PlayFab:StudioBaseUrl` は、[`playfab service-principal`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab/service-principal) が
  呼び出すものなど、スタジオ API (`/Studio/*`) 用の PlayFab エンドポイントです。
* `XboxPartner:TimeoutSeconds` は、[`game`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/game) などのコマンドのリクエスト タイムアウト
  (秒単位) であり、正の数である必要があります。
* `XblPCSandbox:Path` は、[`pc sandbox`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/pc)
  コマンドが実行する `XblPCSandbox.exe` です。設定されていない場合、CLI は自身のディレクトリを検索し、次に `PATH` を検索します。
* `AuditLog:Enabled` は、[監査ログ](https://docs.xbox.com/ja-jp/tools/xbox-cli/audit-log.md)を有効にします。
* `Telemetry:*` については、[テレメトリ](https://docs.xbox.com/ja-jp/tools/xbox-cli/telemetry.md)で説明しています。

`PlayFab:BaseUrlTemplate`、`PlayFab:StudioBaseUrl`、または `XboxPartner:BaseUrl` が組み込みの既定値と
異なる場合、そのエンドポイントにトークンを送信するすべてのコマンドは、最初に stderr に警告を
書き込みます。

## 環境変数

設定の変数名は、`XBOX_` にキーを続け、各 `:` を `__` (アンダースコア 2 つ) に置き換えたものです。
たとえば、`Telemetry:Enabled` は `XBOX_TELEMETRY__ENABLED` になります。名前は大文字で記述します。変数は、
それを設定したシェルと、そのシェルが開始するすべてのコマンドに適用されます。

```bash theme={null}
# Linux / macOS
export XBOX_XBOXPARTNER__TIMEOUTSECONDS=300
xbox game list
```

```powershell theme={null}
# Windows PowerShell
$env:XBOX_XBOXPARTNER__TIMEOUTSECONDS = "300"
xbox game list
```

[設定](#settings)のすべての設定には変数があります。CLI は次の変数も読み取ります。

| 環境変数 | 目的 |
| - | - |
| `XBOX_PLAYFAB_TITLE_ID`、`XBOX_SELLER_ID`、`XBOX_SANDBOX_ID`、`XBOX_TITLE_ID` | コンテキストの値。[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください |
| `XBOX_PROFILE` | `--profile` が渡されない場合に、保存された値の取得元となる[プロファイル](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md#profiles) |
| `XBOX_TELEMETRY_OPTOUT` | `1`、`true`、または `yes` に設定すると、テレメトリを無効にします |
| `XBOX_AUTHENTICATION__MODE` およびその他の `XBOX_AUTHENTICATION__` 変数 | サービス プリンシパルのサインイン |

`XBOX_AUTHENTICATION__` の設定は環境変数からのみ読み取られ、組み込みの既定値やオプションからは読み取られません。
[自動化 (サービス プリンシパル) の認証](https://docs.xbox.com/ja-jp/tools/xbox-cli/authentication.md#automation-service-principal-authentication)を参照してください。

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

オプションは、1 つのコマンドについて、他のすべてのソースをオーバーライドします。

| オプション | 構成キーまたは動作 |
| - | - |
| `--client-id` | ユーザー サインイン用の `AzureAd:ClientId`。サービス プリンシパル モードでは拒否されます |
| `--tenant-id` | ユーザー サインイン用の `AzureAd:TenantId`。サービス プリンシパル モードでは拒否されます |
| `--scopes` | `AzureAd:Scopes` |
| `--base-url` | `XboxPartner:BaseUrl`。[`game`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/game) や [`seller`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/seller) など、このオプションを受け付けるコマンドで使用できます |
| `--disable-telemetry` | このコマンドについて `Telemetry:Enabled=false` を設定します |

その他のグローバル オプションについては、[コマンド](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands.md)を参照してください。

## テレメトリの構成

公式リリースでは、無効にしない限り、限られた匿名のテレメトリが収集されます。1 つのコマンドで
無効にするには、次のようにします。

```bash theme={null}
xbox --disable-telemetry auth status
```

シェルで無効にするには、次のようにします。

```bash theme={null}
export XBOX_TELEMETRY_OPTOUT=1
```

```powershell theme={null}
$env:XBOX_TELEMETRY_OPTOUT = "1"
```

収集される内容については、[テレメトリ](https://docs.xbox.com/ja-jp/tools/xbox-cli/telemetry.md)を参照してください。

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

以前のリリースでは、実行可能ファイルと同じ場所にある `appsettings.json` を読み取っていました。このファイルの値を変更していた場合は、
代わりに対応する `XBOX_` 変数を設定してください。たとえば、`"AzureAd": { "ClientId": "..." }` は
`XBOX_AZUREAD__CLIENTID` になります。移行が完了するまで、次のメッセージが表示される場合があります。

* `--config-env` は次のエラーで失敗します。このオプションを削除し、代わりに `XBOX_` 変数を設定してください。

  ```text theme={null}
  --config-env is no longer supported because settings files are no longer read. Set XBOX_ environment variables instead, such as XBOX_AZUREAD__CLIENTID.
  ```

* 実行可能ファイルと同じ場所に `appsettings*.json` ファイルがある間は、コマンドが次のメモを
  stderr に書き込みます。このファイルを削除してください。

  ```text theme={null}
  Note: '<file>' is no longer read. Settings come from the built-in defaults, XBOX_ environment variables, and command options. Delete the file to hide this note.
  ```

* 以前のエラー メッセージに従って `XBOX_PLAYFAB__REQUESTHEADERS__0__VALUE` を設定した場合、PlayFab コマンドは
  この変数名を示すエラーで失敗します。この変数を削除してください。


## Related topics

- [構成](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/identity/privileges/config/index.md)
- [HTTP 構成](https://docs.xbox.com/ja-jp/services/playfab/sdks/c/http-config.md)
- [ポータル構成](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/portal-config/index.md)
- [XBOX サービスの構成](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl.md)
- [XBOX services 構成 ID (Managed Partners 向け)](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/portal-config/live-service-config-ids-mp.md)
