Partager via

az iot ops asset

  • Préversion
  • Référence

Remarque

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

Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Gérer les ressources.

Commandes

Nom Description Type État
az iot ops asset create

Créez un élément multimédia.

 Extension Aperçu
az iot ops asset data-point

Gérer les points de données dans une ressource.

 Extension Aperçu
az iot ops asset data-point add

Ajoutez un point de données à une ressource.

 Extension Aperçu
az iot ops asset data-point export

Exportez des points de données dans une ressource.

 Extension Aperçu
az iot ops asset data-point import

Importez des points de données dans une ressource.

 Extension Aperçu
az iot ops asset data-point list

Répertorier les points de données d’une ressource.

 Extension Aperçu
az iot ops asset data-point remove

Supprimez un point de données dans une ressource.

 Extension Aperçu
az iot ops asset delete

Supprimez une ressource.

 Extension Aperçu
az iot ops asset endpoint

Gérer les profils de point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint certificate

Gérer les certificats détenus dans un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint certificate add

Ajoutez un certificat appartenant à un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint certificate list

Répertoriez les certificats détenus dans un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint certificate remove

Supprimez un certificat appartenant à un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint create

Créez un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint delete

Supprimez un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint query

Interrogez Resource Graph pour les points de terminaison de ressources.

 Extension Aperçu
az iot ops asset endpoint show

Afficher un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset endpoint update

Mettez à jour un point de terminaison de ressource.

 Extension Aperçu
az iot ops asset event

Gérer les événements dans une ressource.

 Extension Aperçu
az iot ops asset event add

Ajoutez un événement à une ressource.

 Extension Aperçu
az iot ops asset event export

Exporter des événements dans une ressource.

 Extension Aperçu
az iot ops asset event import

Importer des événements dans une ressource.

 Extension Aperçu
az iot ops asset event list

Répertorier les événements d’une ressource.

 Extension Aperçu
az iot ops asset event remove

Supprimez un événement dans une ressource.

 Extension Aperçu
az iot ops asset query

Interrogez Resource Graph pour les ressources.

 Extension Aperçu
az iot ops asset show

Afficher une ressource.

 Extension Aperçu
az iot ops asset update

Mettez à jour une ressource.

 Extension Aperçu

az iot ops asset create

Préversion

Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez un élément multimédia.

Un emplacement personnalisé ou un nom de cluster doit être fourni. Cette commande vérifie l’existence de l’emplacement personnalisé et du cluster associés et vérifie que les deux sont correctement configurés avec l’extension microsoft.deviceregistry.assets.

Au moins un point de données ou un événement doit être défini lors de la création d’une ressource. Pour obtenir des exemples de formats de fichier, consultez aka.ms/aziotops-assets.

az iot ops asset create --endpoint
                        --name
                        --resource-group
                        [--asset-type]
                        [--attr]
                        [--cg]
                        [--cl]
                        [--clg]
                        [--cls]
                        [--cluster]
                        [--cluster-subscription]
                        [--data]
                        [--data-file]
                        [--data-publish-int]
                        [--data-queue-size]
                        [--data-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--ef]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--event]
                        [--hardware-revision]
                        [--location]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]

Exemples

Créez une ressource à l’aide de l’emplacement personnalisé donné.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --data data_source={data_source}

Créez une ressource à l’aide de l’emplacement personnalisé et du groupe de ressources donnés pour l’emplacement personnalisé. Le groupe de ressources doit être inclus s’il existe plusieurs emplacements personnalisés portant le même nom dans un abonnement.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --custom-location-resource-group {custom_location_resource_group} --endpoint {endpoint} --data data_source={data_source}

Créez une ressource à l’aide du nom de cluster donné. Le groupe de ressources doit être inclus s’il existe plusieurs clusters portant le même nom dans un abonnement.

az iot ops asset create --name {asset_name} -g {resource_group} --cluster {cluster} --cluster-resource-group {cluster_resource_group} --endpoint {endpoint} --event event_notifier={event_notifier}

