Azure SDK for Go を使用してリソースグループを管理する

[アーティクル]
08/07/2024

この記事では、Azure SDK for Go の管理ライブラリを使用してリソースグループを作成および管理する方法について説明します。

1. Azure リソースのセットアップを行う

この記事の手順を完了するには、以下の Azure リソースと識別子が必要です。

Azure サブスクリプション:Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。
Azure サブスクリプション ID を取得します。
Microsoft Entra テナント ID を取得する。
サービスプリンシパルを作成します。サービスプリンシパルのアプリケーション (クライアント) ID とシークレットをメモします。また、必ず指示に従ってサブスクリプションに対する共同作成者ロールをアプリケーションに割り当ててください。共同作成者ロールは、サブスクリプション内のすべてのリソースを管理するためのアクセス許可が付与されている特権管理者ロールです。

次のセクションに進む前に、サブスクリプション ID (Guid)、テナント ID (Guid)、クライアント/アプリケーション ID (Guid) と、サービスプリンシパルのシークレットを書き留めておいてください。

2. 認証環境変数を設定する

Azure 認証情報を使用して、コードが Azure に対して認証できるように、適切な環境変数を設定します。

Bash
Windows

以下の環境変数を設定します。プレースホルダーは、前のセクションからの適切な値に置き換えてください。

export AZURE_SUBSCRIPTION_ID="<azure_subscription_id>"
export AZURE_TENANT_ID="<active_directory_tenant_id>"
export AZURE_CLIENT_ID="<service_principal_appid>"
export AZURE_CLIENT_SECRET="<service_principal_password>"

以下の環境変数を設定します。プレースホルダーは、前のセクションからの適切な値に置き換えてください。

set AZURE_SUBSCRIPTION_ID="<azure_subscription_id>"
set AZURE_TENANT_ID="<active_directory_tenant_id>"
set AZURE_CLIENT_ID="<service_principal_appid>"
set AZURE_CLIENT_SECRET="<service_principal_password>"

3. リソースグループを作成する

サンプル Go コードをテストして実行するディレクトリを作成し、それを現在のディレクトリにします。
go mod init を実行して、現在のディレクトリ内にモジュールを作成します。
```
go mod init <module_path>
```
重要なポイント:
- <module_path> パラメーターは通常、GitHub リポジトリ内の場所です (github.com/<your_github_account_name>/<directory> など)。
- コマンドラインアプリをテストとして作成し、アプリを公開しない場合は、<module_path> で実際の場所を参照する必要はありません。
go get を実行して、必要な Azure SDK for Go モジュールをダウンロード、ビルド、インストールします。
```
go get github.com/Azure/azure-sdk-for-go/sdk/azcore
go get github.com/Azure/azure-sdk-for-go/sdk/azcore/to
go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources
```
重要

Azure リソース管理ライブラリの現在のバージョンのパッケージは、sdk/**/arm** にあります。以前のバージョンの管理ライブラリのパッケージは、/services の下に置かれています。以前のバージョンを使用している場合は、Azure SDK for Go 移行ガイドを参照してください。

main.go という名前のファイルを作成し、次のコードを追加します。コードの各セクションには、その目的を説明するためのコメントが付けられています。

package main

// Import key modules.
import (
	"context"
	"log"
	"os"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

// Define key global variables.
var (
	subscriptionId    = os.Getenv("AZURE_SUBSCRIPTION_ID")
	location          = "eastus"
	resourceGroupName = "myResourceGroup" // !! IMPORTANT: Change this to a unique name in your subscription.
	ctx               = context.Background()
)

// Define the function to create a resource group.
func createResourceGroup(subscriptionId string, credential azcore.TokenCredential) (armresources.ResourceGroupsClientCreateOrUpdateResponse, error) {
	rgClient, _ := armresources.NewResourceGroupsClient(subscriptionId, credential, nil)

	param := armresources.ResourceGroup{
		Location: to.Ptr(location),
	}

	return rgClient.CreateOrUpdate(ctx, resourceGroupName, param, nil)
}

// Define the standard 'main' function for an app that is called from the command line.
func main() {

	// Create a credentials object.
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("Authentication failure: %+v", err)
	}

	// Call your function to create an Azure resource group.
	resourceGroup, err := createResourceGroup(subscriptionId, cred)
	if err != nil {
		log.Fatalf("Creation of resource group failed: %+v", err)
	}

	// Print the name of the new resource group.
	log.Printf("Resource group %s created", *resourceGroup.ResourceGroup.ID)
}

重要なポイント:

subscriptionId の値は、AZURE_SUBSCRIPTION_ID 環境変数から取得されます。
location 文字列と resourceGroupName 文字列は、テスト値に設定されます。必要に応じて、これらの値を実際の場所とサブスクリプションに対応する値に変更してください。

go mod tidy を実行して、ソースコードに基づいて go.mod ファイル内の依存関係をクリーンアップします。
```
go mod tidy
```
go run を実行して、アプリをビルドして実行します。
```
go run .
```

4. 結果を確認する

Azure ポータルにアクセスします。
サインインして、使用する Azure サブスクリプションを選択します。
左側のメニューの [リソースグループ] を選択します。
新しいリソースグループが、Azure サブスクリプションのリソースグループの一覧に表示されます。

az group show を実行して、リソースグループを表示します。

az group show --name <resource_group>

Get-AzResourceGroup を実行して、リソースグループを表示します。

Get-AzResourceGroup -Name <resource_group>

5. リソースグループを更新する

main.go ファイルに戻ります。

main 関数のすぐ上に次のコードを挿入します。

