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

# Contexte

> Enregistrez des valeurs par défaut, comme le vendeur et le titre PlayFab, pour les commandes ultérieures, dans des profils nommés si vous avez besoin de plusieurs ensembles.

`xbox context` enregistre des valeurs par défaut pour le vendeur, le titre PlayFab, le titre XBOX et le sandbox, pour que
vous n'ayez pas à les transmettre à chaque commande. Cette page décrit aussi où une commande obtient
ces valeurs lorsque vous ne les transmettez pas. Le contexte est local : ces commandes ne modifient rien dans
Partner Center ni dans PlayFab.

## Commandes

| Commande | Description |
| - | - |
| `context get` | Affiche les valeurs enregistrées. |
| `context set` | Enregistre une valeur. |
| `context unset` | Supprime des valeurs enregistrées. |
| `context key list` | Répertorie les clés que vous pouvez enregistrer et les commandes qui utilisent chacune d'elles. Ne nécessite aucune connexion. |
| `context profile list` | Répertorie vos profils, en commençant par `default`. |
| `context profile delete` | Supprime un profil nommé et toutes les valeurs qui y sont enregistrées. |

## Clés

Une clé porte le nom de l'option qu'elle remplit :

| Clé | Option | Variable | Utilisée par |
| - | - | - | - |
| `playfab-title-id` | `--playfab-title-id` | `XBOX_PLAYFAB_TITLE_ID` | Commandes [`playfab`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playfab) |
| `sandbox-id` | `--sandbox-id` | `XBOX_SANDBOX_ID` | [`xbl`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/xbl) `config status` et `config publish` |
| `seller-id` | `--seller-id` | `XBOX_SELLER_ID` | Commandes [`audience`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/audience), [`game`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/game), [`package`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/package), [`playtest`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playtest), [`sandbox`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/sandbox), [`test-account`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/test-account) et [`xbl`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/xbl) |
| `title-id` | `--title-id` | `XBOX_TITLE_ID` | [`xbl`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/xbl#title-targeting) `config list`, `config status`, `config publish`, ainsi que `config download` et `config save` limités à un sandbox |

Aucune autre option n'accepte de valeur enregistrée ni de variable.

`title-id` est un ID de titre XBOX en hexadécimal, comme `1234ABCD`, et non un ID de titre PlayFab. Les
commandes `xbl` l'utilisent pour trouver l'identificateur de configuration de service (SCID) du titre, et l'ignorent
lorsque vous transmettez `--scid`. Consultez [Ciblage du titre](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/xbl.md#title-targeting).

## Utilisation des valeurs enregistrées par les commandes

Lorsqu'une commande accepte l'une de ces options, elle utilise la première valeur qu'elle trouve :

1. L'option sur la ligne de commande, comme `--seller-id`.
2. La variable `XBOX_` de l'option, comme `XBOX_SELLER_ID`. Une variable vide est considérée comme non définie.
3. La valeur enregistrée avec `context set` dans le [profil](#profiles) sélectionné.

```bash theme={null}
xbox context set playfab-title-id ABC123
xbox playfab title-data get                                # uses ABC123
XBOX_PLAYFAB_TITLE_ID=DEF456 xbox playfab title-data get   # uses DEF456
xbox --playfab-title-id GHI789 playfab title-data get      # uses GHI789
```

Une valeur provenant d'une variable ou du contexte enregistré est vérifiée comme une valeur saisie, et une erreur indique sa
provenance, comme `XBOX_SELLER_ID: --seller-id must be a positive numeric value.` Si rien ne
fournit une valeur dont une commande a besoin, celle-ci indique comment en définir une. Les commandes pour lesquelles le vendeur est
facultatif, `xbl` et `test-account`, utilisent votre seul vendeur autorisé.

Une commande qui modifie quelque chose écrit dans stderr chaque valeur qu'elle a remplie, ainsi que sa provenance,
même avec `--confirm`. Avec `--verbose`, toutes les commandes le font :

```text theme={null}
Using --playfab-title-id ABC123 from saved context.
```

La page [Problèmes connus](https://docs.xbox.com/fr-CA/tools/xbox-cli/known-issues.md) décrit deux problèmes qui amènent les commandes `game` et `sandbox`
à utiliser un vendeur différent de celui choisi de cette façon.

## Profils

Un profil est un ensemble nommé de valeurs enregistrées, par exemple un pour un titre de test et un pour la production.
Les commandes utilisent le profil nommé par `--profile`, sinon celui nommé par `XBOX_PROFILE`, sinon `default`.

```bash theme={null}
xbox --profile test context set playfab-title-id TEST1   # creates "test"
xbox --profile test playfab title-data get               # uses TEST1
xbox playfab title-data get                              # uses the default profile
```

Pour utiliser un profil pour toutes les commandes d'un interpréteur de commandes, définissez `XBOX_PROFILE` :

```bash theme={null}
export XBOX_PROFILE=test
```

Pour répertorier vos profils :

```bash theme={null}
xbox context profile list
```

Pour supprimer un profil et toutes les valeurs qui y sont enregistrées :

```bash theme={null}
xbox context profile delete test
```

* L'enregistrement de la première valeur dans un profil crée celui-ci. Les noms se composent de lettres, de chiffres et de traits d'union, jusqu'à
  64 caractères, et ne sont pas sensibles à la casse.

* Un profil qui n'existe pas, par exemple un profil mal orthographié, échoue au lieu de se rabattre sur
  `default`.

* Un profil n'emprunte pas de valeurs à `default`.

* Les variables `XBOX_` ont toujours priorité sur un profil. Lorsqu'une variable a priorité sur le profil nommé par `--profile`,
  la commande l'indique, même si elle ne modifie rien :

  ```text theme={null}
  Using --playfab-title-id PROD1 from XBOX_PLAYFAB_TITLE_ID, not profile test.
  ```

* La CLI ne mémorise pas de profil d'une commande à l'autre; en choisir un ne modifie donc jamais ce
  qu'utilise un autre terminal ou agent.

## Emplacement des valeurs enregistrées

Les valeurs enregistrées se trouvent dans `context.json`, dans le répertoire d'état de la CLI :

| Système d'exploitation | Répertoire |
| - | - |
| Windows | `%LOCALAPPDATA%\XboxDevCLI` |
| macOS | `~/Library/Application Support/XboxDevCLI` |
| Linux | `$XDG_DATA_HOME/XboxDevCLI`, par défaut `~/.local/share/XboxDevCLI` |

Chaque valeur appartient au compte qui l'a enregistrée; un autre compte ne la récupère donc pas.
`auth logout` conserve les valeurs enregistrées, et une nouvelle connexion avec le même compte les restaure.

## Arguments et options

| Argument ou option | Commandes | Description |
| - | - | - |
| `<key> <value>` | `set` | La clé à enregistrer et sa valeur. La valeur doit être valide pour l'option de la clé : `seller-id` est un nombre positif (consultez [`xbox seller list`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/seller)), et `playfab-title-id` se compose de lettres et de chiffres. |
| `<key>...` | `unset` | Clés à supprimer. La suppression d'une clé qui n'est pas enregistrée réussit. |
| `<name>` | `profile delete` | Le profil à supprimer. `default` ne peut pas être supprimé. |
| `--profile <name>` | Toutes | Utilise ce profil au lieu de celui de `XBOX_PROFILE` ou de `default`. Une [option globale](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands.md). |
| `--all` | `unset` | Supprime toutes les valeurs enregistrées dans le profil sélectionné. Ne peut pas être combinée avec des noms de clés. |
| `--base-url <url>` | `get`, `set`, `unset` | Remplace le paramètre `XboxPartner:BaseUrl`. Les valeurs de vendeur enregistrées appartiennent au point de terminaison pour lequel elles ont été enregistrées. |
| `--output <format>` | Toutes | `json` (par défaut), `json-compact` ou `table`. |

## Comportement

`get` retourne le `account` connecté, le `profile` et un tableau `values` de `key` et `value`,
avec `null` pour une clé qui n'est pas enregistrée. Il affiche ce qui est enregistré, et non ce qu'une commande utiliserait; exécutez
la commande avec `--verbose` pour le voir. Sans connexion, `get` n'affiche aucune valeur et indique comment se
connecter.

`set`, `unset` et les commandes `profile` nécessitent un compte connecté. `set` ne vérifie pas la
valeur auprès du service; un vendeur que vous ne pouvez pas utiliser échoue donc à la première commande qui l'envoie.

Un principal de service n'a pas de contexte enregistré. Dans un mode de principal de service, les commandes qui se connectent
refusent `--profile` et `XBOX_PROFILE`, et toutes les commandes `context` sauf `key list` échouent. Transmettez
plutôt chaque valeur avec son option ou sa variable `XBOX_`. Consultez
[Authentification pour l'automatisation (principal de service)](https://docs.xbox.com/fr-CA/tools/xbox-cli/authentication.md#automation-service-principal-authentication).

## Valeurs qui ne proviennent pas de la ligne de commande

Le contexte enregistré est partagé par tous les terminaux et agents qu'exécute votre utilisateur du système d'exploitation, et les variables d'environnement
n'apparaissent pas sur la ligne de commande. Ainsi, en plus de nommer chaque valeur qu'elle a remplie :

* Une opération dont la cible est la valeur de contexte elle-même doit l'avoir sur la ligne de commande.
  `/Admin/DeleteTitle` supprime le titre, et `playfab api-policy set --overwrite` remplace toute sa
  stratégie d'accès à l'API; chacune refuse donc un titre provenant du contexte enregistré ou d'une variable, et affiche
  la commande à exécuter à la place :

  ```text theme={null}
  $ xbox playfab api /Admin/DeleteTitle --confirm
  Using --playfab-title-id ABC123 from saved context.
  '/Admin/DeleteTitle' acts on playfab-title-id ABC123, which comes from saved context.
  The target of a destructive operation must be named on the command line. To proceed, run:
    xbox --playfab-title-id ABC123 playfab api /Admin/DeleteTitle --confirm
  ```

  La commande affichée omet une valeur `--body` ou `--statements` en ligne, car un corps de
  requête peut contenir des secrets. Remettez la valeur à la place de `<body>` ou de `<statements>`.

* Si un autre compte se connecte pendant l'exécution d'une commande qui utilise des valeurs enregistrées, par exemple pendant qu'elle
  attend une confirmation, la commande s'arrête avant d'envoyer quoi que ce soit. Exécutez-la de nouveau.

Consultez [Sécurité et opérations destructives](https://docs.xbox.com/fr-CA/tools/xbox-cli/safety.md) pour connaître les règles de confirmation.

## Sortie sous forme de tableau

Toutes les commandes de contexte acceptent `--output table` :

| Commande | Colonnes |
| - | - |
| `context get`, `set`, `unset` | `KEY`, `VALUE` |
| `context key list` | `KEY`, `USED BY` |
| `context profile list`, `profile delete` | `NAME` |

## Exemples

Répertorier les clés que vous pouvez enregistrer :

```bash theme={null}
xbox context key list --output table
```

Enregistrer un vendeur et un titre PlayFab, puis vérifier ce qui est enregistré :

```bash theme={null}
xbox context set seller-id 1234567
xbox context set playfab-title-id ABC123
xbox context get --output table
```

Exécuter des commandes qui utilisent les valeurs enregistrées, et voir la provenance du titre :

```bash theme={null}
xbox game list
xbox --verbose playfab title-data get
```

Supprimer une valeur enregistrée :

```bash theme={null}
xbox context unset playfab-title-id
```

Supprimer toutes les valeurs enregistrées dans le profil sélectionné :

```bash theme={null}
xbox context unset --all
```

Consultez [Configuration](https://docs.xbox.com/fr-CA/tools/xbox-cli/configuration.md) pour les paramètres, que le contexte ne modifie pas.


## Related topics

- [Jeu d'artisanat - Contexte](https://docs.xbox.com/fr-CA/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/game-context.md)
- [Modèles de contexte de PlayFab CloudScript avec Azure Functions](https://docs.xbox.com/fr-CA/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/CloudScript-af-context.md)
- [Guide des opérations asynchrones du SDK C++ Lobby et Matchmaking](https://docs.xbox.com/fr-CA/services/playfab/multiplayer/lobby/lobby-and-matchmaking-client-sdk-async.md)
- [Manipulation audio en temps réel](https://docs.xbox.com/fr-CA/services/xbox-services/multiplayer/chat/game-chat2/real-time-audio-manipulation.md)
- [XBOX Accessibility Guideline 114](https://docs.xbox.com/fr-CA/build/game-principles/accessibility/xag-deep-dives/xag-114-ui-context.md)
