az iot central user

  • Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.46.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande utilisateur centrale az iot. En savoir plus sur les extensions.

Gérez et configurez les utilisateurs IoT Central.

Commandes

Nom Description Type État
az iot central user create

Ajoutez un utilisateur à l’application.

 Extension GA
az iot central user delete

Supprimez un utilisateur de l’application.

 Extension GA
az iot central user list

Obtenir la liste des utilisateurs pour une application IoT Central.

 Extension GA
az iot central user show

Obtenez les détails d’un utilisateur par ID.

 Extension GA
az iot central user update

Mettez à jour les rôles d’un utilisateur dans l’application.

 Extension GA

az iot central user create

Ajoutez un utilisateur à l’application.

az iot central user create --app-id
                           --assignee
                           --role
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--org-id]
                           [--tenant-id]
                           [--token]

Exemples

Ajouter un utilisateur par e-mail à l’application

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

Ajouter un principal de service à l’application

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--assignee --user-id

ID associé à l’utilisateur.

--role -r

Rôle associé à ce jeton ou à cet utilisateur. Vous pouvez spécifier l’un des rôles intégrés ou spécifier l’ID de rôle d’un rôle personnalisé. Voir plus à https://aka.ms/iotcentral-customrolesdocs.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--email

Adresse e-mail de l’utilisateur à ajouter à l’application. Si cela est spécifié, les paramètres du principal de service (tenant_id et object_id) sont ignorés.

--object-id --oid

ID d’objet pour le principal de service à ajouter à l’application. L’ID de locataire doit également être spécifié. Si l’e-mail est spécifié, cela est ignoré et que l’utilisateur ne sera pas un utilisateur principal de service, mais un utilisateur « e-mail » standard.

--org-id --organization-id

ID de l’organisation pour l’attribution de rôle d’utilisateur. Disponible uniquement pour api-version == 1.1-preview.

--tenant-id --tnid

ID de locataire pour le principal de service à ajouter à l’application. L’ID d’objet doit également être spécifié. Si l’e-mail est spécifié, cela est ignoré et que l’utilisateur ne sera pas un utilisateur principal de service, mais un utilisateur « e-mail » standard.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central user delete

Supprimez un utilisateur de l’application.

az iot central user delete --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

Exemples

Suppression d’un utilisateur

az iot central user delete --app-id {appid} --user-id {userId}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--assignee --user-id

ID associé à l’utilisateur.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central user list

Obtenir la liste des utilisateurs pour une application IoT Central.

az iot central user list --app-id
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Exemples

Liste des utilisateurs

az iot central user list --app-id {appid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central user show

Obtenez les détails d’un utilisateur par ID.

az iot central user show --app-id
                         --assignee
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Exemples

Obtenir les détails de l’utilisateur

az iot central user show --app-id {appid} --user-id {userId}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--assignee --user-id

ID associé à l’utilisateur.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az iot central user update

Mettez à jour les rôles d’un utilisateur dans l’application.

Mettez à jour un utilisateur avec des rôles différents. La mise à jour de tenantId ou objectId pour un utilisateur de principal de service n’est pas autorisée. La mise à jour de l’adresse e-mail d’un utilisateur de messagerie n’est pas autorisée.

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

Exemples

Mettez à jour les rôles d’un utilisateur par e-mail ou par principal de service dans l’application.

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\admin"

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--assignee --user-id

ID associé à l’utilisateur.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--email

Adresse e-mail de l’utilisateur à ajouter à l’application. Si cela est spécifié, les paramètres du principal de service (tenant_id et object_id) sont ignorés.

--object-id --oid

ID d’objet pour le principal de service à ajouter à l’application. L’ID de locataire doit également être spécifié. Si l’e-mail est spécifié, cela est ignoré et que l’utilisateur ne sera pas un utilisateur principal de service, mais un utilisateur « e-mail » standard.

--roles

Liste séparée par des virgules des rôles qui seront associés à cet utilisateur. Vous pouvez spécifier l’un des rôles intégrés ou spécifier l’ID de rôle d’un rôle personnalisé. Voir plus à https://aka.ms/iotcentral-customrolesdocs. Les organisations peuvent être spécifiées en même temps que des rôles lors de l’exécution avec la version d’API == 1.1-preview. Par exemple, « organization_id\role ».

--tenant-id --tnid

ID de locataire pour le principal de service à ajouter à l’application. L’ID d’objet doit également être spécifié. Si l’e-mail est spécifié, cela est ignoré et que l’utilisateur ne sera pas un utilisateur principal de service, mais un utilisateur « e-mail » standard.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.