Configurer les paramètres globaux d’Azure PowerShell

  • Article

Azure PowerShell prend en charge plusieurs paramètres globaux tels que la désactivation des messages d’avertissement de changement cassant. Avant le module Az PowerShell version 9, il n’existait pas de moyen centralisé ou précis de configurer des paramètres généraux pour Azure PowerShell.

Configuration centralisée

Le module Az PowerShell version 9 et ultérieures comprend des applets de commande permettant de gérer la configuration des paramètres globaux pour Azure PowerShell. Ces applets de commande *-AzConfig font partie du module PowerShell Az.Accounts :

Paramètres précis

Vous pouvez appliquer des paramètres qui ne sont effectifs que dans une étendue particulière. Les valeurs valides pour le paramètre Scope sont :

  • Current User. Valeur par défaut lors de l’application d’un paramètre.
  • Process. Le paramètre est appliqué uniquement à la session PowerShell actuelle.
  • Default. Étendue en lecture seule où la valeur par défaut n’a pas été changée.
  • Environment. Étendue en lecture seule où la valeur a été configurée par le biais d’une variable d’environnement.

Outre les étendues, vous pouvez appliquer les paramètres à tous les modules Az PowerShell ou à un seul module. Avec le paramètre AppliesTo, vous pouvez spécifier l’étendue de l’application du paramètre. La valeur Az indique que le paramètre est appliqué à tous les modules disponibles qui font partie d’Azure PowerShell.

Pour désactiver le message d’avertissement de changement cassant pour les applets de commande dans le module Az.Compute, utilisez l’applet de commande Update-AzConfig avec les paramètres DisplayBreakingChangeWarning et AppliesTo, comme illustré dans l’exemple suivant.

Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo Az.Compute

Dans ce scénario, le message d’avertissement de changement cassant reste actif pour les applets de commande dans tous les modules Az PowerShell à l’exception d’Az.Compute.

Abonnement par défaut

Par défaut, quand vous vous authentifiez auprès d’Azure, tous les abonnements auxquels vous pouvez accéder sont récupérés. Le premier abonnement retourné par Azure est utilisé, sauf si vous spécifiez un abonnement avec Connect-AzAccount. Ce comportement peut être dangereux, par exemple si le premier abonnement retourné est un environnement de production.

Pour configurer votre abonnement par défaut, utilisez l’applet de commande Update-AzConfig avec le paramètre DefaultSubscriptionForLogin, comme illustré dans l’exemple suivant.

Update-AzConfig -DefaultSubscriptionForLogin <Subscription ID or Name>

Notes

La configuration DefaultSubscriptionForLogin prend uniquement effet lors de l’authentification auprès d’Azure (à ne pas confondre avec l’abonnement du contexte par défaut).

Notifications de mise à niveau

Les notifications dans l’outil pour les mises à niveau de version d’Azure PowerShell sont une fonctionnalité publiée dans le module Az PowerShell version 10.3.0. Quand une nouvelle version d’Azure PowerShell est disponible, une notification de mise à niveau s’affiche dans votre session PowerShell interactive.

Pour déterminer si les notifications de mise à niveau sont activées, utilisez l’applet de commande Get-AzConfig avec le paramètre CheckForUpgrade, comme illustré dans l’exemple suivant.

Get-AzConfig -CheckForUpgrade

Pour activer les notifications de mise à niveau pour Azure PowerShell, utilisez l’applet de commande Update-AzConfig avec le paramètre CheckForUpgrade défini sur $true, comme illustré dans l’exemple suivant.

Update-AzConfig -CheckForUpgrade $true

Pour désactiver les notifications de mise à niveau, utilisez l’applet de commande Update-AzConfig avec le paramètre CheckForUpgrade défini sur $false, comme illustré dans l’exemple suivant.

Update-AzConfig -CheckForUpgrade $false

Identification de la région Azure

Les clients Azure peuvent choisir de déployer des ressources dans de nombreuses régions différentes. Dans certains cas, les clients peuvent être en mesure de réduire les coûts en sélectionnant des régions voisines offrant les mêmes services. Si une région voisine est identifiée, un message affiche la région à sélectionner pour les déploiements futurs.

Désactivation du message de recommandation de région

Dans l’exemple suivant, la cmdlet Update-AzConfig est utilisée pour désactiver le message de recommandation de région :

Update-AzConfig -DisplayRegionIdentified $false

Pour plus d’informations sur les régions Azure, consultez Choisir la région Azure qui vous convient.

Réplication des paramètres

Pour répliquer vos paramètres d’un environnement à un autre, vous utilisez l’applet de commande Export-AzConfig afin d’exporter les paramètres dans un fichier JSON.

Export-AzConfig -Path $HOME\AzConfig.json

Pour importer vos paramètres, utilisez l’applet de commande Import-AzConfig et référencez le fichier JSON précédemment exporté.

Import-AzConfig -Path $HOME\AzConfig.json

Effacement de la configuration

Pour rétablir la configuration par défaut d’un ou de plusieurs paramètres globaux d’Azure PowerShell, utilisez l’applet de commande Clear-AzConfig. Dans l’exemple suivant, le paramètre DefaultSubscriptionForLogin est effacé.

Clear-AzConfig -DefaultSubscriptionForLogin