Terraform を使用して Azure AI Studio ハブを作成する

この記事では、Terraform を使用して、Azure AI Studio ハブ、プロジェクト、および AI サービス接続を作成します。 ハブは、データ サイエンティストと開発者が機械学習プロジェクトで共同作業を行うための中心的な場所です。 機械学習モデルを構築、トレーニング、デプロイするための共有の共同作業スペースが提供されます。 ハブは Azure Machine Learning やその他の Azure サービスと統合されており、機械学習タスクの包括的なソリューションとなります。 また、ハブを使用すると、AI デプロイを管理および監視し、期待どおりに実行されるようにすることができます。

Terraform を使用すると、クラウド インフラストラクチャの定義、プレビュー、およびデプロイを行うことができます。 Terraform を使用する際は、HCL 構文を使って構成ファイルを作成します。 HCL 構文では、Azure などのクラウド プロバイダーと、クラウド インフラストラクチャを構成する要素を指定できます。 構成ファイルを作成したら、"実行プラン" を作成します。これにより、インフラストラクチャの変更をデプロイ前にプレビューすることができます。 変更を確認したら、実行プランを適用してインフラストラクチャをデプロイします。

• リソース グループを作成する
• ストレージ アカウントを設定する
• キー コンテナーを確立する
• AI サービスを構成する
• AI Studio ハブを構築する
• AI Studio プロジェクトを開発する
• AI サービス接続を確立する

前提条件

• アクティブなサブスクリプションが含まれる Azure アカウントを作成します。 無料でアカウントを作成できます。

• Terraform のインストールと構成

Terraform コードを実装する

注意

この記事のサンプル コードは、Azure Terraform GitHub リポジトリにあります。 Terraform の現在および以前のバージョンのテスト結果を含むログ ファイルを表示できます。

Terraform を使用して Azure リソースを管理する方法を示すその他の記事とサンプル コードを参照してください

1. サンプル Terraform コードをテストして実行するディレクトリを作成し、それを現在のディレクトリにします。

2. providers.tf という名前のファイルを作成し、次のコードを挿入します。

   terraform {
     required_version = ">= 1.0"
   
     required_providers { 
       azurerm = {
         source  = "hashicorp/azurerm"
         version = "~>3.0"
       }
       azapi = {
         source  = "azure/azapi"
       }
       random = {
         source  = "hashicorp/random"
         version = "~>3.0"
       }
     }
   }
   
   provider "azurerm" {
     features {
       key_vault {
         recover_soft_deleted_key_vaults    = false
         purge_soft_delete_on_destroy       = false
         purge_soft_deleted_keys_on_destroy = false
       }
       resource_group {
         prevent_deletion_if_contains_resources = false
       }
     }
   }
   
   provider "azapi" {
   }
   

