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

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

VS Code(Visual Studio Code)でAzure CLIやAzure PowerShellを使用するための設定手順のまとめです。

    • 主な手順
      • Azure CLI
        • WindowsへAzure CLIをインストール
        • VS Code(Visual Studio Code)にAzure CLIの拡張機能をインストール
        • VS Code(Visual Studio Code)でAzure CLIを実行
      • Azure PowerShell
        • PowerShell 7のインストール
        • VS Code(Visual Studio Code)でのPowerShellバージョンの切り替え
        • Azure PowerShellのインストール
        • VS Code(Visual Studio Code)でAzure PowerShellを実行
※手順の確認にはWindows10を利用しています。

スポンサーリンク

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

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

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

WindowsにAzure CLIをインストール

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

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コマンドを実行

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

Azure CLIコマンドを実行

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

 

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

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

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

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

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

Azure CLI Toolsインストール手順

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

 

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ファイルをVS Code(Visual Studio Code)で扱える事を確認できました。

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

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

—広告—

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

PowerShellのバージョン確認

VS Code(Visual Studio Code)で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

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

PowerShell 7をインストールしても、VS Code(Visual Studio Code)で使用される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の拡張機能をVS Code(Visual Studio Code)にインストール

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

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

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

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

Azure PowerShellをインストール

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

Windows に Azure 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

 

VS Code(Visual Studio Code)のターミナルでAzure PowerShellをインストールします。

 

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

 

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

VS Code(Visual Studio 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をVS Code(Visual Studio Code)で扱える事を確認できました。

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

—広告—

最後に

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

引き続き色々試してみたいと思います。

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

スポンサーリンク