Visual Studio CodeでAzure CLIやAzure PowerShellを使用するための設定手順

2021-05-05Azure,Others,PowerShell/Azure CLI,VS Code

Visual Studio Code(VS Code)でAzure CLIやAzure PowerShellを使用するための設定手順です。
Windows環境でAzure CLIやAzure PowerShellをインストールし、利用します。

    • 主な手順
      • Azure CLI
        • WindowsへAzure CLIをインストール
        • Visual Studio CodeにAzure CLI Toolsをインストール
        • Visual Studio CodeでAzure CLIコマンドを実行し動作確認
      • Azure PowerShell
        • PowerShell 7のインストール
        • Visual Studio CodeでのPowerShellバージョンの切り替え
        • Azure PowerShellのインストール
        • Visual Studio CodeでAzure PowerShellコマンドレットを実行し動作確認
※手順の確認には、Windows 10を利用しています。

スポンサーリンク

Visual Studio CodeでAzure CLIを使用するための手順

Visual Studio Codeのセットアップ

Visual Studio Codeのセットアップ手順は、こちらで紹介しています。

WindowsにAzure CLIをインストール

WindowsにAzure CLIをインストールします。
いろいろなインストール方法がありますが、今回はMicrosoft インストーラーを利用した手順で進めています。

Azure CLIインストール手順

マイクロソフト社のAzure CLIのインストールサイトを開きます。

Azure CLI(マイクロソフト社サイト)

Windowsへのインストールのリンクを選択します。

インストールのページが表示されます。

インストールまたは更新

Azure CLIの最新バージョンを選択し、インストールファイルをダウンロードします。

インストールファイル(azure-cli-2.52.0-x64.msi)をダブルクリックしてインストールを開始します。

※記事記載時点での最新バージョンです。

ライセンス確認画面が表示されます。
I accept…にチェックを入れて、Installをクリックします。
Azure CLIのインストールが開始します。

インストール完了画面が表示されたら、Finishをクリックします。
WindowsへのAzure CLIインストールは完了です。

 

※Azure CLIのパスは自動的に追加されます。

Visual Studio CodeでAzure CLIコマンドを実行しインストールを確認

Visual Studio Code上でAzure CLIのコマンドを実行し、インストールを確認します。
Azureへのサインインを行い、Azure CLIコマンドが正常に利用できることを確認します。

Azure CLIコマンドを実行

メニューの"ターミナル"にある"新しいターミナル"を選択します。

 

ターミナル画面が表示されたら、"az login"と入力して実行します。

サインイン画面が表示されます。
Azure CLIコマンドが正常に実行できていることを確認できます。

※サインイン後は、ブラウザを閉じます。

Visual Studio CodeでAzure CLI Toolsをインストール

Visual Studio CodeでAzure CLIをより便利に利用するために、Azure CLI Toolsをインストールします。

Azure CLI Toolsインストール手順

左側にある拡張機能ボタンをクリックします。
“Azure CLI"と入力して検索すると、"Azure CLI Tools"が表示されます。Azure CLI Toolsでインストールを選択します。

 

Azure CLIコマンドをファイルとして保存し実行

Visual Studio Codeで、Azure CLIを使用してファイルの保存および実行ができるか確認します。

Azure CLIのファイル保存から実行まで

メニューの"ファイル"にある"新しいテキストファイル"を選択します。

 テキストに"az login"と入力します。

メニューの"ファイル"にある"名前を付けて保存"を選択します。Ctrl+Shift+Sでも同じ操作が可能です。

ファイルの種類で"Azure CLI Scrapbook"を選択し、ファイル名を付けて保存します。

※Azure CLI Toolsをインストールすると、ファイルの種類に"Azure CLI Scrapbook"が表示されるようになります。

メニューの"表示"にある"コマンドパレット"を選択します。
Ctrl+Shift+Pでもコマンドパレットを表示できます。

コマンドパレットで"Azure CLI"と入力します。
“Azure CLI: Run Line in Terminal"が表示されるので選択します。
ターミナルでAzure CLIのコマンドが実行されます。

※"Azure CLI: Run Line in Editor"でも同じ操作を実行できます。

Azure CLI:Run Line in Terminalを実行した場合

Azure CLI:Run Line in Editorを実行した場合

ポップアップでサインイン画面が表示されます。
Azureのアカウントでサインインします。

Azure CLI ScrapbookファイルをVisual Studio Codeで扱えることを確認できました。

※デバッグを行う場合は、デバッガの拡張機能を別途インストールする必要があります。

サインインに利用するAzure CLIコマンドは、こちらで紹介しています。

—広告—

PowerShell 7のインストールから利用するバージョンの切り替え手順(5→7)

既定のPowerShell バージョンを確認

Visual Studio Codeで既定のPowerShellバージョンを確認します。
$PSVersionTableでバージョンを確認します。

PowerShellのバージョンを確認

$PSVersionTableでPowerShellのバージョンを確認します。
多くのWindows環境ではデフォルトで5.1が選択されています。

※環境によっては7が既定のバージョンとなっていることもあります。
※記事記載時点のバージョンです。

# PowerShellのバージョン表示
PS C:\> $PSVersionTable

Wingetツールを使ったPowerShell 7のインストール手順

Wingetツールを使うと、Windows 10およびWindows 11でアプリケーションのインストールやアップグレード、削除などができます。

Winget ツールを使用したアプリケーションのインストールと管理

Wingetツールを使って、PowerShellをインストールできます。

Winget を使用して PowerShell をインストールする

