az k8s-extension

  • Référence

Remarque

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

Commandes pour gérer les extensions Kubernetes.

Commandes

Nom Description Type Statut
az k8s-extension create

Créez une extension de cluster Kubernetes, y compris l’achat d’une offre d’extension à partir de Place de marché Azure (AKS uniquement). Reportez-vous à l’exemple à la fin pour voir comment créer une extension ou acheter une offre d’extension.

 Extension GA
az k8s-extension delete

Supprimez une extension Kubernetes.

 Extension GA
az k8s-extension extension-types

Commandes permettant de découvrir les types d’extensions Kubernetes.

 Extension Aperçu
az k8s-extension extension-types list

Répertoriez les types d’extension de cluster disponibles pour un cluster existant.

 Extension Préversion et dépréciation
az k8s-extension extension-types list-by-cluster

Répertoriez les types d’extension de cluster disponibles pour un cluster existant. Les propriétés utilisées pour le filtrage incluent le type de cluster (géré, connecté, etc.), la version kubernetes, l’emplacement du cluster.

 Extension Aperçu
az k8s-extension extension-types list-by-location

Répertoriez les types d’extensions de cluster disponibles dans une région.

 Extension Aperçu
az k8s-extension extension-types list-versions

Répertorier les versions disponibles pour un type d’extension de cluster pour un cluster donné.

 Extension Préversion et dépréciation
az k8s-extension extension-types list-versions-by-cluster

Répertorier les versions disponibles pour un type d’extension de cluster pour un cluster donné. Les propriétés utilisées pour le filtrage incluent le type de cluster (géré, connecté, etc.), la version kubernetes, l’emplacement du cluster.

 Extension Aperçu
az k8s-extension extension-types list-versions-by-location

Répertorier les versions disponibles d’une version de type d’extension de cluster dans une région.

 Extension Aperçu
az k8s-extension extension-types show

Obtenir les propriétés d’un type d’extension de cluster dans une région.

 Extension Préversion et dépréciation
az k8s-extension extension-types show-by-cluster

Afficher les propriétés d’un type d’extension de cluster pour un cluster existant. Les propriétés utilisées pour le filtrage incluent le type de cluster (géré, connecté, etc.), la version kubernetes, l’emplacement du cluster.

 Extension Aperçu
az k8s-extension extension-types show-by-location

Afficher les propriétés d’un type d’extension de cluster dans une région.

 Extension Aperçu
az k8s-extension extension-types show-version-by-cluster

Afficher les propriétés associées à une version de type d’extension de cluster pour un cluster existant. Les propriétés utilisées pour le filtrage incluent le type de cluster (géré, connecté, etc.), la version kubernetes, l’emplacement du cluster.

 Extension Aperçu
az k8s-extension extension-types show-version-by-location

Afficher les propriétés associées à une version de type d’extension de cluster dans une région.

 Extension Aperçu
az k8s-extension list

Répertorier les extensions Kubernetes.

 Extension GA
az k8s-extension show

Afficher une extension Kubernetes.

 Extension GA
az k8s-extension update

Mettez à jour les propriétés mutables d’une extension Kubernetes.

 Extension GA

az k8s-extension create

Créez une extension de cluster Kubernetes, y compris l’achat d’une offre d’extension à partir de Place de marché Azure (AKS uniquement). Reportez-vous à l’exemple à la fin pour voir comment créer une extension ou acheter une offre d’extension.

Créez une extension Kubernetes. La sortie inclut des secrets que vous devez protéger. Veillez à ne pas inclure ces secrets dans votre contrôle de code source. Vérifiez également qu’aucun secret n’est présent dans les journaux de votre commande ou script. Pour plus d'informations, consultez http://aka.ms/clisecrets.

az k8s-extension create --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --extension-type
                        --name
                        --resource-group
                        [--auto-upgrade {false, true}]
                        [--cluster-resource-provider]
                        [--config]
                        [--config-file]
                        [--config-protected]
                        [--config-protected-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--plan-name]
                        [--plan-product]
                        [--plan-publisher]
                        [--release-namespace]
                        [--release-train]
                        [--scope {cluster, namespace}]
                        [--target-namespace]
                        [--version]

Exemples

Créer une extension Kubernetes

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --extension-type microsoft.openservicemesh --scope cluster --release-train stable

Créer une extension de la Place de marché Kubernetes

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type managedClusters --name myextension --extension-type Contoso.AzureVoteKubernetesAppTest --scope cluster --release-train stable --plan-name testplan --plan-product kubernetest_apps_demo_offer --plan-publisher test_test_mix3pptest0011614206850774

Paramètres obligatoires

--cluster-name -c

Nom du cluster Kubernetes.

--cluster-type -t

