> ## 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.

# Configuration

> Comment la CLI superpose les paramètres issus de ses valeurs par défaut intégrées, des variables d'environnement et des options de ligne de commande.

La XBOX CLI ne nécessite aucun fichier de configuration. Ses paramètres proviennent de valeurs par défaut intégrées
à l'exécutable, que vous pouvez remplacer pour un shell avec des variables d'environnement ou pour
une seule commande avec des options.

## Sources de configuration et priorité

Les paramètres proviennent de trois sources, et les sources suivantes remplacent les précédentes :

1. Les valeurs par défaut intégrées, compilées dans l'exécutable. Consultez [Paramètres](#settings).
2. Les variables d'environnement. Consultez [Variables d'environnement](#environment-variables).
3. Les options de ligne de commande. Consultez [Remplacements par les options de la CLI](#cli-option-overrides).

Une nouvelle version apporte ses propres valeurs par défaut : il n'y a donc aucun fichier de paramètres à reporter.

Le vendeur, le titre PlayFab, le titre XBOX et le sandbox ne sont pas des paramètres ; consultez
[Contexte](https://docs.xbox.com/fr/tools/xbox-cli/commands/context.md) pour savoir où une commande les obtient.

## Paramètres

| Clé | Variable d'environnement | Option | Valeur par défaut intégrée |
| - | - | - | - |
| `AzureAd:ClientId` | `XBOX_AZUREAD__CLIENTID` | `--client-id` | L'application Microsoft Entra ID propre à la CLI |
| `AzureAd:TenantId` | `XBOX_AZUREAD__TENANTID` | `--tenant-id` | `common` |
| `AzureAd:Scopes` | `XBOX_AZUREAD__SCOPES` | `--scopes` | Intégrée |
| `PlayFab:BaseUrlTemplate` | `XBOX_PLAYFAB__BASEURLTEMPLATE` | Aucune | Intégrée |
| `PlayFab:StudioBaseUrl` | `XBOX_PLAYFAB__STUDIOBASEURL` | Aucune | Intégrée |
| `PlayFab:MaxRequestBodyBytes` | `XBOX_PLAYFAB__MAXREQUESTBODYBYTES` | Aucune | `1048576` (1 Mio) |
| `PlayFab:MaxResponseBytes` | `XBOX_PLAYFAB__MAXRESPONSEBYTES` | Aucune | `4194304` (4 Mio) |
| `XboxPartner:BaseUrl` | `XBOX_XBOXPARTNER__BASEURL` | `--base-url`, sur les commandes qui l'acceptent | Intégrée |
| `XboxPartner:TimeoutSeconds` | `XBOX_XBOXPARTNER__TIMEOUTSECONDS` | Aucune | `120` |
| `XblPCSandbox:Path` | `XBOX_XBLPCSANDBOX__PATH` | Aucune | Non définie |
| `AuditLog:Enabled` | `XBOX_AUDITLOG__ENABLED` | Aucune | `false` |
| `Telemetry:Enabled` | `XBOX_TELEMETRY__ENABLED` | `--disable-telemetry` définit `false` | `true` |

* Les paramètres `AzureAd:*` configurent la connexion utilisateur ; consultez [Authentification](https://docs.xbox.com/fr/tools/xbox-cli/authentication.md#overriding-entra-id-settings).
* `PlayFab:StudioBaseUrl` est le point de terminaison PlayFab des API de studio (`/Studio/*`), comme
  celles qu'appelle [`playfab service-principal`](https://docs.xbox.com/fr/tools/xbox-cli/commands/playfab/service-principal).
* `XboxPartner:TimeoutSeconds` est le délai d'expiration des requêtes, en secondes, pour des commandes telles que
  [`game`](https://docs.xbox.com/fr/tools/xbox-cli/commands/game), et doit être un nombre positif.
* `XblPCSandbox:Path` est le fichier `XblPCSandbox.exe` qu'exécutent les commandes [`pc sandbox`](https://docs.xbox.com/fr/tools/xbox-cli/commands/pc).
  Lorsqu'il n'est pas défini, la CLI le recherche dans son propre répertoire, puis dans `PATH`.
* `AuditLog:Enabled` active le [journal d'audit](https://docs.xbox.com/fr/tools/xbox-cli/audit-log.md).
* Les paramètres `Telemetry:*` sont décrits dans [Télémétrie](https://docs.xbox.com/fr/tools/xbox-cli/telemetry.md).

Lorsque `PlayFab:BaseUrlTemplate`, `PlayFab:StudioBaseUrl` ou `XboxPartner:BaseUrl` n'a pas sa
valeur par défaut intégrée, chaque commande qui envoie un jeton à ce point de terminaison écrit d'abord un avertissement sur
stderr.

## Variables d'environnement

La variable d'un paramètre est formée de `XBOX_` suivi de sa clé, avec `__` (deux traits de soulignement) à la place de chaque `:` :
ainsi, `Telemetry:Enabled` devient `XBOX_TELEMETRY__ENABLED`. Écrivez les noms en majuscules. Une variable s'applique
au shell qui la définit et à toutes les commandes que ce shell lance :

```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
```

Chaque paramètre de la section [Paramètres](#settings) a une variable. La CLI lit également celles-ci :

| Variable d'environnement | Rôle |
| - | - |
| `XBOX_PLAYFAB_TITLE_ID`, `XBOX_SELLER_ID`, `XBOX_SANDBOX_ID`, `XBOX_TITLE_ID` | Valeurs de contexte ; consultez [Contexte](https://docs.xbox.com/fr/tools/xbox-cli/commands/context.md) |
| `XBOX_PROFILE` | Le [profil](https://docs.xbox.com/fr/tools/xbox-cli/commands/context.md#profiles) d'où proviennent les valeurs enregistrées, lorsque `--profile` n'est pas passé |
| `XBOX_TELEMETRY_OPTOUT` | Désactive la télémétrie lorsqu'elle est définie sur `1`, `true` ou `yes` |
| `XBOX_AUTHENTICATION__MODE` et les autres variables `XBOX_AUTHENTICATION__` | Connexion en tant que principal de service |

Les paramètres `XBOX_AUTHENTICATION__` sont lus uniquement à partir des variables d'environnement, jamais à partir des valeurs par défaut
intégrées ni des options. Consultez
[Authentification pour l'automatisation (principal de service)](https://docs.xbox.com/fr/tools/xbox-cli/authentication.md#automation-service-principal-authentication).

## Remplacements par les options de la CLI

Les options remplacent toutes les autres sources, pour une seule commande.

| Option | Clé de configuration ou comportement |
| - | - |
| `--client-id` | `AzureAd:ClientId` pour la connexion utilisateur ; refusée dans les modes principal de service |
| `--tenant-id` | `AzureAd:TenantId` pour la connexion utilisateur ; refusée dans les modes principal de service |
| `--scopes` | `AzureAd:Scopes` |
| `--base-url` | `XboxPartner:BaseUrl`, sur les commandes qui l'acceptent, comme [`game`](https://docs.xbox.com/fr/tools/xbox-cli/commands/game) et [`seller`](https://docs.xbox.com/fr/tools/xbox-cli/commands/seller) |
| `--disable-telemetry` | Définit `Telemetry:Enabled=false` pour cette commande |

Consultez [Commandes](https://docs.xbox.com/fr/tools/xbox-cli/commands.md) pour les autres options globales.

## Configuration de la télémétrie

Les versions officielles collectent une télémétrie anonyme limitée, sauf si vous la désactivez. Pour la désactiver
pour une seule commande :

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

Pour la désactiver pour un shell :

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

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

Consultez [Télémétrie](https://docs.xbox.com/fr/tools/xbox-cli/telemetry.md) pour savoir ce qui est collecté.

## Mise à niveau depuis une version qui lisait appsettings.json

Les versions antérieures lisaient `appsettings.json` à côté de l'exécutable. Si vous y aviez modifié une valeur,
définissez plutôt sa variable `XBOX_` : par exemple, `"AzureAd": { "ClientId": "..." }` devient
`XBOX_AZUREAD__CLIENTID`. Vous pouvez voir ces messages tant que vous n'avez pas terminé :

* `--config-env` échoue avec cette erreur. Supprimez l'option et définissez plutôt des variables `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.
  ```

* Tant qu'un fichier `appsettings*.json` se trouve à côté de l'exécutable, les commandes écrivent cette remarque sur
  stderr. Supprimez le fichier.

  ```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.
  ```

* Les commandes PlayFab échouent avec une erreur qui nomme `XBOX_PLAYFAB__REQUESTHEADERS__0__VALUE` si un
  message d'erreur antérieur vous a amené à la définir. Supprimez la variable.


## Related topics

- [Configuration](https://docs.xbox.com/fr/services/xbox-services/fundamentals/identity/privileges/config/index.md)
- [Configuration HTTP](https://docs.xbox.com/fr/services/playfab/sdks/c/http-config.md)
- [Configuration du portail](https://docs.xbox.com/fr/services/xbox-services/fundamentals/portal-config/index.md)
- [PFVersionConfiguration](https://docs.xbox.com/fr/services/playfab/api-references/c/pftypes/structs/pfversionconfiguration.md)
- [Configuration du jeu](https://docs.xbox.com/fr/publishing/game-publishing/concepts/game-setup-overview.md)