Créez une ressource à l’aide du nom de cluster donné et de l’emplacement personnalisé.

az iot ops asset create --name {asset_name} -g {resource_group} --cluster {cluster} --custom-location {custom_location} --endpoint {endpoint} --event event_notifier={event_notifier}

Créez une ressource avec des valeurs par défaut de point de données et d’événement personnalisés.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --data-publish-int {data_point_publishing_interval} --data-queue-size {data_point_queue_size} --data-sample-int {data_point_sampling_interval} --event-publish-int {event_publishing_interval} --event-queue-size {event_queue_size} --event-sample-int {event_sampling_interval} --event event_notifier={event_notifier}

Créez une ressource avec des attributs personnalisés supplémentaires.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --custom-attribute {attribute_key}={attribute_value} --custom-attribute {attribute_key}={attribute_value}

Créez une ressource avec un type de ressource personnalisé, une description, un URI de documentation, un ID de ressource externe, une révision matérielle, un code de produit et une révision logicielle.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --asset-type {asset_type} --description {description} --documentation-uri {documentation_uri} --external-asset-id {external_asset_id} --hardware-revision {hardware_revision} --product-code {product_code} --software-revision {software_revision} --data data_source={data_source}

Créez une ressource avec deux événements, le fabricant, l’URI du fabricant, le modèle, le numéro de série.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --event capability_id={capability_id} event_notifier={event_notifier} name={name} observability_mode={observability_mode} sampling_interval={sampling_interval} queue_size={queue_size} --event event_notifier={event_notifier} --manufacturer {manufacturer} --manufacturer-uri {manufacturer_uri} --model {model} --serial-number {serial_number}

Créez une ressource désactivée avec deux points de données.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --disable --data capability_id={capability_id} data_source={data_source} name={name} observability_mode={observability_mode} sampling_interval={sampling_interval} queue_size={queue_size} --data data_source={data_source}

Créez une ressource à l’aide d’un fichier contenant des points de données et un autre fichier contenant des événements.

az iot ops asset create --name MyAsset -g MyRg --custom-location MyLocation --endpoint exampleEndpoint --data-file /path/to/myasset_datapoints.json --event-file /path/to/myasset_events.csv

Créez une ressource avec les valeurs préremplies données.

az iot ops asset create --name MyAsset -g MyRg --custom-location MyLocation --endpoint exampleEndpoint --data capability_id=myTagId data_source=NodeID1 name=myTagName1 observability_mode=counter sampling_interval=10 queue_size=2 --data data_source=NodeID2 --data-publish-int 1000 --data-queue-size 1 --data-sample-int 30 --asset-type customAsset --description 'Description for a test asset.' --documentation-uri www.help.com --external-asset-id 000-000-0000 --hardware-revision 10.0 --product-code XXX100 --software-revision 0.1 --manufacturer Contoso --manufacturer-uri constoso.com --model AssetModel --serial-number 000-000-ABC10 --custom-attribute work_location=factory

Paramètres obligatoires

--endpoint

Nom du point de terminaison de ressource.

--name -n

Nom de la ressource.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--asset-type --at

Type de ressource.

--attr --custom-attribute

Paires clé=valeur séparées par espace correspondant à des attributs personnalisés supplémentaires pour la ressource.

--cg --cluster-resource-group

Groupe de ressources pour le cluster.

--cl --custom-location

Emplacement personnalisé utilisé pour associer une ressource au cluster.

--clg --custom-location-resource-group

Groupe de ressources pour l’emplacement personnalisé.

--cls --custom-location-subscription

ID d’abonnement pour l’emplacement personnalisé. S’il n’est pas fourni, l’ID d’abonnement aux ressources est utilisé.

--cluster -c

Cluster à associer à la ressource.

--cluster-subscription --cs

ID d’abonnement pour le cluster. S’il n’est pas fourni, l’ID d’abonnement aux ressources est utilisé.

--data

