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

# サンドボックス

> サインインしている開発者が使用できる XBOX サンドボックスを一覧表示、取得、作成します。

XBOX サンドボックスは、パートナー センター アカウント内にある、Microsoft Store の製品と XBOX サービス用の
分離された環境です。`RETAIL` などのグローバル サンドボックスは Microsoft によって管理され、
`ABCDEF.1` などの開発用サンドボックスはアカウントに属します。ゲーム公開ガイドの
[サンドボックス](https://learn.microsoft.com/gaming/game-publishing/concepts/sandboxes)を参照してください。
Windows PC が使用するサンドボックスを切り替えるには、[PC](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/pc.md) を参照してください。

各コマンドは、`--seller-id` または保存されている販売者で指定された 1 つの販売者を対象に動作します。
[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください。それがパートナー センターで最後に選択した販売者でない場合は、
[こちらの既知の問題](https://docs.xbox.com/ja-jp/tools/xbox-cli/known-issues.md#xbox-sandbox-commands-show-only-global-sandboxes)を参照してください。

## コマンド

| コマンド | 説明 |
| - | - |
| `sandbox list` | パートナー センターの \[サンドボックス] ページに表示されるとおりに、販売者のサンドボックスとグローバル サンドボックスを一覧表示します。 |
| `sandbox get <sandbox-id>` | グローバル サンドボックスや Isolated サンドボックスを含め、サンドボックスを 1 つ取得します。ID、種類、所有する販売者、グローバルかどうかが含まれます。 |
| `sandbox create <sandbox-id>` | Shared の開発用サンドボックスを作成し、その作成ジョブを待機します。 |

## 引数とオプション

| 引数またはオプション | 適用対象 | 必須 | 説明 |
| - | - | - | - |
| `<sandbox-id>` | `get`、`create` | はい | サンドボックス ID (`ABCDEF.1` など)。大文字と小文字は区別されません。[サンドボックス ID](#sandbox-ids) を参照してください。 |
| `--seller-id <id>` | すべて | 保存されていない場合 | パートナー センターの販売者 ID。 |
| `--base-url <url>` | すべて | いいえ | 要求のベース URL。`XboxPartner:BaseUrl` 構成キーをオーバーライドします。 |
| `--confirm`、`--yes`、`-y` | `create` | いいえ | 確認プロンプトなしでサンドボックスを作成します。 |
| `--output <format>` | すべて | いいえ | `json` (既定) または `json-compact`。`table` は `list` と `get` でのみ使用できます。 |

`list` から取得した `sandboxId` を、[`xbl`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl) コマンドの
`--sandbox-id` オプションなどの他のコマンドに渡します。

### サンドボックス ID

サンドボックス ID は、英字と数字に、ピリオドで区切られた省略可能なサフィックスを付けたもので、最大 64
文字です。CLI はこれを大文字に変換します。

* `get` は、`RETAIL` や `CERT.DEBUG` などのグローバル サンドボックスを含め、任意のサンドボックス ID を受け付けます。
* `create` には、4 ～ 60 文字の英字または数字、ピリオド、および先頭が 0 でない `0` ～ `999` の
  数字が必要です (`ABCDEF.1` など)。サフィックス `.58` は Isolated サンドボックス用に予約されており、
  `UNDEFINED` とグローバル サンドボックスの名前は使用できません。

## 出力

`sandbox get` はサンドボックスを 1 つ書き込みます。

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

| フィールド | 説明 |
| - | - |
| `sandboxId` | サンドボックス ID。 |
| `type` | `Shared`、`Isolated`、または `Unknown`。`create` で作成されるのは Shared サンドボックスのみです。 |
| `sellerId` | 所有する販売者。グローバル サンドボックスの場合は `null`。 |
| `global` | `RETAIL` などのグローバル サンドボックスの場合は `true`。 |

`sandbox list` は、同じオブジェクトの `sandboxes` 配列を書き込みます。

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

`list --output table` には `SANDBOX`、`TYPE`、`GLOBAL` の列があり、`get --output table` には
`SANDBOX ID`、`TYPE`、`SELLER ID` の列があります。`create` は `--output table` を拒否します。

## サンドボックスの作成

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

`sandbox create` はサンドボックスを作成する前に確認を求めます。ターミナルがない場合は `--confirm` が必要です。
CLI ではサンドボックスを削除できません。複数の販売者に所属している場合は、最初に
[既知の問題](https://docs.xbox.com/ja-jp/tools/xbox-cli/known-issues.md#xbox-sandbox-commands-show-only-global-sandboxes)を確認してください。
サンドボックスが別の販売者に作成される可能性があります。

このコマンドは要求を 1 回送信し、作成ジョブを最大 2 分間待機します。ジョブが
成功すると、新しいサンドボックスを `sandbox get` と同じ形式で書き込みます。ジョブ ID、
相関 ID、および次に確認する内容は stderr に出力されます。終了コードが `3` または `4` の場合は、
`sandbox get <sandbox-id>` で確認し、サンドボックスを再度作成しないでください。

| 終了コード | 意味 |
| - | - |
| `0` | サンドボックスが作成されました。 |
| `1` | サンドボックスは作成されませんでした。入力または確認が拒否されたか、要求が送信されなかったか、サービスが要求を拒否しました (サンドボックスが存在する場合の `409` など)。問題を修正してから、コマンドを再実行してください。 |
| `2` | 作成ジョブが失敗しました。ジョブとその `errors` が stdout に書き込まれます。 |
| `3` | 要求は送信されましたが、結果は不明です。`sandbox get` で確認してください。 |
| `4` | ジョブは受け付けられましたが、サンドボックスが確認される前に待機が終了しました。stdout には何も書き込まれません。`sandbox get` で確認してください。 |

## エラー

失敗した場合は、`--output` の値にかかわらず、相関 ID、HTTP ステータスに応じたガイダンス、
およびサービスのエラーの詳細 (ある場合) がテキストとして stderr に書き込まれます。`--verbose` を指定すると応答
本文が追加されます。スクリプトでは、文言ではなく終了コードで分岐してください。

## 例

サンドボックスを一覧表示し、そのうちの 2 つを取得します。

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

確認プロンプトなしでサンドボックスを作成します。

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


## Related topics

- [サンドボックス](https://docs.xbox.com/ja-jp/publishing/game-publishing/concepts/sandboxes.md)
- [サンドボックス (目次)](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/sandboxes/live-sandboxes-nav.md)
- [XBOX services サンドボックスの概要](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/sandboxes/live-setup-sandbox.md)
- [XBOX services サンドボックスの詳細](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/sandboxes/live-advanced-sandboxes.md)
- [サンドボックスのセットアップ](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/sandboxes/live-setting-up-sandboxes.md)
