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

# Sandbox

> Répertoriez, obtenez et créez les sandbox XBOX accessibles au développeur connecté.

Un sandbox XBOX est un environnement isolé d'un compte Partner Center, destiné aux produits du Microsoft Store
et aux XBOX services. Les sandbox globaux comme `RETAIL` sont gérés par Microsoft;
les sandbox de développement comme `ABCDEF.1` appartiennent à votre compte. Consultez
[Sandbox](https://learn.microsoft.com/gaming/game-publishing/concepts/sandboxes) dans le Guide de
publication de jeux. Pour changer le sandbox qu'utilise un PC Windows, consultez [PC](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/pc.md).

Chaque commande agit sur un seul vendeur, provenant de `--seller-id` ou de votre vendeur enregistré; consultez
[Contexte](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/context.md). S'il ne s'agit pas du dernier vendeur que vous avez sélectionné dans Partner Center, consultez
[ce problème connu](https://docs.xbox.com/fr-CA/tools/xbox-cli/known-issues.md#xbox-sandbox-commands-show-only-global-sandboxes).

## Commandes

| Commande | Description |
| - | - |
| `sandbox list` | Répertorie les sandbox du vendeur et les sandbox globaux, tels que les affiche la page Sandbox de Partner Center. |
| `sandbox get <sandbox-id>` | Obtient un sandbox, y compris un sandbox global ou Isolated : son ID, son type, le vendeur propriétaire et s'il est global. |
| `sandbox create <sandbox-id>` | Crée un sandbox de développement Shared, puis attend son travail de création. |

## Arguments et options

| Argument ou option | S'applique à | Obligatoire | Description |
| - | - | - | - |
| `<sandbox-id>` | `get`, `create` | Oui | ID du sandbox, comme `ABCDEF.1`. La casse n'a pas d'importance. Consultez [ID de sandbox](#sandbox-ids). |
| `--seller-id <id>` | toutes | S'il n'est pas enregistré | ID de vendeur Partner Center. |
| `--base-url <url>` | toutes | Non | URL de base des requêtes, qui remplace la clé de configuration `XboxPartner:BaseUrl`. |
| `--confirm`, `--yes`, `-y` | `create` | Non | Crée le sandbox sans l'invite de confirmation. |
| `--output <format>` | toutes | Non | `json` (par défaut) ou `json-compact`; `table` avec `list` et `get` seulement. |

Transmettez un `sandboxId` provenant de `list` à d'autres commandes, comme l'option `--sandbox-id` des commandes
[`xbl`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/xbl).

### ID de sandbox

Un ID de sandbox est composé de lettres et de chiffres, avec un suffixe facultatif séparé par un point, jusqu'à 64
caractères. La CLI le convertit en majuscules.

* `get` accepte n'importe quel ID de sandbox, y compris les ID globaux comme `RETAIL` et `CERT.DEBUG`.
* `create` a besoin de 4 à 60 lettres ou chiffres, d'un point et d'un nombre de `0` à `999` sans
  zéro initial, comme `ABCDEF.1`. Le suffixe `.58` est réservé aux sandbox Isolated, et
  `UNDEFINED` ainsi que les noms des sandbox globaux ne peuvent pas être utilisés.

## Sortie

`sandbox get` écrit un sandbox :

```json theme={null}
{ "sandboxId": "ABCDEF.58", "type": "Isolated", "sellerId": "1234567", "global": false }
```

| Champ | Description |
| - | - |
| `sandboxId` | L'ID du sandbox. |
| `type` | `Shared`, `Isolated` ou `Unknown`. `create` crée seulement des sandbox Shared. |
| `sellerId` | Le vendeur propriétaire, ou `null` pour un sandbox global. |
| `global` | `true` pour un sandbox global, comme `RETAIL`. |

`sandbox list` écrit un tableau `sandboxes` contenant les mêmes objets :

```json theme={null}
{
  "sandboxes": [
    { "sandboxId": "RETAIL", "type": "Shared", "sellerId": null, "global": true },
    { "sandboxId": "ABCDEF.1", "type": "Shared", "sellerId": "1234567", "global": false }
  ]
}
```

`list --output table` comporte les colonnes `SANDBOX`, `TYPE` et `GLOBAL`, et `get --output table` comporte
`SANDBOX ID`, `TYPE` et `SELLER ID`. `create` refuse `--output table`.

## Créer un sandbox

```bash theme={null}
xbox sandbox create ABCDEF.1 --seller-id 1234567 --confirm
```

`sandbox create` demande une confirmation avant de créer le sandbox; sans terminal, elle a besoin de `--confirm`.
La CLI ne peut pas supprimer un sandbox. Si vous appartenez à plusieurs vendeurs, consultez d'abord
[le problème connu](https://docs.xbox.com/fr-CA/tools/xbox-cli/known-issues.md#xbox-sandbox-commands-show-only-global-sandboxes) : le
sandbox pourrait être créé dans un autre vendeur.

La commande envoie la requête une seule fois et attend jusqu'à deux minutes le travail de création. Lorsque le
travail réussit, elle écrit le nouveau sandbox sous la même forme que `sandbox get`. L'ID du travail,
l'ID de corrélation et ce qu'il faut vérifier ensuite sont écrits sur stderr. Lorsque le code de sortie est `3` ou `4`, vérifiez avec
`sandbox get <sandbox-id>`, et ne créez pas le sandbox de nouveau.

| Code de sortie | Signification |
| - | - |
| `0` | Le sandbox a été créé. |
| `1` | Le sandbox n'a pas été créé : l'entrée ou la confirmation a été refusée, la requête n'a pas été envoyée, ou le service l'a rejetée, par exemple avec une erreur `409` lorsque le sandbox existe. Corrigez le problème et exécutez la commande de nouveau. |
| `2` | Le travail de création a échoué. Le travail, avec ses `errors`, est écrit sur stdout. |
| `3` | La requête a été envoyée, mais son résultat est inconnu. Vérifiez avec `sandbox get`. |
| `4` | Le travail a été accepté, mais l'attente s'est terminée avant que le sandbox soit confirmé. Rien n'est écrit sur stdout. Vérifiez avec `sandbox get`. |

## Erreurs

Un échec écrit du texte sur stderr, quelle que soit la valeur de `--output` : l'ID de corrélation, des conseils sur le
statut HTTP et le détail de l'erreur du service, s'il y en a un. `--verbose` ajoute le corps de la
réponse. Les scripts doivent se baser sur le code de sortie, et non sur le libellé.

## Exemples

Répertorier les sandbox et en obtenir deux :

```bash theme={null}
xbox sandbox list --output table
xbox sandbox get ABCDEF.1
xbox sandbox get RETAIL
```

Créer un sandbox sans l'invite de confirmation :

```bash theme={null}
xbox sandbox create ABCDEF.2 --seller-id 1234567 --confirm --output json-compact
```


## Related topics

- [Sandboxes](https://docs.xbox.com/fr-CA/services/xbox-services/fundamentals/sandboxes/live-sandboxes-nav.md)
- [Configuration des sandboxes](https://docs.xbox.com/fr-CA/services/xbox-services/fundamentals/sandboxes/live-setting-up-sandboxes.md)
- [PC Sandbox Switcher (XblPCSandbox.exe)](https://docs.xbox.com/fr-CA/tools/tools-services/live-pc-sandbox-switcher.md)
- [Sandboxes avancés des services XBOX](https://docs.xbox.com/fr-CA/services/xbox-services/fundamentals/sandboxes/live-advanced-sandboxes.md)
- [XSystemGetXboxLiveSandboxId](https://docs.xbox.com/fr-CA/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid.md)