Paires clé=valeur séparées par l’espace correspondant aux propriétés du point de données à créer. Les valeurs de clé suivantes sont prises en charge : capability_id, data_source (obligatoire), name( observability_mode aucun, jauge, compteur, histogramme ou journal), (int), sampling_interval queue_size (int). --les données peuvent être utilisées 1 ou plusieurs fois. Passez en revue les exemples d’aide pour une utilisation complète des paramètres.

--data-file --df

Chemin d’accès du fichier contenant les points de données. Les types de fichiers suivants sont pris en charge : csv, json, portal-csv, yaml.

--data-publish-int --dpi

Intervalle de publication par défaut pour les points de données.

Valeur par défaut: 1000
--data-queue-size --dqs

Taille de file d’attente par défaut pour les points de données.

Valeur par défaut: 1
--data-sample-int --dsi

Intervalle d’échantillonnage par défaut (en millisecondes) pour les points de données.

Valeur par défaut: 500
--description -d

La description.

--disable

Désactivez une ressource.

Valeurs acceptées: false, true
Valeur par défaut: False
--display-name --dn

Nom d’affichage.

--documentation-uri --du

URI de documentation.

--eai --external-asset-id

ID de ressource externe.

--ef --event-file

Chemin d’accès du fichier contenant les événements. Les types de fichiers suivants sont pris en charge : csv, json, portal-csv, yaml.

--epi --event-publish-int

Intervalle de publication par défaut pour les événements.

Valeur par défaut: 1000
--eqs --event-queue-size

Taille de file d’attente par défaut pour les événements.

Valeur par défaut: 1
--esi --event-sample-int

Intervalle d’échantillonnage par défaut (en millisecondes) pour les événements.

Valeur par défaut: 500
--event

Paires clé=valeur séparées par l’espace correspondant aux propriétés de l’événement à créer. Les valeurs de clé suivantes sont prises en charge : capability_id, (obligatoire), nameobservability_mode (aucun ou journal), (int), sampling_interval queue_size (int event_notifier ). --event peut être utilisé 1 ou plusieurs fois. Passez en revue les exemples d’aide pour une utilisation complète des paramètres.

--hardware-revision --hr

Révision matérielle.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--manufacturer

Fabricant.

--manufacturer-uri --mu

URI du fabricant.

--model

Modèle.

--pc --product-code

Code de produit.

--serial-number --sn

Numéro de série

--software-revision --sr

Révision logicielle.

--tags

Balises de ressource d’élément multimédia. Conteneur de propriétés dans des paires clé-valeur au format suivant : a=b c=d.

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 ops asset delete

Préversion

Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez une ressource.

az iot ops asset delete --name
                        --resource-group

Exemples

Supprimez une ressource.

az iot ops asset delete --name {asset_name} -g {resource_group}

Paramètres obligatoires

--name -n

Nom de la ressource.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

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 ops asset query

Préversion

Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Interrogez Resource Graph pour les ressources.

az iot ops asset query [--asset-type]
                       [--cl]
                       [--description]
                       [--disabled {false, true}]
                       [--display-name]
                       [--documentation-uri]
                       [--eai]
                       [--endpoint]
                       [--hardware-revision]
                       [--location]
                       [--manufacturer]
                       [--manufacturer-uri]
                       [--model]
                       [--pc]
                       [--resource-group]
                       [--serial-number]
                       [--software-revision]

Exemples

Recherchez les ressources désactivées dans un groupe de ressources donné.

az iot ops asset query -g {resource_group} --disabled

Recherchez les ressources qui ont le modèle, le fabricant et le numéro de série donnés.

az iot ops asset query --model {model} --manufacturer {manufacturer} --serial-number {serial_number}

Paramètres facultatifs

--asset-type --at

Type de ressource.

--cl --custom-location

Emplacement personnalisé utilisé pour associer une ressource au cluster.

--description -d

La description.

--disabled

État de la ressource.

Valeurs acceptées: false, true
--display-name --dn

Nom d’affichage.

--documentation-uri --du

URI de documentation.

--eai --external-asset-id