// Update the resource group by adding a tag to it.
func updateResourceGroup(subscriptionId string, credential azcore.TokenCredential) (armresources.ResourceGroupsClientUpdateResponse, error) {
    rgClient, _ := armresources.NewResourceGroupsClient(subscriptionId, credential, nil)

    update := armresources.ResourceGroupPatchable{
        Tags: map[string]*string{
            "new": to.Ptr("tag"),
        },
    }
    return rgClient.Update(ctx, resourceGroupName, update, nil)
}

コードを追加したら、次のセクションに進みます。コードの実行は、後のセクションで行います。

6. Azure サブスクリプションのリソースグループを一覧表示する

main.go ファイルに戻ります。

main 関数のすぐ上に次のコードを挿入します。

// List all the resource groups of an Azure subscription.
func listResourceGroups(subscriptionId string, credential azcore.TokenCredential) ([]*armresources.ResourceGroup, error) {
    rgClient, _ := armresources.NewResourceGroupsClient(subscriptionId, credential, nil)

    pager := rgClient.NewListPager(nil)

    var resourceGroups []*armresources.ResourceGroup
    for pager.More() {
        resp, err := pager.NextPage(ctx)
        if err != nil {
            return nil, err
        }
        if resp.ResourceGroupListResult.Value != nil {
            resourceGroups = append(resourceGroups, resp.ResourceGroupListResult.Value...)
        }
    }
    return resourceGroups, nil
}

コードを追加したら、次のセクションに進みます。コードの実行は、後のセクションで行います。

7. リソースグループを削除する

main.go ファイルに戻ります。

main 関数のすぐ上に次のコードを挿入します。

// Delete a resource group.
func deleteResourceGroup(subscriptionId string, credential azcore.TokenCredential) error {
    rgClient := armresources.NewResourceGroupsClient(subscriptionId, credential, nil)

    poller, err := rgClient.BeginDelete(ctx, resourceGroupName, nil)
    if err != nil {
        return err
    }
    if _, err := poller.PollUntilDone(ctx, nil); err != nil {
        return err
    }
    return nil
}

コードを追加したら、次のセクションに進みます。コードの実行は、後のセクションで行います。

8. main 関数を更新する

これまでのセクションでは、リソースグループを作成、更新、削除するためのコードを main.go に追加しました。また、Azure サブスクリプションのすべてのリソースグループを一覧表示するコードも追加しました。これらすべての関数を順番に実行するには:

main.go で、main 関数を次のコードに置き換えます。

func main() {

    // Create a credentials object.
    cred, err := azidentity.NewDefaultAzureCredential(nil)
    if err != nil {
        log.Fatalf("Authentication failure: %+v", err)
    }

    // Call your function to create an Azure resource group.
    resourceGroup, err := createResourceGroup(subscriptionId, cred)
    if err != nil {
        log.Fatalf("Creation of resource group failed: %+v", err)
    }
    // Print the name of the new resource group.
    log.Printf("Resource group %s created", *resourceGroup.ResourceGroup.ID)

    // Call your function to add a tag to your new resource group.
    updatedRG, err := updateResourceGroup(subscriptionId, cred)
    if err != nil {
        log.Fatalf("Update of resource group failed: %+v", err)
    }
    log.Printf("Resource Group %s updated", *updatedRG.ResourceGroup.ID)

    // Call your function to list all the resource groups.
    rgList, err := listResourceGroups(subscriptionId, cred)
    if err != nil {
        log.Fatalf("Listing of resource groups failed: %+v", err)
    }
    log.Printf("Your Azure subscription has a total of %d resource groups", len(rgList))

    // Call your function to delete the resource group you created.
    if err := deleteResourceGroup(subscriptionId, cred); err != nil {
        log.Fatalf("Deletion of resource group failed: %+v", err)
    }
    log.Printf("Resource group deleted")
}

コードを実行し、出力を調べます。

go run .

2024/07/31 15:29:06 Resource group /subscriptions/<subscription ID>/resourceGroups/myResourceGroup created
2024/07/31 15:29:07 Resource Group /subscriptions/<subscription ID>/resourceGroups/myResourceGroup updated
2024/07/31 15:29:07 Your Azure subscription has a total of 8 resource groups
2024/07/31 15:30:25 Resource group deleted

Note

リソースグループの削除には数分かかる場合があります。

トラブルシューティング

Stack Overflow に投稿された前の質問を確認するか、Azure と Go のタグを使用して新しい質問をしてください。
発生したエラーについては、GitHub の問題を送信してください。

次のステップ

Azure SDK for Go の使用について詳細を確認する

次の方法で共有

Azure SDK for Go を使用してリソースグループを管理する

1. Azure リソースのセットアップを行う

2. 認証環境変数を設定する

3. リソースグループを作成する

4. 結果を確認する

5. リソースグループを更新する

6. Azure サブスクリプションのリソースグループを一覧表示する

7. リソースグループを削除する

8. main 関数を更新する

トラブルシューティング

次のステップ

フィードバック

その他のリソース

次の方法で共有

Azure SDK for Go を使用してリソース グループを管理する

1. Azure リソースのセットアップを行う

2. 認証環境変数を設定する

3. リソース グループを作成する

4. 結果を確認する

5. リソース グループを更新する

6. Azure サブスクリプションのリソース グループを一覧表示する

7. リソース グループを削除する

8. main 関数を更新する

トラブルシューティング

次のステップ

フィードバック

その他のリソース

Azure SDK for Go を使用してリソースグループを管理する

3. リソースグループを作成する

5. リソースグループを更新する

6. Azure サブスクリプションのリソースグループを一覧表示する

7. リソースグループを削除する