Partager via

az iot ops schema registry

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 registre de schémas az iot ops. Apprenez-en davantage sur les extensions.

Gestion du Registre de schémas.

Un registre de schémas est un référentiel centralisé pour la gestion des schémas. Le registre de schémas permet la génération et la récupération de schémas à la fois à la périphérie et dans le cloud. Il garantit la cohérence et la compatibilité entre les systèmes en fournissant une source unique de vérité pour les définitions de schéma.

Commandes

Nom Description Type État
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 registry create

Créer un registre de schémas

Cette opération crée un registre de schémas avec l’identité managée système activée.

Il affecte ensuite l’identité système au rôle intégré « Contributeur aux données blob du stockage » par défaut sur l’étendue du conteneur du compte de stockage. Si nécessaire, vous pouvez fournir un rôle personnalisé via --custom-role-id à utiliser à la place.

Si le conteneur de compte de stockage indiqué n’existe pas, il est créé avec les paramètres par défaut.

Cette opération inscrit également le fournisseur de ressources Microsoft.DeviceRegistry s’il n’est pas inscrit.

az iot ops schema registry create --name
                                  --registry-namespace --rn
                                  --resource-group
                                  --sa-resource-id
                                  [--custom-role-id]
                                  [--desc]
                                  [--display-name]
                                  [--location]
                                  [--sa-container]
                                  [--skip-ra {false, true}]
                                  [--tags]

Exemples

Créez un registre de schémas appelé « myregistry » avec des entrées minimales.

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID

Créez un registre de schémas appelé « myregistry » dans la région westus2 avec une personnalisation supplémentaire.

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID --sa-container myschemacontainer -l westus2 --desc 'Contoso factory X1 schemas' --display-name 'Contoso X1' --tags env=prod

Paramètres obligatoires

--name -n

Nom du registre de schémas.

--registry-namespace --rn

Espace de noms du Registre de schémas. Identifie de manière unique un registre de schémas au sein d’un locataire.

--resource-group -g

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

--sa-resource-id

ID de ressource du compte de stockage à utiliser avec le registre de schémas.

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.

--custom-role-id

ID de définition de rôle complet au format suivant : /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.

Propriété Valeur
Groupe de paramètres: Role Assignment Arguments
--desc

Description du registre de schémas.

--display-name

Nom complet du registre de schémas.

--location -l

Région pour créer le registre de schémas. Si aucun emplacement n’est fourni, l’emplacement du groupe de ressources sera utilisé.

--sa-container

Nom du conteneur de compte de stockage dans lequel les schémas seront stockés.

Propriété Valeur
Valeur par défaut: schemas
--skip-ra

Lorsqu’elle est utilisée, l’étape d’attribution de rôle de l’opération est ignorée.

Propriété Valeur
Groupe de paramètres: Role Assignment Arguments
Valeurs acceptées: false, true
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

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 registry delete

Supprimez un registre de schémas cible.

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

Exemples

Supprimez le registre de schémas « myregistry ».

az iot ops schema registry delete -n myregistry -g myresourcegroup

Paramètres obligatoires

--name -n

Nom du registre de schémas.

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.

--resource-group -g

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

--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 registry list

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

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

Exemples

Répertoriez les registres de schémas dans le groupe de ressources « myresourcegroup ».

az iot ops schema registry list -g myresourcegroup

Répertoriez les registres de schémas dans le filtrage par défaut de l’abonnement sur une balise particulière.

az iot ops schema registry list --query "[?tags.env == 'prod']"

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.

--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 registry show

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

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

Exemples

Affichez les détails du registre de schémas cibles « myregistry ».

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

Paramètres obligatoires

--name -n

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