az iot ops connector template

Note

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

Gestion des modèles de connecteur.

Les modèles de connecteur fournissent une approche standardisée basée sur les métadonnées pour le déploiement du connecteur. Les modèles sont créés à partir de références de métadonnées de connecteur (MCR pour les connecteurs tiers, ACR pour les connecteurs tiers), remplit automatiquement la configuration spécifique au connecteur tout en autorisant la personnalisation des paramètres de déploiement par l’utilisateur.

Commandes

Nom Description Type État
az iot ops connector template create

Créez un modèle de connecteur.

 Extension GA
az iot ops connector template delete

Supprimez un modèle de connecteur.

 Extension GA
az iot ops connector template list

Répertorier tous les modèles de connecteur.

 Extension GA
az iot ops connector template show

Afficher un modèle de connecteur.

 Extension GA
az iot ops connector template update

Mettez à jour un modèle de connecteur existant.

 Extension GA

az iot ops connector template create

Créez un modèle de connecteur.

Crée un modèle de connecteur à partir de métadonnées stockées dans un registre de conteneurs. Les métadonnées remplissent automatiquement les paramètres spécifiques au connecteur, tandis que les paramètres de déploiement tels que les réplicas, les niveaux de journal et les secrets peuvent être personnalisés.

az iot ops connector template create --connector-metadata-ref --ref
                                     --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Exemples

Créez un modèle pour le connecteur REST avec les paramètres par défaut.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6

Créez un modèle avec une configuration personnalisée.

az iot ops connector template create --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.6 --replicas 3 --log-level debug --image-pull-secrets acr-credentials

Créez un modèle pour le connecteur tiers à partir d’ACR privé.

az iot ops connector template create --name custom-plc-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref contoso.azurecr.io/connectors/plc-metadata:1.0.0 --image-pull-secrets acr-pull-secret

Paramètres obligatoires

--connector-metadata-ref --ref

URL vers l’artefact de métadonnées du connecteur à partir du registre de conteneurs.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom du modèle.

--resource-group -g

Groupe de ressources d’instance.

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.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--allocation-policy --ap

Stratégie d’allocation de points de terminaison d’appareil entre les instances de connecteur (sans respect de la casse). Options : compartimentées. Si elle n’est pas fournie, aucune stratégie d’allocation n’est définie.

--bs --bucket-size

Nombre de points de terminaison par compartiment d’instance de connecteur. Obligatoire lorsque la stratégie d’allocation est « compartimentée ».

--cc --connector-config

Configurations clé-valeur propres au connecteur séparés par l’espace. Format : key=value. Peut fournir plusieurs valeurs dans un appel ou utiliser plusieurs fois. Exemples : --cc brokerAddress=mqtt ://broker :1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt ://broker :1883 --cc qos=1 --cc keepAlive=60. Utilisez « » pour effacer les configurations existantes.

--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--image-pull-policy --ipp

Stratégie d’extraction d’images Kubernetes. Options : Always, IfNotPresent, Never.

--image-pull-secrets --ips

Noms de secrets Kubernetes séparés par l’espace pour extraire des images conteneur à partir de registres privés. Pour les connecteurs tiers utilisant un registre de conteneurs privé, fournissez les secrets contenant les informations d’identification du Registre pour permettre au pod de connecteur d’extraire l’image. Utilisez « » pour effacer les secrets d’extraction d’images existants.

--ll --log-level

Niveau de journal pour les pods de connecteur. Options : trace, débogage, informations, avertissement, erreur. Valeur par défaut : informations.

--replicas -r

Nombre de réplicas de pod de connecteur à déployer. La valeur par défaut est extraite de recommendedReplicas dans les métadonnées, ou 1 s’il n’est pas spécifié.

--secrets

Secrets d’application de connecteur séparés par l’espace à monter au format key=value. Chaque secret nécessite trois champs : secretRef (nom du secret à monter), secretKey (clé dans le secret à monter) et secretAlias (alias d’application). Exemple : secretRef=mySecret secretKey=password secretAlias=dbPassword. Peut être utilisé plusieurs fois pour définir plusieurs secrets. Le secretRef doit référencer un secret synchronisé via la classe de fournisseur de secrets. Utilisez « » pour effacer les secrets existants.

--storage-volumes --sv

Référence de revendication de volume persistant séparée par l’espace au format clé=valeur. Clés requises : claimName (nom du PVC existant), mountPath (chemin de montage dans le conteneur). Exemple : claimName=myPVC mountPath=/data. Utilisez « » pour effacer les volumes de stockage existants.

--trust-settings-secret-ref --tssr

Informations de référence sur les secrets pour les certificats à approuver. Cela spécifie le nom du secret Kubernetes contenant des certificats d’autorité de certification approuvés. Utilisez « » pour effacer les paramètres d’approbation existants.

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 en utilisant 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 connector template delete

Supprimez un modèle de connecteur.

Supprime un modèle de connecteur. Valide si le modèle est actuellement utilisé par les connecteurs déployés et demande une confirmation, sauf si --oui est fourni.

az iot ops connector template delete --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--yes {false, true}]

Exemples

Supprimez le modèle à l’aide de l’invite de confirmation.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Supprimez le modèle sans confirmation.

az iot ops connector template delete --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --yes

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom du modèle.

--resource-group -g

Groupe de ressources d’instance.

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.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--yes -y

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

Propriété Valeur
Valeur par défaut: False
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 en utilisant 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 connector template list

Répertorier tous les modèles de connecteur.

Répertorie tous les modèles de connecteur pour une instance de Opérations Azure IoT spécifique avec des informations récapitulatives, notamment le nom du modèle, le type de connecteur, la version, les réplicas et les dates de création/modification.

