AzureRM から Az への Azure PowerShell の移行

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

AzureRM PowerShell モジュールを使用しているかどうかを確認する

次のコマンドを使用して、AzureRM PowerShell モジュールがインストールされているかどうかを確認します。

Get-Module -Name AzureRM -ListAvailable

また、スクリプトのフルテキスト検索を実行してパターン *-AzureRM* を探し、それらのいずれかで AzureRM PowerShell モジュールを使用しているかどうかを判断することもできます。

Az PowerShell モジュールを更新する

AzureRM コマンドレット用に記述されたスクリプトは、Az で自動的に機能するわけではありません。 移行を容易にするために、AzureRM to Az Migration Toolkit が開発されました。 新しいコマンド セットへの移行がないに越したことはありませんが、この記事は、Az PowerShell モジュールへの切り替えを開始する際に役立ちます。 Az PowerShell モジュールが作成された理由の詳細については、「Az PowerShell モジュールの概要」を参照してください。

新しいコマンドレット名は、覚えやすいように設計されています。 コマンドレット名では AzureRmAzure を使用する代わりに、Az を使用します。 たとえば、古いコマンドレット New-AzureRMVmNew-AzVm になりました。 ただし、移行は新しいコマンドレット名に慣れることだけではありません。 モジュールやパラメーターの名前の変更や、その他の重要な変更があります。

AzureRM と Az の間の重大な変更の詳細な一覧については、AzureRM から Az への詳細な変更を参照してください。

既存のスクリプトが AzureRM の最新リリースで機能することを確認する

移行手順を実行する前に、システムにインストールされている AzureRM のバージョンを確認してください。 これにより、スクリプトが最新のリリースで既に実行中であることを確認し、アンインストールする必要のある AzureRM のバージョンを把握することができます。

インストールされている AzureRM のバージョンを確認するには、次の例を実行します。

Get-Module -Name AzureRM -ListAvailable -All

AzureRM の最新の一般公開リリースは 6.13.2 です。 このバージョンがインストールされていない場合、既存のスクリプトでは、この記事と破壊的変更の一覧で説明している範囲以外に、Az モジュールを操作するための追加の変更が必要になる場合があります。

スクリプトが AzureRM 6.13.2 で機能しない場合は、AzureRM 5.x から 6.x への移行ガイドに従ってそれらを更新します。 以前のバージョンの AzureRM モジュールを使用している場合は、各メジャー バージョン用に利用できる移行ガイドがあります。

この推奨オプションを選択すると、AzureRM スクリプトを Az に移行するために必要な労力が最小限に抑えられます。

AzureRM to Az Migration Toolkit を使用すると、スクリプトに対して実行される変更を決定するためのプランを生成してから、それらに対して変更を加え、Az PowerShell モジュールをインストールすることができます。

AzureRM から Az PowerShell モジュールに PowerShell スクリプトを自動的に移行する」のクイックスタートでは、PowerShell スクリプトを AzureRM から Az PowerShell モジュールに自動的に更新するプロセス全体について説明します。

オプション 2:Enable-AzureRmAlias で互換モードを使用する

Az モジュールには互換モードがあり、既存のスクリプトを使用しながら、新しい構文に更新することができます。 Enable-AzureRmAlias コマンドレットは、エイリアスを使用して互換モードを有効にします。 このモードでは、Az への完全な移行に向けた作業において、最小限の変更で既存のスクリプトを使用できます。 既定では、Enable-AzureRmAlias によって、現在の PowerShell セッション用の互換性のあるエイリアスが有効になるだけです。 PowerShell セッション間で互換性のあるエイリアスを保持するには、Scope パラメーターを使用してください。 詳細については、Enable-AzureRmAlias のリファレンス ドキュメントを参照してください。

重要

コマンドレット名がエイリアス化されているとしても、Az コマンドレットの新しい (または名前が変更された) パラメーターや変更された戻り値はまだ残っている可能性があります。 エイリアスを有効にすることで移行が完了するわけではありません。 スクリプトの更新が必要になる可能性のある変更については、重大な変更の詳細な一覧を参照してください。

AzureRM PowerShell モジュールの廃止により、Enable-AzureRmAlias のサポートは非推奨になりません。

次のステップ