Partager via

az iot ops schema

Note

Cette référence fait partie de l’extension azure-iot-ops pour Azure CLI (version 2.67.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de schéma az iot ops. Apprenez-en davantage sur les extensions.

Registre de schémas et gestion des schémas.

Les schémas sont des documents qui décrivent les données pour permettre le traitement et la contextualisation. Les schémas de message décrivent le format d’un message et son contenu. Un registre de schémas est requis pour créer et gérer des schémas.

Commandes

Nom Description Type État
az iot ops schema create

Créez un schéma dans un registre de schémas.

 Extension GA
az iot ops schema delete

Supprimez un schéma cible dans un registre de schémas.

 Extension GA
az iot ops schema list

Répertorier les schémas dans un registre de schémas.

 Extension GA
az iot ops schema registry

Gestion du Registre de schémas.

 Extension GA
az iot ops schema registry create

Créer un registre de schémas

 Extension GA
az iot ops schema registry delete

Supprimez un registre de schémas cible.

 Extension GA
az iot ops schema registry list

Répertorier les registres de schémas dans un groupe de ressources ou un abonnement.

 Extension GA
az iot ops schema registry show

Afficher les détails d’un registre de schémas.

 Extension GA
az iot ops schema show

Afficher les détails d’un schéma dans un registre de schémas.

 Extension GA
az iot ops schema show-dataflow-refs

Afficher les références de schéma utilisées pour les flux de données.

 Extension Experimental
az iot ops schema version

Gestion des versions de schéma.

 Extension GA
az iot ops schema version add

Ajoutez une version de schéma à un schéma.

 Extension GA
az iot ops schema version list

Répertorier les versions de schéma d’un schéma spécifique.

 Extension GA
az iot ops schema version remove

Supprimez une version de schéma cible.

 Extension GA
az iot ops schema version show

Afficher les détails d’une version de schéma.

 Extension GA

az iot ops schema create

Créez un schéma dans un registre de schémas.

Cette opération nécessite un registre de schémas précréé et ajoute une version de schéma. Pour créer le schéma et ajouter une version, le compte de stockage associé doit avoir un accès réseau public activé. Pour plus d’informations sur le format de fichier delta, consultez aka.ms/lakehouse-delta-sample.

az iot ops schema create --format {delta, json}
                         --name
                         --registry
                         --resource-group
                         --type {message}
                         --vc --version-content
                         [--desc]
                         [--display-name]
                         [--vd --version-desc]
                         [--ver --version]

Exemples

Créez un schéma appelé « myschema » dans le registre « myregistry » avec des entrées minimales. La version 1 du schéma sera créée pour ce schéma avec le contenu du fichier.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json

Créez un schéma appelé « myschema » avec une personnalisation supplémentaire. La version 14 du schéma sera créée pour ce schéma. Le contenu inline est un exemple de syntaxe bash. Pour plus d’exemples, consultez https://aka.ms/inline-json-examples

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format delta --type message --desc "Schema for Assets" --display-name myassetschema --version-content '{"hello": "world"}' --ver 14 --vd "14th version"

Paramètres obligatoires

--format

Format de schéma.

Propriété Valeur
Valeurs acceptées: delta, json
--name -n

Nom du schéma.

--registry

Nom du registre de schémas.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--type

Type de schéma.

Propriété Valeur
Valeurs acceptées: message
--vc --version-content

Chemin d’accès de fichier contenant ou contenu inline pour la version.

Propriété Valeur
Groupe de paramètres: Version Arguments

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--desc

Description du schéma.

--display-name

Nom complet du schéma.

--vd --version-desc

Description de la version.

Propriété Valeur
Groupe de paramètres: Version Arguments
--ver --version

Nom de la version du schéma.

Propriété Valeur
Groupe de paramètres: Version Arguments
Valeur par défaut: 1
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot ops schema delete

Supprimez un schéma cible dans un registre de schémas.

az iot ops schema delete --name
                         --registry
                         --resource-group
                         [--yes {false, true}]

Exemples

Supprimez un schéma cible « myschema » dans un registre de schémas « myregistry ».

az iot ops schema delete --name myschema --registry myregistry -g myresourcegroup

Paramètres obligatoires

--name -n

Nom du schéma.

--registry

Nom du registre de schémas.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--yes -y

Confirmez [y]es sans invite. Utile pour les scénarios CI et Automation.

Propriété Valeur
Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot ops schema list

Répertorier les schémas dans un registre de schémas.

az iot ops schema list --registry
                       --resource-group

Exemples

Répertoriez les registres de schémas dans le registre de schémas « myregistry ».

az iot ops schema list -g myresourcegroup --registry myregistry

Paramètres obligatoires

--registry

Nom du registre de schémas.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot ops schema show

Afficher les détails d’un schéma dans un registre de schémas.

az iot ops schema show --name
                       --registry
                       --resource-group

Exemples

Affichez les détails du schéma cible « myschema » dans un registre de schémas « myregistry ».

az iot ops schema show --name myschema --registry myregistry -g myresourcegroup

Paramètres obligatoires

--name -n

Nom du schéma.

--registry

Nom du registre de schémas.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot ops schema show-dataflow-refs

Expérimental

Cette commande est expérimentale et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Afficher les références de schéma utilisées pour les flux de données.

az iot ops schema show-dataflow-refs --registry
                                     --resource-group
                                     [--latest {false, true}]
                                     [--schema]
                                     [--ver --version]

Exemples

Afficher la référence de schéma pour le schéma « myschema » et la version 1.

az iot ops schema show-dataflow-refs --version 1 --schema myschema --registry myregistry -g myresourcegroup

Afficher la référence de schéma pour toutes les versions du schéma « myschema ».

az iot ops schema show-dataflow-refs --schema myschema --registry myregistry -g myresourcegroup

Afficher la référence de schéma pour toutes les versions et schémas dans le registre de schémas « myregistry ».

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup

Afficher la référence de schéma pour tous les schémas, mais uniquement les dernières versions du registre de schémas « myregistry ».

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup --latest

Paramètres obligatoires

--registry

Nom du registre de schémas.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--latest

Indicateur pour afficher uniquement la ou les dernières versions.

Propriété Valeur
Valeurs acceptées: false, true
--schema

Nom du schéma. Obligatoire si vous utilisez --version.

--ver --version

Nom de la version du schéma. Si elle est utilisée, --latest est ignoré.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False