ID de ressource externe.

--endpoint

Nom du point de terminaison de ressource.

--hardware-revision --hr

Révision matérielle.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--manufacturer

Fabricant.

--manufacturer-uri --mu

URI du fabricant.

--model

Modèle.

--pc --product-code

Code de produit.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--serial-number --sn

Numéro de série

--software-revision --sr

Révision logicielle.

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 ops asset show

Préversion

Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Afficher une ressource.

az iot ops asset show --name
                      --resource-group

Exemples

Afficher les détails d’une ressource.

az iot ops asset show --name {asset_name} -g {resource_group}

Paramètres obligatoires

--name -n

Nom de la ressource.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

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 ops asset update

Préversion

Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour une ressource.

Pour mettre à jour les points de données et les événements, utilisez respectivement les groupes de commandes az iot ops asset data-point az iot ops asset events .

az iot ops asset update --name
                        --resource-group
                        [--asset-type]
                        [--attr]
                        [--data-publish-int]
                        [--data-queue-size]
                        [--data-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--hardware-revision]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]

Exemples

Mettez à jour les valeurs par défaut du point de données et des événements d’une ressource.

az iot ops asset update --name {asset_name} -g {resource_group} --data-publish-int {data_point_publishing_interval} --data-queue-size {data_point_queue_size} --data-sample-int {data_point_sampling_interval} --event-publish-int {event_publishing_interval} --event-queue-size {event_queue_size} --event-sample-int {event_sampling_interval}

Mettez à jour le type de ressource, la description, l’URI de documentation, l’ID de ressource externe, la révision matérielle, le code produit et la révision logicielle.

az iot ops asset update --name {asset_name} -g {resource_group} --asset-type {asset_type} --description {description} --documentation-uri {documentation_uri} --external-asset-id {external_asset_id} --hardware-revision {hardware_revision} --product-code {product_code} --software-revision {software_revision}

Mettez à jour le fabricant, l’URI du fabricant, le modèle, le numéro de série et l’attribut personnalisé d’une ressource.

az iot ops asset update --name {asset_name} -g {resource_group} --manufacturer {manufacturer} --manufacturer-uri {manufacturer_uri} --model {model} --serial-number {serial_number} --custom-attribute {attribute_key}={attribute_value}

Désactivez une ressource et supprimez un attribut personnalisé appelé « work_site ».

az iot ops asset update --name {asset_name} -g {resource_group} --disable --custom-attribute work_site=""

Paramètres obligatoires

--name -n

Nom de la ressource.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--asset-type --at

Type de ressource.

--attr --custom-attribute

Paires clé=valeur séparées par espace correspondant à des attributs personnalisés supplémentaires pour la ressource. Pour supprimer un attribut personnalisé, définissez la valeur de l’attribut sur « ».

--data-publish-int --dpi

Intervalle de publication par défaut pour les points de données.

--data-queue-size --dqs

Taille de file d’attente par défaut pour les points de données.

--data-sample-int --dsi

Intervalle d’échantillonnage par défaut (en millisecondes) pour les points de données.

--description -d

La description.

--disable

Désactivez une ressource.

Valeurs acceptées: false, true
--display-name --dn

Nom d’affichage.

--documentation-uri --du

URI de documentation.

--eai --external-asset-id

ID de ressource externe.

--epi --event-publish-int

Intervalle de publication par défaut pour les événements.

--eqs --event-queue-size

Taille de file d’attente par défaut pour les événements.

--esi --event-sample-int

Intervalle d’échantillonnage par défaut (en millisecondes) pour les événements.

--hardware-revision --hr

Révision matérielle.

--manufacturer

Fabricant.

--manufacturer-uri --mu

URI du fabricant.

--model

Modèle.

--pc --product-code

Code de produit.

--serial-number --sn

Numéro de série

--software-revision --sr

Révision logicielle.

--tags

Balises de ressource d’élément multimédia. Conteneur de propriétés dans des paires clé-valeur au format suivant : a=b c=d.

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.