Spécifiez des clusters Arc ou des clusters managés AKS ou des appliances Arc ou provisionnéClusters.

valeurs acceptées: appliances, connectedClusters, managedClusters, provisionedClusters
--extension-type

Nom du type d’extension.

--name -n

Nom de l’instance d’extension.

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

--auto-upgrade --auto-upgrade-minor-version

Mettez automatiquement à niveau la version mineure de l’instance d’extension.

valeurs acceptées: false, true
--cluster-resource-provider --cluster-rp

Nom du fournisseur de ressources de cluster pour ce clusterType (requis pour provisionedClusters).

--config --configuration-settings

Configuration Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. N’utilisez pas cette option pour les secrets, car cette valeur est retournée en réponse.

--config-file --config-settings-file

Chemin d’accès au fichier JSON pour les paramètres de configuration.

--config-protected --config-protected-settings

Configuration Protected Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. Seule la clé est retournée en réponse, la valeur n’est pas.

--config-protected-file --config-protected-settings-file

Chemin d’accès au fichier JSON pour les paramètres protégés par la configuration.

--config-settings
Déprécié

L’option « --config-settings » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --configuration-settings ».

Configuration Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. N’utilisez pas cette option pour les secrets, car cette valeur est retournée en réponse.

--configuration-protected-settings
Déprécié

L’option « --configuration-protected-settings » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --config-protected-settings ».

Configuration Protected Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. Seule la clé est retournée en réponse, la valeur n’est pas.

--configuration-protected-settings-file
Déprécié

L’option « --configuration-protected-settings-file » a été déconseillée et sera supprimée dans une version ultérieure. Utilisez plutôt « --config-protected-file ».

Chemin d’accès au fichier JSON pour les paramètres protégés par la configuration.

--configuration-settings-file
Déprécié

L’option « --configuration-settings-file » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --config-settings-file ».

Chemin d’accès au fichier JSON pour les paramètres de configuration.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--plan-name

Le nom du plan fait référence à l’ID de plan de l’extension qui est extraite du portail de la Place de marché sous Informations d’utilisation + Support.

--plan-product

Le produit de plan fait référence à l’ID de produit de l’extension qui est extraite du portail de la Place de marché sous Informations d’utilisation + Support. Le nom de l’offre ISV utilisée en est un exemple.

--plan-publisher

L’éditeur de plan fait référence à l’ID du serveur de publication de l’extension qui est extraite du portail de la Place de marché sous Informations d’utilisation + Support.

--release-namespace

Spécifiez l’espace de noms pour installer la version de l’extension.

--release-train

Spécifiez le train de mise en production pour le type d’extension.

--scope

Spécifiez l’étendue de l’extension.

valeurs acceptées: cluster, namespace
--target-namespace

Spécifiez l’espace de noms cible à installer pour l’instance d’extension. Ce paramètre est requis si l’étendue de l’extension est définie sur « espace de noms ».

--version

Spécifiez la version à installer pour l’instance d’extension si --auto-upgrade-minor-version n’est pas activée.

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 k8s-extension delete

Supprimez une extension Kubernetes.

az k8s-extension delete --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--cluster-resource-provider]
                        [--force]
                        [--no-wait]
                        [--yes]

Exemples

Supprimer une extension Kubernetes existante

az k8s-extension delete --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

Paramètres obligatoires

--cluster-name -c

Nom du cluster Kubernetes.

--cluster-type -t

Spécifiez des clusters Arc ou des clusters managés AKS ou des appliances Arc ou provisionnéClusters.

valeurs acceptées: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

Nom de l’instance d’extension.

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

--cluster-resource-provider --cluster-rp

Nom du fournisseur de ressources de cluster pour ce clusterType (requis pour provisionedClusters).

--force

Spécifiez s’il faut forcer la suppression de l’extension du cluster.

valeur par défaut: False
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--yes -y

Ignorez les invites de confirmation.

valeur par défaut: False
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 k8s-extension list

Répertorier les extensions Kubernetes.

Répertoriez toutes les extensions Kubernetes dans un cluster, y compris leurs propriétés. La sortie inclut des secrets que vous devez protéger. Veillez à ne pas inclure ces secrets dans votre contrôle de code source. Vérifiez également qu’aucun secret n’est présent dans les journaux de votre commande ou script. Pour plus d'informations, consultez http://aka.ms/clisecrets.

az k8s-extension list --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --resource-group
                      [--cluster-resource-provider]

Exemples

Répertorier toutes les extensions Kubernetes sur un cluster

az k8s-extension list --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters

Paramètres obligatoires

--cluster-name -c

Nom du cluster Kubernetes.

--cluster-type -t

Spécifiez des clusters Arc ou des clusters managés AKS ou des appliances Arc ou provisionnéClusters.

