az aksarc

  • Référence

Remarque

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

Gérer les clusters provisionnés.

Commandes

Nom Description Type Statut
az aksarc create

Crée le cluster provisionné.

 Extension GA
az aksarc delete

Supprime le cluster provisionné.

 Extension GA
az aksarc get-credentials

Obtenez kubeconfig local du cluster approvisionné.

 Extension GA
az aksarc get-upgrades

Obtenez les versions de mise à niveau disponibles pour le cluster approvisionné.

 Extension GA
az aksarc get-versions

Répertoriez les versions de Kubernetes prises en charge dans l’emplacement personnalisé spécifié.

 Extension GA
az aksarc list

Répertorie les clusters provisionnés dans un groupe de ressources ou dans un abonnement.

 Extension GA
az aksarc logs

Collectez les journaux d’activité à partir de clusters provisionnés.

 Extension GA
az aksarc logs hci

Collectez les journaux d’activité à partir de clusters provisionnés dans l’environnement HCI.

 Extension GA
az aksarc nodepool

Gérer les pools de nœuds dans un cluster approvisionné.

 Extension GA
az aksarc nodepool add

Ajoute un pool de nœuds dans le cluster approvisionné.

 Extension GA
az aksarc nodepool delete

Supprime le pool de nœuds dans le cluster provisionné.

 Extension GA
az aksarc nodepool list

Répertorie tous les pools de nœuds dans le cluster approvisionné.

 Extension GA
az aksarc nodepool scale

Met à l’échelle le pool de nœuds dans le cluster approvisionné.

 Extension GA
az aksarc nodepool show

Obtient le pool de nœuds dans le cluster provisionné.

 Extension GA
az aksarc nodepool update

Mettez à jour un pool de nœuds dans le cluster approvisionné.

 Extension GA
az aksarc notice

Fichier NOTICE de sortie vers le chemin de fichier spécifié par l’utilisateur.

 Extension GA
az aksarc release

Gérer les images de disque dur virtuel pour les clusters provisionnés.

 Extension Aperçu
az aksarc release download

Télécharge les images de disque dur virtuel à partir d’une version.

 Extension Aperçu
az aksarc release save

Provisionne les images de disque dur virtuel téléchargées sur le pont de ressources arc.

 Extension Aperçu
az aksarc show

Obtient le cluster provisionné.

 Extension GA
az aksarc update

Mises à jour le cluster approvisionné.

 Extension GA
az aksarc upgrade

Met à niveau le cluster provisionné.

 Extension GA
az aksarc vmsize

Gérer les références SKU de machine virtuelle pour les clusters provisionnés.

 Extension GA
az aksarc vmsize list

Répertorie les tailles de machine virtuelle prises en charge dans l’emplacement personnalisé spécifié.

 Extension GA
az aksarc vnet

Gérer les réseaux virtuels pour les clusters provisionnés.

 Extension GA
az aksarc vnet create

crée le réseau virtuel.

 Extension GA
az aksarc vnet delete

Supprime le réseau virtuel.

 Extension GA
az aksarc vnet list

Répertorie les réseaux virtuels par groupe de ressources ou abonnement.

 Extension GA
az aksarc vnet show

Obtient le réseau virtuel.

 Extension GA

az aksarc create

Crée le cluster provisionné.

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--generate-ssh-keys]
                 [--kubernetes-version]
                 [--load-balancer-count]
                 [--location]
                 [--max-count]
                 [--max-pods]
                 [--min-count]
                 [--no-wait]
                 [--node-count]
                 [--node-vm-size]
                 [--nodepool-labels]
                 [--nodepool-taints]
                 [--pod-cidr]
                 [--ssh-auth-ips]
                 [--ssh-key-value]
                 [--tags]

Exemples

PutProvisionedCluster

az aksarc create -g sample-rg --custom-location sample-cl -n sample-aksarccluster --vnet-ids "vnet-arm-id"

Paramètres obligatoires

--custom-location

Nom ou ID de l’emplacement personnalisé à utiliser pour le cluster approvisionné.

--name -n

Nom du cluster provisionné.

--resource-group -g

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

--vnet-id --vnet-ids

ID de ressource ARM du réseau virtuel aksarc ou du réseau logique Azure Stack HCI.

Paramètres facultatifs

--aad-admin-group-object-ids -i

Liste séparée par des virgules d’ID d’objet de groupe aad qui sera définie en tant qu’administrateur de cluster sur le cluster approvisionné.

