クイック スタート:Azure CLI を使用して Azure Synapse ワークスペースを作成する

  • [アーティクル]

Azure CLI は、Azure リソースを管理するための、Azure のコマンド ライン エクスペリエンスです。 ブラウザーで、Azure Cloud Shell を使用して操作することができます。 また、macOS、Linux、または Windows 上にインストールし、コマンド ラインから実行することもできます。

このクイックスタートでは、Azure CLI を使用して Synapse ワークスペースを作成する方法について説明します。

Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。

前提条件

  • 軽量で柔軟性の高いコマンド ライン JSON プロセッサ、jq をダウンロードしてインストールします。

  • Azure Data Lake Storage Gen2 ストレージ アカウント

    重要

    Azure Synapse ワークスペースは、選択した ADLS Gen2 アカウントの読み取りと書き込みを行うことができる必要があります。 加えて、プライマリ ストレージ アカウントとしてリンクするストレージ アカウントについては、「ストレージ アカウントの作成」ページの説明に従って、ストレージ アカウントの作成時に階層型名前空間を有効にする必要があります。

  • Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。

  • CLI リファレンス コマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。

    • ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、Azure CLI でのサインインに関するページを参照してください。

    • 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。 拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。

    • az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。

Azure CLI を使用して Azure Synapse ワークスペースを作成する

  1. Azure Synapse ワークスペース用のリソースを作成するために、必要な環境変数を定義します。

    環境変数の名前 説明
    StorageAccountName 既存の ADLS Gen2 ストレージ アカウントの名前。
    StorageAccountResourceGroup 既存の ADLS Gen2 ストレージ アカウントのリソース グループの名前。
    FileShareName 既存のストレージ ファイル システムの名前。
    SynapseResourceGroup Azure Synapse リソース グループの新しい名前を選択します。
    リージョン いずれかの Azure リージョンを選択します。
    SynapseWorkspaceName 新しい Azure Synapse ワークスペースの一意の名前を選択します。
    SqlUser 新しいユーザー名の値を選択します。
    SqlPassword セキュリティで保護されたパスワードを選択します。

  2. Azure Synapse ワークスペースのコンテナーとしてリソース グループを作成します。

    az group create --name $SynapseResourceGroup --location $Region

  3. Azure Synapse ワークスペースを作成します。

    az synapse workspace create \
  --name $SynapseWorkspaceName \
  --resource-group $SynapseResourceGroup \
  --storage-account $StorageAccountName \
  --file-system $FileShareName \
  --sql-admin-login-user $SqlUser \
  --sql-admin-login-password $SqlPassword \
  --location $Region

  4. Azure Synapse ワークスペースの Web URL と開発 URL を取得します。

    WorkspaceWeb=$(az synapse workspace show --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup | jq -r '.connectivityEndpoints | .web')

WorkspaceDev=$(az synapse workspace show --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup | jq -r '.connectivityEndpoints | .dev')

  5. ご使用のマシンから Azure Synapse ワークスペースへのアクセスを許可するファイアウォール規則を作成します。

    ClientIP=$(curl -sb -H "Accept: application/json" "$WorkspaceDev" | jq -r '.message')
ClientIP=${ClientIP##'Client Ip address : '}
echo "Creating a firewall rule to enable access for IP address: $ClientIP"

az synapse workspace firewall-rule create --end-ip-address $ClientIP --start-ip-address $ClientIP --name "Allow Client IP" --resource-group $SynapseResourceGroup --workspace-name $SynapseWorkspaceName

  6. 環境変数 WorkspaceWeb に格納された Azure Synapse ワークスペースの Web URL アドレスを開いてワークスペースにアクセスします。

    echo "Open your Azure Synapse Workspace Web URL in the browser: $WorkspaceWeb"

    Azure Synapse workspace web

  7. デプロイ後は、追加のアクセス許可が必要です。

  • Azure portal で、ワークスペースの他のユーザーをワークスペースの共同作成者ロールに割り当てます。 詳細な手順については、「Azure portal を使用して Azure ロールを割り当てる」を参照してください。
  • Synapse Studio を使用して、他のユーザーに適切な Synapse RBAC ロールを割り当てます。
  • Azure Storage アカウントの所有者ロールのメンバーは、ストレージ BLOB データ共同作成者ロールを Azure Synapse ワークスペース MSI および他のユーザーに割り当てる必要があります。

リソースをクリーンアップする

次の手順に従って、Azure Synapse ワークスペースを削除します。

警告

Azure Synapse ワークスペースを削除すると、分析エンジンと、含まれている SQL プールとワークスペース メタデータのデータベースに格納されているデータが削除されます。 以後、SQL または Apache Spark のエンドポイントには接続できません。 すべてのコード成果物が削除されます (クエリ、ノートブック、ジョブ定義、およびパイプライン)。

ワークスペースを削除しても、そのワークスペースにリンクされている Data Lake Store Gen2 のデータには影響しません。

Azure Synapse ワークスペースを削除する場合は、次のコマンドを実行します。

az synapse workspace delete --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup

次のステップ

次に、データの分析と探索を開始するために、SQL プールを作成するか、Apache Spark プールを作成することができます。