az iot ops connector template list --instance
                                   --resource-group

Exemples

Répertoriez tous les modèles d’une instance.

az iot ops connector template list --resource-group myResourceGroup --instance myAIOInstance

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--resource-group -g

Groupe de ressources d’instance.

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 en utilisant 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 connector template show

Afficher un modèle de connecteur.

Affiche la configuration complète du modèle, notamment les métadonnées, les informations du connecteur, la configuration de l’image, les paramètres de déploiement, la configuration storage et les paramètres de sécurité.

az iot ops connector template show --instance
                                   --name
                                   --resource-group

Exemples

Afficher les détails du modèle au format JSON.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance

Afficher le modèle au format de tableau.

az iot ops connector template show --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --output table

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom du modèle.

--resource-group -g

Groupe de ressources d’instance.

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 en utilisant 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 connector template update

Mettez à jour un modèle de connecteur existant.

Met à jour un modèle de connecteur. Les paramètres de déploiement tels que les réplicas, les niveaux de journal, les secrets, les paramètres d’extraction d’image et les paramètres d’approbation peuvent être modifiés. Les métadonnées du connecteur peuvent être mises à jour uniquement pour corriger ou mettre à niveau des versions mineures. Les mises à jour de version majeure nécessitent la création d’un modèle.

az iot ops connector template update --instance
                                     --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--allocation-policy --ap]
                                     [--bs --bucket-size]
                                     [--cc --connector-config]
                                     [--change-reference]
                                     [--connector-metadata-ref --ref]
                                     [--image-pull-policy --ipp]
                                     [--image-pull-secrets --ips]
                                     [--ll --log-level]
                                     [--replicas]
                                     [--secrets]
                                     [--storage-volumes --sv]
                                     [--trust-settings-secret-ref --tssr]

Exemples

Mettez à jour le nombre de réplicas et le niveau du journal.

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --replicas 5 --log-level debug

Effectuez une mise à jour vers une version corrective plus récente du connecteur.

az iot ops connector template update --name my-rest-template --resource-group myResourceGroup --instance myAIOInstance --connector-metadata-ref mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:1.0.7

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom du modèle.

--resource-group -g

Groupe de ressources d’instance.

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.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--allocation-policy --ap

Stratégie d’allocation de points de terminaison d’appareil entre les instances de connecteur (sans respect de la casse). Options : compartimentées. Si elle n’est pas fournie, aucune stratégie d’allocation n’est définie.

--bs --bucket-size

Nombre de points de terminaison par compartiment d’instance de connecteur. Obligatoire lorsque la stratégie d’allocation est « compartimentée ».

--cc --connector-config

Configurations clé-valeur propres au connecteur séparés par l’espace. Format : key=value. Peut fournir plusieurs valeurs dans un appel ou utiliser plusieurs fois. Exemples : --cc brokerAddress=mqtt ://broker :1883 qos=1 keepAlive=60 OR --cc brokerAddress=mqtt ://broker :1883 --cc qos=1 --cc keepAlive=60. Utilisez « » pour effacer les configurations existantes.

--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--connector-metadata-ref --ref

URL vers l’artefact de métadonnées du connecteur à partir du registre de conteneurs.

            1st-party connectors (MCR):
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/rest-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/media-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/mqtt-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/sse-metadata:VERSION`
            - `mcr.microsoft.com/azureiotoperations/akri-connectors/onvif-metadata:VERSION`

            3rd-party connectors:
            - `REGISTRY.azurecr.io/PATH-metadata:VERSION`

            To list available versions for 1st-party connectors:
            `curl https://mcr.microsoft.com/v2/azureiotoperations/akri-connectors/TYPE-metadata/tags/list`.
--image-pull-policy --ipp

Stratégie d’extraction d’images Kubernetes. Options : Always, IfNotPresent, Never.

--image-pull-secrets --ips

Noms de secrets Kubernetes séparés par l’espace pour extraire des images conteneur à partir de registres privés. Pour les connecteurs tiers utilisant un registre de conteneurs privé, fournissez les secrets contenant les informations d’identification du Registre pour permettre au pod de connecteur d’extraire l’image. Utilisez « » pour effacer les secrets d’extraction d’images existants.

--ll --log-level

Niveau de journal pour les pods de connecteur. Options : trace, débogage, informations, avertissement, erreur. Valeur par défaut : informations.

--replicas -r

Nombre de réplicas de pod de connecteur à déployer. La valeur par défaut est extraite de recommendedReplicas dans les métadonnées, ou 1 s’il n’est pas spécifié.

--secrets

Secrets d’application de connecteur séparés par l’espace à monter au format key=value. Chaque secret nécessite trois champs : secretRef (nom du secret à monter), secretKey (clé dans le secret à monter) et secretAlias (alias d’application). Exemple : secretRef=mySecret secretKey=password secretAlias=dbPassword. Peut être utilisé plusieurs fois pour définir plusieurs secrets. Le secretRef doit référencer un secret synchronisé via la classe de fournisseur de secrets. Utilisez « » pour effacer les secrets existants.

--storage-volumes --sv

Référence de revendication de volume persistant séparée par l’espace au format clé=valeur. Clés requises : claimName (nom du PVC existant), mountPath (chemin de montage dans le conteneur). Exemple : claimName=myPVC mountPath=/data. Utilisez « » pour effacer les volumes de stockage existants.

--trust-settings-secret-ref --tssr

Informations de référence sur les secrets pour les certificats à approuver. Cela spécifie le nom du secret Kubernetes contenant des certificats d’autorité de certification approuvés. Utilisez « » pour effacer les paramètres d’approbation existants.

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 en utilisant 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