--ca-profile --cluster-autoscaler-profile

Liste séparée par l’espace des paires clé=valeur pour la configuration de l’autoscaler de cluster. Transmettez une chaîne vide pour effacer le profil.

--control-plane-count --control-plane-node-count

Nombre de nœuds de plan de contrôle.

--control-plane-ip

\Kubernetes APIServer IPAddress. L’adresse IP doit être routable à partir de la machine virtuelle Azure Resource Bridge Appliance. Il doit faire partie du sous-réseau réseau référencé. Excluez-le des ippools pour éviter les doublons. La création du cluster peut échouer ou expiration si une adresse IP non routable est passée.

--control-plane-vm-size

Taille de machine virtuelle du plan de contrôle.

--disable-nfs-driver

Désactivez le pilote NFS pour le cluster approvisionné.

valeur par défaut: False
--disable-smb-driver

Désactivez le pilote S Mo pour le cluster approvisionné.

valeur par défaut: False
--enable-ahub

Activez Azure Hybrid User Benefits (AHUB) pour le cluster approvisionné.

valeur par défaut: False
--enable-azure-rbac

Activez Azure RBAC pour contrôler les case activée d’autorisation sur le cluster.

valeur par défaut: False
--enable-cluster-autoscaler -e

Activez le scaler automatique du cluster pour le cluster approvisionné.

valeur par défaut: False
--generate-ssh-keys

Générez une paire de clés SSH s’il n’est pas présent.

valeur par défaut: False
--kubernetes-version -k

Version kubernetes du cluster approvisionné.

--load-balancer-count

Nombre de nœuds d’équilibreur de charge.

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

--max-count

Nombre maximal de nœuds pour la mise à l’échelle automatique.

--max-pods -m

Nombre maximal de pods qui peuvent s’exécuter sur un nœud.

--min-count

Nombre minimal de nœuds pour la mise à l’échelle automatique.

--no-wait

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

valeur par défaut: False
--node-count -c

Nombre de nœuds à créer dans le pool de nœuds.

valeur par défaut: 1
--node-vm-size

Taille de machine virtuelle des nœuds dans le pool de nœuds.

--nodepool-labels

Étiquettes séparées par l’espace : key[=value] [key[=value] ...].

--nodepool-taints

Liste séparée par des virgules des teintes nodepool.

--pod-cidr

Les plages d’adresses IP de notation CIDR à partir desquelles attribuer des adresses IP de pod.

--ssh-auth-ips --ssh-authorized-ip-ranges

Liste séparée par des virgules d’adresses IP ou CIDR autorisées à ssh sur la machine virtuelle du cluster.

--ssh-key-value

Chemin d’accès à la clé publique SSH à injecter dans le plan de contrôle.

valeur par défaut: ~\.ssh\id_rsa.pub
--tags

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

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

Supprime le cluster provisionné.

az aksarc delete --name
                 --resource-group
                 [--no-wait]
                 [--yes]

Exemples

DeleteProvisionedCluster

az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"

Paramètres obligatoires

--name -n

Nom du cluster provisionné.

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

--no-wait

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

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

Ne pas demander 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 aksarc get-credentials

Obtenez kubeconfig local du cluster approvisionné.

az aksarc get-credentials --name
                          --resource-group
                          [--admin]
                          [--context]
                          [--file]
                          [--overwrite-existing]

Exemples

Get Administration Credential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg" --admin

GetAADUserCredential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg"

Paramètres obligatoires

--name -n

Nom du cluster provisionné.

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

--admin -a

Obtenez les informations d’identification de l’administrateur de cluster.

valeur par défaut: False
--context

Si elle est spécifiée, remplacez le nom de contexte par défaut.

--file -f

Fichier de configuration Kubernetes à mettre à jour. S’il n’est pas fourni, met à jour le fichier « ~/.kube/config ».

valeur par défaut: ~\.kube\config
--overwrite-existing

Remplacez toute entrée de cluster existante portant le même nom.

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 aksarc get-upgrades

Obtenez les versions de mise à niveau disponibles pour le cluster approvisionné.

az aksarc get-upgrades --name
                       --resource-group

Exemples

Obtenir les versions de mise à niveau disponibles pour le cluster provisionné AKS hybride

az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"

Paramètres obligatoires

--name -n

Nom du cluster provisionné.

--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 aksarc get-versions

Répertoriez les versions de Kubernetes prises en charge dans l’emplacement personnalisé spécifié.