インストーラーをダウンロードしてインストールすることも可能です。
GitHubから最新のPowerShellをダウンロードしてインストールします。

PowerShell/PowerShell

※PowerShellのバージョン5.1がアップデートされるわけではありません。5.1と7.3が共存した形になります。

Wingetツールを使ったPowerShellのインストール

インストールするPowerShellのバージョンを確認します。

 

# インストール対象のPowerShellのバージョン表示
PS C:\> winget search Microsoft.PowerShell

Wingetツールを使ってPowerShellをインストールします。
wingetを使った場合はコマンドラインのみで処理が進みます。

※msiインストーラーなどを使った場合と異なり、GUIの画面は表示されません。設定項目も表示されません。

 

# Wingetツールを使ってPowerShellインストール
PS C:\> winget install –id Microsoft.Powershell –source winget

Visual Studio CodeでPowerShellの拡張機能をインストール

Visual Studio CodeにPowerShellの拡張機能をインストールします。

PowerShellの拡張機能をインストール

左側にある拡張機能のボタンをクリックします。
“PowerShell"と入力して検索すると、PowerShellの拡張機能が表示されます。
インストールを選択します。

Visual Studio Codeで使用するPowerShellのバージョンを7に切り替える

PowerShell 7をインストールしても、Visual Studio Codeで使用されるPowerShellのバージョンは自動的には切り替わりません。
デフォルトでは既定のバージョンである5が利用されます。
手動で利用するPowerShellのバージョンを切り替える必要があります。

PowerShellのバージョンを7に切り替え

メニューの"表示"にある"コマンドパレット"を選択します。
Ctrl+Shift+Pでもコマンドパレットが表示されます。

“PowerShell: Show Session Menu"と入力して選択します。
使用するPowerShellのバージョンを選択できます。
インストールされている「PowerShell(x64)」を選択すると、バージョン7に切り替わります。

※必要に応じてVisual Studio Codeを再起動します。

“$PSVersionTable"で、PowerShellのバージョンを確認します。
バージョンが7.3.7に切り替わっていることを確認できます。

※記事記載時点での最新バージョンです。

 

# PowerShellのバージョン表示
PS C:\> $PSVersionTable

—広告—

Visual Studio CodeでAzure PowerShellを使うための手順

Azure PowerShellモジュール(Azモジュール)のインストール手順

PowerShellを使用してAzureのリソースを操作する場合は、Azure PowerShellモジュール(Azモジュール)を追加でインストールする必要があります。

Windows に Azure PowerShell をインストールする

Azure PowerShellをインストール

Azure PowerShellをインストールする前の確認設定作業です。

  • AzureRMモジュールがインストールされているかの確認
    インストールされている場合は、別途アンインストールなどの手順が必要
  • PowerShellの実行ポリシーを確認
    CurrentUserの実行ポリシーを"RemoteSigned"に変更してからインストールを実行

※インストール後は、PowerShellの実行ポリシーを元の設定に戻します

 

 

# AzureRMモジュールのインストール確認
PS C:\> Gallery -ForceGet-Module -Name AzureRM -ListAvailable

# PowerShellのポリシー確認(変更前)
PS C:\> Get-ExecutionPolicy -List

Scope ExecutionPolicy
—– —————
MachinePolicy Undefined
UserPolicy Undefined
Process Undefined
CurrentUser Undefined
LocalMachine RemoteSigned

# PowerShellのポリシー変更
PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

# PowerShellのポリシー確認(変更後)
PS C:\> Get-ExecutionPolicy -List

Scope ExecutionPolicy
—– —————
MachinePolicy Undefined
UserPolicy Undefined
Process Undefined
CurrentUser RemoteSigned
LocalMachine RemoteSigned

Visual Studio Codeのターミナルで、Azure PowerShellモジュールをインストールします。

 

# PowerShellのバージョン表示
PS C:\> Install-Module -Name Az -Repository PSGallery -Force

 

Visual Studio CodeでAzure PowerShellを実行し確認

Visual Studio CodeでAzure PowerShellを実行し、動作を確認します。
Azureへのサインインを例に確認します。

Azure PowerShellの確認

左側のメニューでPowerShellのアイコンを選択すると、PowerShellのコマンドレットが表示されます。
Connect-AzAccountの"Insert Command"を選択します。

※ターミナルに直接入力しても同じ動作になります。

メニューの"ファイル"から"名前を付けて保存"を選択します。Ctrl+Shift+Sでも同じ操作が可能です。

ファイルの種類で"PowerShell"を選択します。
ファイル名を付けてファイルを保存します。

メニューの"表示"にある"コマンドパレット"を選択します。
Ctrl+Shift+Pでもコマンドパレットを表示できます。

ファイルを開いた状態で"PowerShell: Run"と入力して選択します。
ターミナルでAzure PowerShellが実行されます。

 

ポップアップでサインイン画面が表示されるので、Azureのアカウントでサインインします。
Azure PowerShellをVisual Studio Codeで扱えることを確認できました。

Azure PowerShellを使ったサインイン方法は、こちらで紹介しています。

—広告—

最後に

Visual Studio CodeでAzure CLIやAzure PowerShellを使用するために必要な設定手順について確認しました。
PowerShell 7のインストールやバージョンの切り替え手順についても確認しています。
今回はAzureへのサインインを例に確認しましたが、Visual Studio Code上でさまざまなAzureリソースの操作も行えます。

引き続き、いろいろ試してみたいと思います。

Visual Studio Codeのインストールや日本語化の手順については、こちらで紹介しています。

スポンサーリンク

Azure,Others,PowerShell/Azure CLI,VS Code