--seller-id. Sans cette option, une commande utilise XBOX_SELLER_ID ou le vendeur
enregistré avec xbox context set, puis votre seul vendeur ; si vous en avez plusieurs,
passez --seller-id.
Commandes
batch create, batch update et batch delete demandent une confirmation avant de modifier quoi que ce soit, et sont
envoyées une seule fois, sans jamais être relancées. Consultez Sécurité et opérations destructrices.
Options de lecture des lots
Les balises apparaissent sous la forme
keywords dans la sortie JSON et dans des codes d’erreur tels que
test_account_keyword_invalid. --tag correspond à une balise entière, et non à une partie de balise.
Si vous ne pouvez pas lire tous les lots du vendeur, vous ne recevez aucune erreur : batch list renvoie uniquement les
lots que vous avez créés.
Lots expirés
Un lot est expiré une fois que sa dateaccessExpirationDate, la date de fin de son accès aux sandboxes, est
passée. Un lot sans date n’expire jamais. L’expiration n’indique pas si les comptes peuvent toujours
se connecter.
batch list --expired lit la liste complète du vendeur pour trouver les lots expirés ; elle est donc
plus lente pour un vendeur qui a de nombreux lots. Elle ne peut pas être combinée avec --include-sandboxes ; exécutez
batch get sur un lot expiré pour voir son accès aux sandboxes.
Forme de la réponse
list renvoie :
keywordsetsandboxAccessvalentnullsauf si vous passez--include-sandboxes.getles renvoie toujours.isCompletesignifie que le travail de création s’est arrêté, et non que tous les comptes ont été créés. Comparez le nombre de comptes renvoyé pargetavecbatchSize, et lisezprogresspour obtenir le message d’état.createdByest un ID utilisateur Partner Center numérique.jobIdest le travail en cours d’exécution du lot ; il vautnullune fois le travail arrêté. Les travaux de mise à jour et de suppression apparaissent également ici, mais seul un travail de création peut être suivi avecjob wait.
get renvoie le même objet lot ainsi que ses comptes :
xuid, email, gamertag et isDeleted. xuid est une chaîne.
Erreurs lors de la lecture des lots
batch list, batch get et test-account get se terminent avec le code 1 en cas d’échec. Lorsque le service renvoie
une erreur JSON, stderr reçoit une erreur JSON avec status, title, detail, code lorsque la
réponse en contient un, ainsi que son correlationId ; la plupart ajoutent une indication dans detail. Les autres échecs
affichent une ligne de texte. Vérifiez le code de sortie avant d’analyser stderr.
Recherche d’un compte
test-account get <email> indique si le lot qui contient un compte a expiré. L’adresse e-mail
doit se terminer par @xboxtest.com. La commande recherche dans les 10 lots les plus récents dont le modèle
d’e-mail correspond au nom du compte. Lorsqu’elle n’y trouve pas le compte, elle indique que les lots plus anciens
n’ont pas été examinés et affiche des commandes batch list et batch get pour les vérifier
vous-même.
Elle renvoie ce qui suit, abrégé ici ; batch contient tous les champs de lot que batch list
renvoie :
expiredOn vaut null lorsque le lot n’a pas expiré. Un compte supprimé n’est signalé que lorsqu’il n’existe aucune
copie active, avec account.isDeleted défini. La commande se termine avec le code 0 dès qu’elle trouve le
compte, expiré ou non ; les scripts doivent donc lire expired. Elle se termine avec le code 1 lorsque :
- Le compte ne figure pas dans les lots que vous pouvez voir. Il appartient peut-être à un autre vendeur ; essayez donc
--seller-id. Ou bien un autre développeur a créé son lot et vous ne pouvez pas lire tous les lots du vendeur. - L’adresse e-mail apparaît dans plusieurs lots. stderr répertorie une commande
batch getpour chacun. - Une requête échoue, comme décrit dans Erreurs lors de la lecture des lots.
Création d’un lot
batch create démarre un travail qui crée les comptes, puis attend qu’il s’arrête. Les comptes
sont décomptés de la limite de comptes de test du vendeur jusqu’à ce que le lot soit
supprimé.
Dans un terminal, la commande affiche le sélecteur de question de sécurité,
répertorie les valeurs qu’elle enverra, y compris les valeurs par défaut des options que vous avez omises, et vous demande de
confirmer. Elle vous invite ensuite à saisir le mot de passe et la réponse de sécurité, se connecte et envoie
la requête. --confirm (--yes, -y) ignore uniquement la confirmation.
Sans terminal, passez --password-file, --security-answer-file et --confirm. Sans
--confirm, la commande affiche les valeurs, refuse et n’envoie rien.
Choix d’une question de sécurité
Dans un terminal, lorsque vous ne passez ni--security-question ni --security-answer-file, la
commande affiche un sélecteur numéroté de ces questions. Entrée sélectionne la première. Pour en choisir une
sans le sélecteur, passez son texte avec --security-question :
- What is your favorite hobby?
- Who is your favorite athlete?
- What is your maternal grandmother’s first name?
- What was your childhood best friend’s first name?
- What was the name of your first pet?
- What is your current best friend’s first name?
- What was your favorite city to visit as a child?
What is your favorite hobby?. Ctrl+C dans le sélecteur annule sans rien créer.
Le choix d’une question ne confirme pas la création.
Secrets
Le mot de passe et la réponse de sécurité ne sont jamais acceptés comme valeurs d’option ni comme variables d’environnement ; ils n’apparaissent donc pas dans l’historique du shell, les listes de processus ni les journaux. Chacun provient :- De son
--password-fileou de son--security-answer-file. Un seul saut de ligne final est supprimé. - De
-à la place d’un chemin, qui le lit depuis stdin. Un seul des deux peut lire stdin. - Sans option de fichier, d’une invite dans le terminal qui n’affiche pas ce que vous tapez.
Attente et codes de sortie
Pendant l’attente, la commande affiche la progression sur stderr. Elle écrit le travail final sur stdout, sous la même forme quejob get.
Lorsque le résultat est inconnu
Lorsque la CLI ne peut pas déterminer si le service a créé un lot, par exemple lorsque la connexion est interrompue après l’envoi de la requête ou que le service renvoie une erreur5xx, elle se termine avec le code 3. Elle ne renvoie jamais la
création. stderr affiche l’heure de début de la requête, en UTC, ainsi que les étapes suivantes :
- Patientez quelques minutes ; un lot encore en cours de création n’apparaît peut-être pas encore dans la liste.
- Exécutez
xbox test-account batch list --mine --email-prefix <prefix>et recherchez un lot avec le même préfixe d’e-mail et le même modèle, créé à cette heure ou après. - Si le
jobIdde ce lot est défini, suivez-le avecxbox test-account job wait <job-id> --batch-id <batch-id>. SijobIdvautnull, le travail s’est arrêté ; examinez-le avecxbox test-account batch get <batch-id>. - Ne relancez la création que si aucun lot de ce type n’existe.
Erreurs lors de la création
Les échecs écrivent sur stderr une erreur JSON avecstatus, title, detail et code lorsque la
réponse en contient un. Basez votre logique sur code, et non sur detail.
Suivi d’un travail de création
batch create affiche les ID du lot et du travail dès que le travail est accepté. Un travail peut s’exécuter pendant
plusieurs jours ; vous pouvez donc cesser d’attendre à tout moment et le suivre ultérieurement :
Les deux renvoient le travail :
state vaut running, succeeded ou failed. errorCode vaut test_account_job_failed lorsque le
travail a échoué. job wait relance les échecs de lecture temporaires, comme une limitation ou une connexion
interrompue.
Erreurs lors du suivi d’un travail
Ces codes d’erreur concernent l’ID du travail,--batch-id ou --seller-id :
Mise à jour d’un lot
batch update modifie tous les comptes d’un lot : elle peut leur donner accès à d’autres sandboxes,
leur retirer un accès, déplacer la date d’expiration de cet accès, et ajouter des balises au lot ou remplacer ses balises. Elle
attend ensuite que le lot affiche la modification.
Dans un terminal, la commande affiche d’abord chaque modification demandée à côté de la valeur actuelle
du lot, avertit lorsqu’un travail est encore en cours d’exécution sur le lot, et demande une confirmation. Passez --confirm (--yes,
-y) pour ignorer l’invite. Sans terminal et sans --confirm, elle affiche les modifications,
refuse et n’envoie rien.
Passez au moins une modification. Un lot peut avoir au maximum 20 balises.
--replace-tags et
--clear-tags conservent la balise qui enregistre l’outil ayant créé le lot, qui n’est pas prise en compte
dans la limite. La modification des sandboxes ou de l’expiration nécessite l’accès à ces sandboxes ;
la prolongation de l’expiration nécessite l’accès à tous les sandboxes du lot.
La commande renvoie les valeurs du lot une fois la mise à jour terminée :
state vaut updated une fois que le lot affiche la modification, ou updating avec --no-wait ou lorsque
l’attente prend fin avant. Lorsque le lot possède déjà toutes les valeurs demandées, rien ne change :
state vaut unchanged, jobId vaut null, et la commande se termine avec le code 0. Les travaux de mise à jour ne peuvent pas être
suivis avec job get ou job wait.
Attente et codes de sortie lors de la mise à jour
Erreurs lors de la mise à jour
Une erreur
404 ou 405 sans code signifie que la mise à jour des lots n’est pas disponible.
Suppression d’un lot
batch delete supprime un lot entier, puis attend qu’il n’existe plus. Chaque compte du lot
perd son accès aux sandboxes, et son enregistrement de compte de test est supprimé. Les comptes Microsoft
et les profils XBOX des comptes ne sont pas fermés.
Dans un terminal, la commande affiche d’abord le modèle d’e-mail, la taille et le créateur du lot, avertit
lorsqu’un travail est encore en cours d’exécution sur celui-ci, et demande une confirmation. Passez --confirm (--yes, -y) pour ignorer
l’invite. Sans terminal et sans --confirm, elle affiche ce qu’elle supprimerait, refuse
et n’envoie rien. Il n’existe pas de suppression en bloc ; supprimez les lots un par un.
La commande renvoie :
state vaut deleted une fois que le lot n’existe plus, ou deleting avec --no-wait ou lorsque l’attente
prend fin avant. Les travaux de suppression ne peuvent pas être suivis avec job get ou job wait ; pendant l’exécution de la suppression,
le lot affiche son jobId.
Attente et codes de sortie lors de la suppression
Erreurs lors de la suppression
Une erreur
404 ou 405 sans code signifie que la suppression des lots n’est pas disponible.
Sortie sous forme de tableau
Toutes les commandes acceptent--output table. Les heures sont affichées en UTC, et les lignes de résumé sont écrites sur
stderr ; stdout ne contient donc que le tableau.
