--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,
transmettez --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 de nouvelle tentative. Consultez Sécurité et opérations destructives.
Options de lecture des lots
Les étiquettes apparaissent sous le nom
keywords dans la sortie JSON et dans les codes d’erreur comme
test_account_keyword_invalid. --tag correspond à une étiquette entière, et non à une partie d’étiquette.
Si vous ne pouvez pas lire tous les lots du vendeur, vous n’obtenez aucune erreur : batch list retourne seulement les
lots que vous avez créés.
Lots expirés
Un lot est expiré une fois que sa dateaccessExpirationDate, soit la date de fin de son accès aux sandbox, 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 toute la liste du vendeur pour trouver les lots expirés; elle est donc
plus lente pour un vendeur qui a beaucoup de 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 sandbox.
Forme de la réponse
list retourne :
keywordsetsandboxAccesssontnull, sauf si vous transmettez--include-sandboxes.getles retourne 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 retournés pargetavecbatchSize, et lisezprogresspour obtenir le message d’état.createdByest un ID d’utilisateur Partner Center numérique.jobIdest le travail en cours d’exécution du lot, et a la valeurnullune fois le travail arrêté. Les travaux de mise à jour et de suppression apparaissent aussi ici, mais seul un travail de création peut être suivi avecjob wait.
get retourne le même objet de 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 retourne
une erreur JSON, stderr reçoit une erreur JSON avec status, title, detail, code lorsque la
réponse en contient un, et son correlationId; la plupart ajoutent un conseil dans detail. Les autres échecs
affichent une ligne de texte. Vérifiez le code de sortie avant d’analyser stderr.
Rechercher un compte
test-account get <email> indique si le lot qui contient un compte a expiré. L’adresse courriel
doit se terminer par @xboxtest.com. La commande effectue la recherche dans les 10 lots les plus récents dont le modèle
d’adresse courriel 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 retourne ce qui suit, abrégé ici; batch contient tous les champs de lot que batch list
retourne :
expiredOn est null lorsque le lot n’a pas expiré. Un compte supprimé est signalé seulement lorsqu’aucune
copie active n’existe, avec account.isDeleted défini. La commande se termine avec le code 0 chaque fois qu’elle trouve le
compte, expiré ou non; les scripts doivent donc lire expired. Elle se termine avec le code 1 dans les cas suivants :
- Le compte ne se trouve pas dans les lots que vous pouvez voir. Il appartient peut-être à un autre vendeur; essayez donc
--seller-id. Ou encore, un autre développeur a créé son lot et vous ne pouvez pas lire tous les lots du vendeur. - L’adresse courriel figure dans plus d’un lot. stderr répertorie une commande
batch getpour chacun. - Une requête échoue, comme décrit dans Erreurs lors de la lecture des lots.
Créer un lot
batch create démarre un travail qui crée les comptes, puis attend qu’il s’arrête. Les comptes
sont comptabilisés dans 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 à entrer le mot de passe et la réponse de sécurité, se connecte et envoie
la requête. --confirm (--yes, -y) ignore seulement la confirmation.
Sans terminal, transmettez --password-file, --security-answer-file et --confirm. Sans
--confirm, la commande affiche les valeurs, refuse et n’envoie rien.
Choisir une question de sécurité
Dans un terminal, lorsque vous ne transmettez ni--security-question ni --security-answer-file, la
commande affiche un sélecteur numéroté contenant ces questions. Entrée sélectionne la première. Pour en choisir une
sans le sélecteur, transmettez 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 l’opération 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 restent ainsi absents de l’historique de l’interpréteur de commandes, des listes de processus et des journaux. Chacun provient :- De son option
--password-fileou--security-answer-file. Un seul saut de ligne final est supprimé. - De
-à la place d’un chemin, qui le lit à partir de stdin. Seul l’un des deux peut lire stdin. - En l’absence d’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 dans stderr. Elle écrit le travail final dans 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 retourne une erreur5xx, elle se termine avec le code 3. Elle n’envoie jamais
la création de nouveau. stderr affiche l’heure à laquelle la requête a commencé, en UTC, ainsi que ces étapes :
- Attendez quelques minutes; un lot encore en cours de création pourrait ne pas encore être répertorié.
- Exécutez
xbox test-account batch list --mine --email-prefix <prefix>et recherchez un lot avec le même préfixe d’adresse courriel 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>. SijobIdestnull, le travail s’est arrêté; inspectez-le avecxbox test-account batch get <batch-id>. - Créez le lot de nouveau seulement si aucun lot de ce type n’existe.
Erreurs lors de la création
Les échecs écrivent dans 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.
Suivre 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
des jours; vous pouvez donc arrêter l’attente à tout moment et le suivre plus tard :
Les deux commandes retournent le travail :
state est running, succeeded ou failed. errorCode est test_account_job_failed lorsque le
travail a échoué. job wait fait de nouvelles tentatives en cas d’é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 :
Mettre à jour un lot
batch update modifie tous les comptes d’un lot : elle peut leur donner accès à d’autres sandbox,
leur retirer un accès, modifier la date d’expiration de cet accès, et ajouter des étiquettes au lot ou remplacer ses étiquettes. 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. Transmettez --confirm (--yes,
-y) pour ignorer l’invite. Sans terminal et sans --confirm, elle affiche les modifications,
refuse et n’envoie rien.
Transmettez au moins une modification. Un lot peut avoir au plus 20 étiquettes.
--replace-tags et
--clear-tags conservent l’étiquette qui indique l’outil ayant créé le lot, laquelle n’est pas comptabilisée
dans la limite. La modification des sandbox ou de l’expiration nécessite l’accès à ces sandbox;
la prolongation de l’expiration nécessite l’accès à tous les sandbox du lot.
La commande retourne les valeurs du lot une fois la mise à jour terminée :
state est updated une fois que le lot affiche la modification, ou updating avec --no-wait ou lorsque
l’attente prend fin avant. Lorsque le lot a déjà toutes les valeurs demandées, rien ne change :
state est unchanged, jobId est null, et la commande se termine avec le code 0. Les travaux de mise à jour ne peuvent pas être
suivis avec job get ni 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.
Supprimer un lot
batch delete supprime un lot entier, puis attend qu’il n’existe plus. Chaque compte du lot
perd son accès aux sandbox, 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’adresse courriel, 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. Transmettez --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 à la fois.
La commande retourne :
state est 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 ni 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 dans
stderr; stdout contient donc seulement le tableau.