3. main.tf という名前のファイルを作成し、次のコードを挿入します。

   resource "random_pet" "rg_name" { 
     prefix = var.resource_group_name_prefix
   }
   
   // RESOURCE GROUP
   resource "azurerm_resource_group" "rg" {
     location = var.resource_group_location
     name     = random_pet.rg_name.id
   }
   
   data "azurerm_client_config" "current" {
   }
   
   // STORAGE ACCOUNT
   resource "azurerm_storage_account" "default" {
     name                            = "${var.prefix}storage${random_string.suffix.result}"
     location                        = azurerm_resource_group.rg.location
     resource_group_name             = azurerm_resource_group.rg.name
     account_tier                    = "Standard"
     account_replication_type        = "GRS"
     allow_nested_items_to_be_public = false
   }
   
   // KEY VAULT
   resource "azurerm_key_vault" "default" {
     name                     = "${var.prefix}keyvault${random_string.suffix.result}"
     location                 = azurerm_resource_group.rg.location
     resource_group_name      = azurerm_resource_group.rg.name
     tenant_id                = data.azurerm_client_config.current.tenant_id
     sku_name                 = "standard"
     purge_protection_enabled = false
   }
   
   // AzAPI AIServices
   resource "azapi_resource" "AIServicesResource"{
     type = "Microsoft.CognitiveServices/accounts@2023-10-01-preview"
     name = "AIServicesResource${random_string.suffix.result}"
     location = azurerm_resource_group.rg.location
     parent_id = azurerm_resource_group.rg.id
   
     identity {
       type = "SystemAssigned"
     }
   
     body = jsonencode({
       name = "AIServicesResource${random_string.suffix.result}"
       properties = {
         //restore = true
         customSubDomainName = "${random_string.suffix.result}domain"
           apiProperties = {
               statisticsEnabled = false
           }
       }
       kind = "AIServices"
       sku = {
           name = var.sku
       }
       })
   
     response_export_values = ["*"]
   }
   
   // Azure AI Hub
   resource "azapi_resource" "hub" {
     type = "Microsoft.MachineLearningServices/workspaces@2024-04-01-preview"
     name = "${random_pet.rg_name.id}-aih"
     location = azurerm_resource_group.rg.location
     parent_id = azurerm_resource_group.rg.id
   
     identity {
       type = "SystemAssigned"
     }
   
     body = jsonencode({
       properties = {
         description = "This is my Azure AI hub"
         friendlyName = "My Hub"
         storageAccount = azurerm_storage_account.default.id
         keyVault = azurerm_key_vault.default.id
   
         /* Optional: To enable these field, the corresponding dependent resources need to be uncommented.
         applicationInsight = azurerm_application_insights.default.id
         containerRegistry = azurerm_container_registry.default.id
         */
   
         /*Optional: To enable Customer Managed Keys, the corresponding 
         encryption = {
           status = var.encryption_status
           keyVaultProperties = {
               keyVaultArmId = azurerm_key_vault.default.id
               keyIdentifier = var.cmk_keyvault_key_uri
           }
         }
         */
         
       }
       kind = "hub"
     })
   }
   
   // Azure AI Project
   resource "azapi_resource" "project" {
     type = "Microsoft.MachineLearningServices/workspaces@2024-04-01-preview"
     name = "my-ai-project${random_string.suffix.result}"
     location = azurerm_resource_group.rg.location
     parent_id = azurerm_resource_group.rg.id
   
     identity {
       type = "SystemAssigned"
     }
   
     body = jsonencode({
       properties = {
         description = "This is my Azure AI PROJECT"
         friendlyName = "My Project"
         hubResourceId = azapi_resource.hub.id
       }
       kind = "project"
     })
   }
   
   // AzAPI AI Services Connection
   resource "azapi_resource" "AIServicesConnection" {
     type = "Microsoft.MachineLearningServices/workspaces/connections@2024-04-01-preview"
     name = "Default_AIServices${random_string.suffix.result}"
     parent_id = azapi_resource.hub.id
   
     body = jsonencode({
         properties = {
           category = "AIServices",
           target = jsondecode(azapi_resource.AIServicesResource.output).properties.endpoint,
           authType = "AAD",
           isSharedToAll = true,
           metadata = {
             ApiType = "Azure",
             ResourceId = azapi_resource.AIServicesResource.id
           }
         }
       })
     response_export_values = ["*"]
   }
   
   /* The following resources are OPTIONAL.
   // APPLICATION INSIGHTS
   resource "azurerm_application_insights" "default" {
     name                = "${var.prefix}appinsights${random_string.suffix.result}"
     location            = azurerm_resource_group.rg.location
     resource_group_name = azurerm_resource_group.rg.name
     application_type    = "web"
   }
   
   // CONTAINER REGISTRY
   resource "azurerm_container_registry" "default" {
     name                     = "${var.prefix}contreg${random_string.suffix.result}"
     resource_group_name      = azurerm_resource_group.rg.name
     location                 = azurerm_resource_group.rg.location
     sku                      = "premium"
     admin_enabled            = true
   }
   */
   

4. variables.tf という名前のファイルを作成し、次のコードを挿入します。

   variable "resource_group_location" {
     type        = string
     default     = "eastus"
     description = "Location of the resource group."
   }
   
   variable "resource_group_name_prefix" {
     type        = string
     default     = "rg"
     description = "Prefix of the resource group name that's combined with a random ID so name is unique in your Azure subscription."
   }
   
   variable "prefix" {
       type = string
       description="This variable is used to name the hub, project, and dependent resources."
       default = "ai"
   }
   
   variable "sku" {
       type        = string
       description = "The sku name of the Azure Analysis Services server to create. Choose from: B1, B2, D1, S0, S1, S2, S3, S4, S8, S9. Some skus are region specific. See https://docs.microsoft.com/en-us/azure/analysis-services/analysis-services-overview#availability-by-region"
       default     = "S0"
   }
   
   resource "random_string" "suffix" {  
     length           = 4  
     special          = false  
     upper            = false  
   } 
   
   /*Optional: For Customer Managed Keys, uncomment this part AND the corresponding section in main.tf
   variable "cmk_keyvault_key_uri" {
       description = "Key vault uri to access the encryption key."
   }
   
   variable "encryption_status" {
       description = "Indicates whether or not the encryption is enabled for the workspace."
       default = "Enabled"
   }
   */
   

