More than 3 years have passed since last update.

【Azure Synapse Analytics】Azure Automation で SQL poolの一時停止と再開を自動化する

Posted at 2020-08-11

はじめに

Azure Synapse Analytics の SQL pool は Azure SQL DataWarehouse の後継となる DWH サービスです。Azure SQL DataWarehouse と同様、未使用時はコンピューティングを一時停止させておくことで、課金を抑えることができます。

コンピューティングの一時停止および再開は Azure Portal や Synapse Studio といった GUI からの操作に加え Azure CLI や PowerShell でも実施可能ですので、これらを活用することで処理の自動化も可能です。そこで今回は、Azure Automation を使った PowerShell による SQL pool の一時停止/起動のスケジューリングを試してみたいと思います。

PowerShell コマンドレット

SQL pool の操作には Update-AzSynapseSqlPool コマンドレットを使用します。

Update-AzSynapseSqlPool

構文は以下の通りで、一時停止では -Suspend 、再開では -Resume を指定します。-WorkspaceName は対象となる Synapse Workspace、-Name は SQL pool のリソース名をそれぞれ指定します。

#一時停止
Update-AzSynapseSqlPool -WorkspaceName $WorkspaceName -Name $Name -Suspend
#再開
Update-AzSynapseSqlPool -WorkspaceName $WorkspaceName -Name $Name -Resume

実行環境によっては Az.Synapse モジュールが無いかもしれませんので、その場合は事前にインストール作業を実施してください。以下は、Install-Module コマンドレットを使用して PowerShell Gallery からインストールする例です。

Install-Module -Name Az.Synapse

Azure Automation の場合は、モジュールギャラリーからインポートします。詳細な手順は後述します。

Azure Automation アカウントの作成と使用準備

Azure Automation アカウントの作成自体は Azure Portal からすぐにでき特に悩む点はありませんが、SQL pool のリソースを操作できるようにするために必要な準備がいくつかあります。今回実施したのは以下の 3 点です。

1. Az モジュールのインポート

今回の作業に必要な、 Az.Accounts 、 Az.Automation 、 Az.Synapse の 3 つをモジュールギャラリーからインポートしておきます。以下は、Az.Synapse をインポートする場合の画面イメージです。その他のモジュールについても同様の手順を実施します。

なお、依存関係の問題があるため、3 つのモジュールの中では Az.Accounts を最初にインポートする必要があります。

2. 変数の定義

Update-AzSynapseSqlPool コマンドレットの引数として必要な-WorkspaceName と-Name の値を定義しておき、Runbook の PowerShell スクリプトから呼び出せるようにしておきます。

3. 接続コンテキストの作成

Automation アカウントで Azure リソースにアクセスするための接続コンテキストを作成します。後述の通り、今回は PowerShell スクリプト内に直接記述しました。

Runbook の作成と設定

ここからようやく本題の SQL pool の一時停止/再開用スクリプトの作成とスケジューリング設定になります。一時停止用と再開用に Runbook を 2 つ作成し、一時停止用は毎日 17 時、再開用は毎日 9 時に実行されるようそれぞれスケジューリングしてみます。

「Runbook」で「Runbook の作成」をクリック。「Runbook の種類」で「PowerShell」を選択し作成。

作成した Runbook で「編集」をクリックし、以下スクリプトを記述。

$connectionName = "AzureRunAsConnection"

Disable-AzContextAutosave –Scope Process

$conn = Get-AutomationConnection -Name $connectionName
Connect-AzAccount -ServicePrincipal -Tenant $conn.TenantID `
-ApplicationId $conn.ApplicationID -CertificateThumbprint $conn.CertificateThumbprint

$AzureContext = Select-AzSubscription -SubscriptionId $conn.SubscriptionID

$WorkspaceName = Get-AutomationVariable -Name 'WorkspaceName'
$Name = Get-AutomationVariable -Name 'Name'
Update-AzSynapseSqlPool -WorkspaceName $WorkspaceName -Name $Name -Resume