playfab service-principal est expérimentale. Son interface CLI pourrait
changer ou être retirée en fonction des commentaires.
Un pipeline d’intégration continue (CI) ou une autre tâche sans surveillance se connecte en tant que principal de service
Microsoft Entra ID; consultez
Authentification pour l’automatisation (principal de service).
PlayFab accepte le principal de service seulement après qu’une personne lui a accordé l’accès dans un studio
PlayFab. Ces commandes gèrent ces octrois d’accès.
Seule une personne connectée disposant de l’autorisation Admin sur le studio peut exécuter ces commandes. Elles
refusent de s’exécuter lorsque XBOX_AUTHENTICATION__MODE sélectionne un mode de principal de service; connectez-vous donc plutôt
avec xbox auth login.
list accepte --output table; les autres commandes ne l’acceptent pas. list retourne une seule page : lorsqu’il
y en a d’autres, le ContinuationToken de la réponse est défini, et exécuter list de nouveau avec
--continuation-token défini à cette valeur permet d’obtenir la page suivante.
Identificateurs
--studio-idnomme le studio propriétaire des octrois d’accès. Ces commandes n’acceptent pas de titre PlayFab;--playfab-title-idet le contexte enregistré ne s’appliquent donc pas.--principal-tenant-idet--principal-object-ididentifient le principal de service : son locataire Entra ID et l’ID d’objet de son application d’entreprise, et non celui de son inscription d’application.xbox auth statusl’indique sous la formeobjectIdlorsque vous êtes connecté en tant que principal de service.- Vous ne transmettez pas l’ID d’application (client). PlayFab l’enregistre à partir du premier jeton du principal
de service, et
listetgetl’indiquent sous la formeClientId. - Les options globales
--tenant-idet--client-idconfigurent votre propre connexion, et non le principal de service auquel vous accordez l’accès.
Fichier d’octrois d’accès
Partez des octrois d’accès actuels plutôt que d’écrire un fichier à partir de zéro. Enregistrez la sortie deget, modifiez ses StudioPermissions et TitleGrants, puis transmettez-la à set, avec sa
Version comme valeur de --expected-version :
get, son champ data, l’objet ServicePrincipal
qu’il contient, ou seulement les octrois d’accès :
- Les deux propriétés sont obligatoires. Une liste vide n’accorde rien de ce type.
- Chaque titre a besoin d’au moins une autorisation. Pour retirer l’octroi d’accès d’un titre, omettez le titre.
- Les noms de propriétés ne sont pas sensibles à la casse. Une propriété non reconnue constitue une erreur; ainsi, un
TitleGrantsmal orthographié ne peut pas retirer tous les octrois d’accès aux titres. - Les valeurs
TenantId,ObjectIdetDisplayNamedu fichier, lorsqu’elles sont présentes, doivent correspondre à--principal-tenant-id,--principal-object-idet--display-name. Pour renommer le principal de service, modifiez aussiDisplayNamedans le fichier, ou retirez-le.
Version attendue
Chaque modification des octrois d’accès d’un principal de service leur attribue une nouvelleVersion, que retournent get et
set. Avec --expected-version, set ne modifie rien, sauf si les octrois d’accès sont toujours
à cette version; elle ne peut donc pas annuler une modification effectuée par quelqu’un après que vous les avez lus.
--expected-version 0 exige que le principal de service n’ait encore aucun accès. Sans
--expected-version, set remplace les octrois d’accès, quels qu’ils soient actuellement.
Lorsque le fichier d’octrois d’accès contient une Version, --expected-version est obligatoire et doit lui être égale.
Si elles diffèrent, exécutez get de nouveau et refaites vos modifications sur sa sortie. Pour remplacer les octrois d’accès
dans tous les cas, retirez Version du fichier et omettez --expected-version.
Si set échoue
Un échec n’indique pas si les octrois d’accès ont changé; n’exécutez donc pas set de nouveau avec l’ancienne
version. Exécutez get, vérifiez ses octrois d’accès et sa Version et, s’ils ne correspondent pas à ce que vous vouliez
définir, modifiez cette sortie et transmettez-la à set avec sa Version comme valeur de --expected-version.
Exemples
Répertorier les principaux de service d’un studio et afficher les octrois d’accès de l’un d’eux :grants.json, que vous avez enregistré à partir de
get et modifié :
revoke, la requête PlayFab suivante du principal de service dans le studio échoue. revoke
réussit aussi lorsque le principal de service n’a déjà aucun accès. Pour rétablir l’accès, exécutez
set avec l’ensemble complet des octrois d’accès.