RETAIL are managed by Microsoft;
development sandboxes such as ABCDEF.1 belong to your account. See
Sandboxes in the Game
Publishing Guide. To switch the sandbox a Windows PC uses, see PC.
Each command acts on one seller, from --seller-id or your saved seller; see
Context. If that isn’t the seller you last selected in Partner Center, see
this known issue.
Commands
Arguments and options
Pass a
sandboxId from list to other commands, such as the xbl commands’
--sandbox-id option.
Sandbox IDs
A sandbox ID is letters and digits with an optional period-separated suffix, up to 64 characters. The CLI converts it to upper case.getaccepts any sandbox ID, including global ones such asRETAILandCERT.DEBUG.createneeds 4 to 60 letters or digits, a period, and a number from0to999without a leading zero, such asABCDEF.1. The suffix.58is reserved for Isolated sandboxes, andUNDEFINEDand the global sandbox names can’t be used.
Output
sandbox get writes one sandbox:
sandbox list writes a sandboxes array of the same objects:
list --output table has SANDBOX, TYPE, and GLOBAL columns, and get --output table has
SANDBOX ID, TYPE, and SELLER ID. create refuses --output table.
Creating a sandbox
sandbox create asks before it creates the sandbox; without a terminal, it needs --confirm.
The CLI can’t delete a sandbox. If you belong to several sellers, check
the known issue first: the
sandbox can be created in another seller.
The command sends the request once and waits up to two minutes for the creation job. When the
job succeeds, it writes the new sandbox in the same shape as sandbox get. The job ID,
correlation ID, and what to check next go to stderr. When the exit code is 3 or 4, check with
sandbox get <sandbox-id>, and don’t create the sandbox again.
Errors
A failure writes text to stderr, whatever--output is: the correlation ID, guidance for the
HTTP status, and the service’s error detail when there is one. --verbose adds the response
body. Scripts should branch on the exit code, not the wording.