az aksarc get-versions --custom-location
                       [--resource-group]

Exemples

VMListSkus

az aksarc get-versions -g sample-rg --custom-location sample-cl

Paramètres obligatoires

--custom-location

Nom de l’emplacement personnalisé à utiliser pour afficher les versions de k8s prises en charge.

Paramètres facultatifs

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

Répertorie les clusters provisionnés dans un groupe de ressources ou dans un abonnement.

az aksarc list [--resource-group]

Exemples

ListProvisionedClusterByResourceGroup

az aksarc list --resource-group "sample-rg"

ListProvisionedClusterBySubscription

az aksarc list

Paramètres facultatifs

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

Fichier NOTICE de sortie vers le chemin de fichier spécifié par l’utilisateur.

az aksarc notice --output-filepath

Exemples

GetNoticeFile

az aksarc notice --output-filepath "./Notice"

Paramètres obligatoires

--output-filepath

Chemin de fichier de sortie du fichier NOTICE.

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

Obtient le cluster provisionné.

az aksarc show --name
               --resource-group

Exemples

GetProvisionedCluster

az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"

Paramètres obligatoires

--name -n

Nom du cluster provisionné.

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

Mises à jour le cluster approvisionné.

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--disable-ahub]
                 [--disable-cluster-autoscaler]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-cluster-autoscaler]
                 [--enable-nfs-driver]
                 [--enable-smb-driver]
                 [--max-count]
                 [--min-count]
                 [--tags]
                 [--update-cluster-autoscaler]

Exemples

UpdateProvisionedCluster

az aksarc update --tags additionalProperties="sample" --name "sample-aksarccluster" --resource-group "sample-rg"

Activez la fonctionnalité Avantages utilisateur hybrides Azure pour un cluster approvisionné.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --enable-ahub

Désactivez la fonctionnalité Avantages utilisateur hybrides Azure pour un cluster approvisionné.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg"--disable-ahub

Monter en puissance les nœuds du plan de contrôle.

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --control-plane-node-count 5

Paramètres obligatoires

--name -n

Nom du cluster provisionné.

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

--aad-admin-group-object-ids -i

Liste séparée par des virgules d’ID d’objet de groupe aad qui sera définie en tant qu’administrateur de cluster sur le cluster approvisionné.

--ca-profile --cluster-autoscaler-profile

Liste séparée par l’espace des paires clé=valeur pour la configuration de l’autoscaler de cluster. Transmettez une chaîne vide pour effacer le profil.

--control-plane-count --control-plane-node-count

Nombre de nœuds vers lesquels mettre à l’échelle le plan de contrôle.

--disable-ahub

Désactivez Azure Hybrid User Benefits (AHUB) pour le cluster approvisionné.

valeur par défaut: False
--disable-cluster-autoscaler -d

Désactivez le scaler automatique du cluster pour le cluster approvisionné.

valeur par défaut: False
--disable-nfs-driver

Désactivez le pilote NFS pour le cluster approvisionné.

valeur par défaut: False
--disable-smb-driver

Désactivez le pilote S Mo pour le cluster approvisionné.

valeur par défaut: False
--enable-ahub

Activez Azure Hybrid User Benefits (AHUB) pour le cluster approvisionné.

valeur par défaut: False
--enable-cluster-autoscaler -e

Activez le scaler automatique du cluster pour le cluster approvisionné.

valeur par défaut: False
--enable-nfs-driver

Activez le pilote NFS pour le cluster approvisionné.

valeur par défaut: False
--enable-smb-driver

Activez le pilote S Mo pour le cluster approvisionné.

valeur par défaut: False
--max-count

Nombre maximal de nœuds pour la mise à l’échelle automatique.

--min-count

Nombre minimal de nœuds pour la mise à l’échelle automatique.

--tags

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

--update-cluster-autoscaler -u

Mettez à jour le scaler automatique du cluster pour le cluster approvisionné.

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

Met à niveau le cluster provisionné.

az aksarc upgrade --name
                  --resource-group
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

Exemples

UpgradeProvisionedCluster

az aksarc upgrade --name "sample-aksarccluster" --resource-group "sample-rg" --kubernetes-version "1.22.2"

Paramètres obligatoires

--name -n

Nom du cluster provisionné.

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

--kubernetes-version -k

Version kubernetes du cluster approvisionné.

--no-wait

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

valeur par défaut: False
--yes

Indicateur pour désactiver 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.