Azure CLIやAzure PowerShellをVisual Studio Codeで使う

2021-05-05Azure,VS Code

Visual Studio Code(VS Code)でAzure CLIやAzure PowerShellを使う為の設定手順纏めです。

    • 主な手順
      • Azure CLI
        • WindowsへAzure CLIをインストール
        • Azure CLIの拡張機能をVisual Studio Code(VS Code)にインストール
        • Visual Studio Code(VS Code)でAzure CLIを実行
      • Azure PowerShell
        • PowerShellのインストール(アップデート)
        • Visual Studio Code(VS Code)のPowerShellバージョン切り替え
        • Azure PowerShellのインストール
        • Visual Studio Code(VS Code)でAzure PowerShellを実行

※Windows10を利用して確認しています。
※2023年9月に加筆修正しています。

スポンサーリンク

Visual Studio Code(VSCode)でAzure CLIを使う

Visual Studio Code(VSCode)のセットアップ

Visual Studio Code(VSCode)のセットアップ手順はこちらの記事に纏めています。

Windows10にAzure CLIをインストール

Azure CLIをWindowsにインストールします。

Azure CLIインストール手順

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

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

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

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

インストールまたは更新

インストールまたは更新にあるAzure CLIの最新リソースを選択して、インストールファイルをダウンロードします。

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

※2023年9月現在の最新バージョンです。

ライセンス確認画面です。
I accept…にチェックを入れてInstallを開始します。

※特に設定項目はありません。

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

※Azure CLIのパスは自動的に追加されます。パスを追加しなくても実行できます。

Azure CLIコマンドを実行

Visual Studio Code(VS Code)上でAzure CLIのコマンドを実行します。
Azureへのサインインで確認します。

Azure CLIコマンドを実行

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

 

ターミナルの画面が表示されます。
az loginと入力し実行します。

サインイン画面が表示されます。
Azure CLIコマンドが実行出来ている事が確認出来ます。

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

Azure CLI Toolsの拡張機能をインストール

Visual Studio Code(VSCode)に拡張機能(Azure CLI Tools)をインストールします。

Azure CLI Toolsインストール手順

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

 

Azure CLIのファイルを保存、実行

Azure CLIのファイル保存、実行できるかを確認します。
az loginでAzureへサインインします。

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(VSCode)で扱える事を確認出来ました。

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

Azure CLIでのサインイン方法についてはこちらに纏めています。
併せて見て頂けると有難いです。

——

PowerShell7のインストールからバージョンを切り替え

PowerShellのバージョン確認

Visual Studio Code(VSCode)でPowerShellバージョンを確認します。

PowerShellバージョン確認

$PSVersionTableでPowerShellのバージョンを確認します。
デフォルトでは5.1がインストールされています。

※2023年9月現在の情報です。

#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のインストールします。

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

 

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

Visual Studio Code(VSCode)で使うPowerShellのバージョンを7に切り替える

PowerShell7をインストールしただけではVisual Studio Code(VSCode)で利用されるPowerShellのバージョンは切り替わりません。
PowerShellのバージョンは5のままになっています。
切り替える必要があります。

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

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

PowerShell: Show Session Menuと入力選択します。
利用するPowerShellのバージョンを選択できます。
PowerShell(x64)を選択すると7に切り替わります。

 

 

$PSVersionTableでPowerShellのバージョンを確認します。
7.3.7に切り替わっている事が確認出来ます。

※2023年9月現在の情報です。

 

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

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

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

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

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

Visual Studio Code(VSCode)でAzure PowerShellを使う

Azure PowerShellをインストール

Azure PowerShellのモジュールを追加インストールが必要になります。

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

※Visual Studio Code拡張機能ではなくPowerShellのモジュールインストールになります。

Azure PowerShellインストール

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

  • AzureRMモジュールのインストール確認
    インストールされている場合は別途手順が必要です。
  • PowerShellのポリシー確認、変更
    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(VS Code)のターミナルでAzure PowerShellをインストールします。

 

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

 

Visual Studio Code(VS Code)でAzure PowerShellを実行

Visual Studio Code(VS Code)でAzure PowerShellを実行してみます。
Azureへのサインインを例に確認してみます。

Azure PowerShellの確認

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

※直接入力でも同じです。

メニューのファイルで名前をつけて保存を選択します。(Ctrl＋Shift＋Sでも同じです。)

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

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

PowerShell Runと入力、選択します。
ターミナルでAzurePowerShellが実行されます。

 

 

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

Azure PowerShellをVisual Studio Code(VSCode)で扱える事を確認出来ました。

Azure PowerShellでのサインイン方法の詳細はこちら。

ｰｰｰｰｰ

最後に

Visual Studio Code(VS Code)でAzure CLIやAzure PowerShellを使う為に必要な設定手順について纏めてみました。
PowerShellのインストール、バージョン切り替え手順なども併せて確認しています。
今回はAzureへのサインインで確認していますがVisual Studio Code(VS Code)上で色々なAzureリソースの操作が出来ます。

今後も色々試してみたいと思います。

Visual Studio Code(VS Code)のインストールや日本語化の手順についてはこちらに纏めています。

Azure,VS Code