5. outputs.tf という名前のファイルを作成し、次のコードを挿入します。

   output "resource_group_name" {
     value = azurerm_resource_group.rg.id
   }
   
   output "workspace_name" {
       value = azapi_resource.project.id
   }
   
   output "endpoint" {
     value = jsondecode(azapi_resource.AIServicesResource.output).properties.endpoint
   }
   

Terraform を初期化する

terraform init を実行して、Terraform のデプロイを初期化します。 このコマンドによって、Azure リソースを管理するために必要な Azure プロバイダーがダウンロードされます。

terraform init -upgrade

重要なポイント:

• -upgrade パラメーターは、必要なプロバイダー プラグインを、構成のバージョン制約に準拠する最新バージョンにアップグレードします。

Terraform 実行プランを作成する

terraform plan を実行して、実行プランを作成します。

terraform plan -out main.tfplan

重要なポイント:

• terraform plan コマンドは、実行プランを作成しますが、実行はしません。 代わりに、構成ファイルに指定された構成を作成するために必要なアクションを決定します。 このパターンを使用すると、実際のリソースに変更を加える前に、実行プランが自分の想定と一致しているかどうかを確認できます。
• 省略可能な -out パラメーターを使用すると、プランの出力ファイルを指定できます。 -out パラメーターを使用すると、レビューしたプランが適用内容とまったく同じであることが確実になります。

Terraform 実行プランを適用する

terraform apply を実行して、クラウド インフラストラクチャに実行プランを適用します。

terraform apply main.tfplan

重要なポイント:

• terraform apply コマンドの例は、以前に terraform plan -out main.tfplan が実行されたことを前提としています。
• -out パラメーターに別のファイル名を指定した場合は、terraform apply の呼び出しで同じファイル名を使用します。
• -out パラメーターを使用しなかった場合は、パラメーターを指定せずに terraform apply を呼び出します。

結果を確認する

Azure CLI

1. Azure リソース グループ名を取得します。

   resource_group_name=$(terraform output -raw resource_group_name)
   

2. ワークスペース名を取得します。

   workspace_name=$(terraform output -raw workspace_name)
   

3. az ml workspace show を実行して、新しいワークスペースに関する情報を表示します。

   az ml workspace show --resource-group $resource_group_name \
                        --name $workspace_name
   

Azure PowerShell

1. Azure リソース グループ名を取得します。

   $resource_group_name=$(terraform output -raw resource_group_name)
   

2. ワークスペース名を取得します。

   $workspace_name=$(terraform output -raw workspace_name)
   

3. Get-AzMLWorkspace を実行して、新しいワークスペースに関する情報を表示します。

   Get-AzMLWorkspace -ResourceGroupName $resource_group_name `
                     -Name $workspace_name
   

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

Terraform を使用して作成したリソースが不要になった場合は、次の手順を実行します。

1. terraform plan を実行して、destroy フラグを指定します。

   terraform plan -destroy -out main.destroy.tfplan
   

   重要なポイント:

   • terraform plan コマンドは、実行プランを作成しますが、実行はしません。 代わりに、構成ファイルに指定された構成を作成するために必要なアクションを決定します。 このパターンを使用すると、実際のリソースに変更を加える前に、実行プランが自分の想定と一致しているかどうかを確認できます。
   • 省略可能な -out パラメーターを使用すると、プランの出力ファイルを指定できます。 -out パラメーターを使用すると、レビューしたプランが適用内容とまったく同じであることが確実になります。

2. terraform apply を実行して、実行プランを適用します。

   terraform apply main.destroy.tfplan
   

Azure での Terraform のトラブルシューティング

Azure で Terraform を使用する場合の一般的な問題のトラブルシューティング。

次のステップ

Azure AI Studio ハブに関するその他の記事を参照する