tenant
Important
Il s’agit de la documentation Azure Sphere (héritée). Azure Sphere (hérité) prend sa retraite le 27 septembre 2027 et les utilisateurs doivent migrer vers Azure Sphere (intégré) pour l’instant. Utilisez le sélecteur de version situé au-dessus du TOC pour afficher la documentation Azure Sphere (intégrée).
Gère un locataire Azure Sphere.
Important
Les commandes , azsphere tenant download-ca-certificate-chainet azsphere tenant download-validation-certificate sont obsolètesazsphere tenant download-ca-certificate. Utilisez plutôt azsphere ca-certificate download, azsphere ca-certificate download-chain, azsphere ca-certificate download-proof et azsphere ca-certificate list.
Dans l’interface de ligne de commande Azure Sphere, le locataire par défaut n’est pas automatiquement sélectionné lors de la création d’un locataire. Vous devez exécuter la commande azsphere tenant select pour sélectionner le locataire par défaut à utiliser pour l’utilisateur actuel sur le PC. Cela permet de s’assurer que le locataire par défaut est le bon à utiliser lors de l’exécution d’une opération ponctuelle que vous ne pouvez pas annuler, comme la revendication de l’appareil.
| Operation | Description |
|---|---|
| create | Crée un locataire. |
| download-error-report | Retourne des informations d’erreur pour les appareils au sein du locataire actuel. |
| list | Répertorie les locataires Azure Sphere disponibles. |
| select | Sélectionne le locataire Azure Sphere par défaut à utiliser sur cet ordinateur. |
| show-selected | Affiche le locataire Azure Sphere par défaut pour cet ordinateur. |
| mise à jour | Met à jour les détails du locataire, tels que le nom du locataire. |
create
Crée un locataire Azure Sphere. Un appareil attaché est requis pour exécuter cette commande. Pour plus d’informations, consultez Créer un locataire Azure Sphere.
Si vous avez déjà un locataire, mais avez absolument besoin d’un autre locataire, utilisez le paramètre --force-additional. Vous ne pouvez pas supprimer un locataire Azure Sphere existant.
Une fois le locataire créé, exécutez azsphere tenant select to select the default tenant to use for the current user on this PC. Vous pouvez ajouter des rôles pour les utilisateurs dans le locataire Azure Sphere actuel à l’aide de la commande azsphere role add .
La commande azsphere tenant create fonctionne avec un appareil Azure Sphere attaché localement. Si vous essayez de l’utiliser sans appareil attaché, une erreur se produit. L’ID d’appareil est enregistré au moment où vous créez un locataire, et un seul locataire peut être créé par appareil.
Paramètres obligatoires
| Paramètre | Type | Description |
|---|---|---|
| -n,--name | Chaîne | Spécifie un nom pour le locataire. Lorsque vous nommez votre client, utilisez des caractères alphanumériques. Les caractères spéciaux ne sont pas autorisés. Le nom ne doit pas dépasser 50 caractères et respecte la casse. |
Paramètres facultatifs
| Paramètre | Type | Description |
|---|---|---|
| -d, --device | Chaîne | Spécifie l’appareil sur lequel exécuter la commande lorsque plusieurs appareils sont attachés. Ce paramètre est requis lorsque plusieurs appareils sont attachés. L’appareil actuellement attaché est utilisé par défaut. Vous pouvez spécifier l’ID d’appareil, l’adresse IP ou l’ID de connexion locale de l’appareil attaché. Azure Sphere CLI prend en charge plusieurs appareils MT3620 sur Windows, mais vous ne pouvez connecter qu’un seul appareil à la fois sur Linux. Pour cette raison, ce paramètre est pris en charge pour Windows, mais pas pour Linux. Une erreur est retournée si vous utilisez ce paramètre avec la commande sur Linux. |
| --force-additional | Boolean | Force la création d’un autre locataire Azure Sphere. Utilisez cette commande uniquement si vous êtes certain que vous souhaitez utiliser le compte actuel pour créer un locataire Azure Sphere à l’aide de l’appareil attaché. |
| --disable-confirm-prompt | Boolean | Désactive l’invite de confirmation de l’utilisateur. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere tenant create --name MyTenant
Utilisez les paramètres et --disable-confirm-prompt les --force-additional paramètres si vous êtes certain que vous souhaitez utiliser ce compte pour créer un locataire Azure Sphere à l’aide de l’appareil attaché. Un appareil qui a déjà été utilisé pour créer un locataire Azure Sphere ne peut pas être utilisé pour créer un locataire.
azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
--> Tenant Name: MyTenant1
--> Tenant ID: 768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.
Conseil
Une fois que vous avez créé un locataire, vérifiez que vous exécutez le locataire azsphere, sélectionnez le locataire par défaut à utiliser pour l’utilisateur actuel sur ce PC.
download-error-report
Retourne des informations sur les erreurs signalées par les appareils dans le locataire actuel.
Cette commande tire (pull) les données d’événement du cloud du service de sécurité Azure Sphere ; elle ne nécessite pas de connexion physique à un appareil particulier. La commande azsphere tenant download-error-report s’utilise dans le contexte du locataire actuel et retourne les rapports d’erreurs pour tous les appareils dans ce locataire.
Remarque
Le téléchargement des événements récemment signalés peut prendre jusqu’à 24 heures. Pour plus d’informations, consultez Collecter et interpréter les données d’erreur.
Paramètres facultatifs
| Paramètre | Type | Description |
|---|---|---|
| --destination | Chaîne | Spécifie le chemin d’accès et le nom de fichier du fichier de sortie. |
| -t, --tenant | GUID ou nom | Spécifie le locataire dans lequel effectuer cette opération. Remplace le locataire sélectionné par défaut. Vous pouvez spécifier l’ID de locataire ou le nom du locataire. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
Liste les locataires Azure Sphere.
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
select
Sélectionne le locataire Azure Sphere par défaut à utiliser pour l’utilisateur actuel sur ce PC.
Pour afficher le locataire par défaut actuel, utilisez azsphere tenant show-selected.
Paramètres obligatoires
| Paramètre | Type | Description |
|---|---|---|
| -t, --tenant | GUID ou nom | Spécifie le locataire dans lequel effectuer cette opération. Remplace le locataire sélectionné par défaut. Vous pouvez spécifier l’ID de locataire ou le nom du locataire. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
show-selected
Affiche les détails du locataire Azure Sphere par défaut pour l’utilisateur actuel sur ce PC.
Il s’agit du locataire sélectionné avec la commande azsphere tenant select.
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
mise à jour
Met à jour les détails d’un locataire, tels que le nom du locataire.
Paramètres obligatoires
| Paramètre | Type | Description |
|---|---|---|
| -n, --new-name | Chaîne | Spécifie un nouveau nom pour le locataire. Lorsque vous nommez votre client, utilisez des caractères alphanumériques. Les caractères spéciaux ne sont pas autorisés. Le nom ne doit pas dépasser 50 caractères et respecte la casse. |
Paramètres facultatifs
| Paramètre | Type | Description |
|---|---|---|
| -t, --tenant | GUID ou nom | Spécifie le locataire dans lequel effectuer cette opération. Remplace le locataire sélectionné par défaut. Vous pouvez spécifier l’ID de locataire ou le nom du locataire. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
Conseil
Si vous n’avez pas sélectionné un locataire par défaut, une liste de locataires disponibles s’affiche. Définissez votre locataire par défaut en sélectionnant l’une des options.