valeurs acceptées: appliances, connectedClusters, managedClusters, provisionedClusters
--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

--cluster-resource-provider --cluster-rp

Nom du fournisseur de ressources de cluster pour ce clusterType (requis pour provisionedClusters).

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 k8s-extension show

Afficher une extension Kubernetes.

Afficher une extension Kubernetes, y compris ses propriétés. La sortie inclut des secrets que vous devez protéger. Veillez à ne pas inclure ces secrets dans votre contrôle de code source. Vérifiez également qu’aucun secret n’est présent dans les journaux de votre commande ou script. Pour plus d'informations, consultez http://aka.ms/clisecrets.

az k8s-extension show --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --name
                      --resource-group
                      [--cluster-resource-provider]

Exemples

Afficher les détails d’une extension Kubernetes

az k8s-extension show --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

Paramètres obligatoires

--cluster-name -c

Nom du cluster Kubernetes.

--cluster-type -t

Spécifiez des clusters Arc ou des clusters managés AKS ou des appliances Arc ou provisionnéClusters.

valeurs acceptées: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

Nom de l’instance d’extension.

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

--cluster-resource-provider --cluster-rp

Nom du fournisseur de ressources de cluster pour ce clusterType (requis pour provisionedClusters).

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 k8s-extension update

Mettez à jour les propriétés mutables d’une extension Kubernetes.

Pour la mise à jour vers Config Paramètres et ConfigProtected Paramètres, reportez-vous à la documentation du service d’extension de cluster pour case activée mettre à jour ces propriétés est prise en charge avant de mettre à jour ces propriétés. La sortie inclut des secrets que vous devez protéger. Veillez à ne pas inclure ces secrets dans votre contrôle de code source. Vérifiez également qu’aucun secret n’est présent dans les journaux de votre commande ou script. Pour plus d'informations, consultez http://aka.ms/clisecrets.

az k8s-extension update --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--auto-upgrade {false, true}]
                        [--cluster-resource-provider]
                        [--config]
                        [--config-file]
                        [--config-protected]
                        [--config-protected-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--release-train]
                        [--version]
                        [--yes]

Exemples

Mettre à jour une extension Kubernetes

az k8s-extension update --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --auto-upgrade true/false --version extension-version --release-train stable --configuration-settings settings-key=settings-value --config-protected-settings protected-settings-key=protected-value --config-settings-file=config-settings-file --config-protected-file=protected-settings-file

Paramètres obligatoires

--cluster-name -c

Nom du cluster Kubernetes.

--cluster-type -t

Spécifiez des clusters Arc ou des clusters managés AKS ou des appliances Arc ou provisionnéClusters.

valeurs acceptées: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

Nom de l’instance d’extension.

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

--auto-upgrade --auto-upgrade-minor-version

Mettez automatiquement à niveau la version mineure de l’instance d’extension.

valeurs acceptées: false, true
--cluster-resource-provider --cluster-rp

Nom du fournisseur de ressources de cluster pour ce clusterType (requis pour provisionedClusters).

--config --configuration-settings

Configuration Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. N’utilisez pas cette option pour les secrets, car cette valeur est retournée en réponse.

--config-file --config-settings-file

Chemin d’accès au fichier JSON pour les paramètres de configuration.

--config-protected --config-protected-settings

Configuration Protected Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. Seule la clé est retournée en réponse, la valeur n’est pas.

--config-protected-file --config-protected-settings-file

Chemin d’accès au fichier JSON pour les paramètres protégés par la configuration.

--config-settings
Déprécié

L’option « --config-settings » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --configuration-settings ».

Configuration Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. N’utilisez pas cette option pour les secrets, car cette valeur est retournée en réponse.

--configuration-protected-settings
Déprécié

L’option « --configuration-protected-settings » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --config-protected-settings ».

Configuration Protected Paramètres en tant que paire clé=valeur. Répétez le paramètre pour chaque paramètre. Seule la clé est retournée en réponse, la valeur n’est pas.

--configuration-protected-settings-file
Déprécié

L’option « --configuration-protected-settings-file » a été déconseillée et sera supprimée dans une version ultérieure. Utilisez plutôt « --config-protected-file ».

Chemin d’accès au fichier JSON pour les paramètres protégés par la configuration.

--configuration-settings-file
Déprécié

L’option « --configuration-settings-file » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --config-settings-file ».

Chemin d’accès au fichier JSON pour les paramètres de configuration.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--release-train

Spécifiez le train de mise en production pour le type d’extension.

--version

Spécifiez la version à installer pour l’instance d’extension si --auto-upgrade-minor-version n’est pas activée.

--yes -y

Ignorez les invites de confirmation.

valeur par défaut: False
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.