16 KiB

Исходник Ответственный История

Getting Started - New Azure Go SDK

We are excited to announce that a new set of management libraries are now production-ready. Those packages share a number of new features such as Azure Identity support, HTTP pipeline, error-handling.,etc, and they also follow the new Azure SDK guidelines which create easy-to-use APIs that are idiomatic, compatible, and dependable.

You can find the full list of those new libraries here.

In this basic quickstart guide, we will walk you through how to authenticate to Azure and start interacting with Azure resources. There are several possible approaches to authentication. This document illustrates the most common scenario.

Migration from older versions of Azure management libraries for Go

If you are an existing user of the older version of Azure management library for Go (packages that are located under /services), and you are looking for a migration guide to upgrade to the latest version of the SDK, please refer to this migration guide for detailed instructions.

Prerequisites

You will need Go 1.18 and latest version of resource management modules.

You will need to authenticate to Azure either by using Azure CLI to sign in or setting environment variables.

Upgrade Go version

You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.

You could easily use az login in command line to sign in to Azure via your default browser. Detail instructions can be found in Sign in with Azure CLI.

Setting Environment Variables

You will need the following values to authenticate to Azure

Subscription ID
Client ID
Client Secret
Tenant ID

These values can be obtained from the portal, here's the instructions:

Get Subscription ID
1. Login into your Azure account
2. Select Subscriptions in the left sidebar
3. Select whichever subscription is needed
4. Click on Overview
5. Copy the Subscription ID
Get Client ID / Client Secret / Tenant ID

For information on how to get Client ID, Client Secret, and Tenant ID, please refer to this document
Setting Environment Variables

After you obtained the values, you need to set the following values as your environment variables
- AZURE_CLIENT_ID
- AZURE_CLIENT_SECRET
- AZURE_TENANT_ID
- AZURE_SUBSCRIPTION_ID
To set the following environment variables on your development system:

Windows (Note: Administrator access is required)
1. Open the Control Panel
2. Click System Security, then System
3. Click Advanced system settings on the left
4. Inside the System Properties window, click the Environment Variables… button.
5. Click on the property you would like to change, then click the Edit… button. If the property name is not listed, then click the New… button.
Linux-based OS :
```
  export AZURE_CLIENT_ID="__CLIENT_ID__"
  export AZURE_CLIENT_SECRET="__CLIENT_SECRET__"
  export AZURE_TENANT_ID="__TENANT_ID__"
  export AZURE_SUBSCRIPTION_ID="__SUBSCRIPTION_ID__"
```

Install the package

The new SDK uses Go modules for versioning and dependency management.

As an example, to install the Azure Compute module, you would run :

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute

We also recommend installing other packages for authentication and core functionalities :

go get github.com/Azure/azure-sdk-for-go/sdk/azcore
go get github.com/Azure/azure-sdk-for-go/sdk/azidentity

Authentication

Before creating a client, you will need to provide a credential for authenticating with the Azure service. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

Our default option is to use DefaultAzureCredential. It combines common production credentials with development credentials.

import "github.com/Azure/azure-sdk-for-go/sdk/azidentity"

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more details on how authentication works in azidentity, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Creating a Resource Management Client

Once you have a credential, you will need to decide what service to use and create a client to connect to that service. We provide a client factory which could be used to create any client in one service module. In this section, we will use Compute as our target service. The Compute modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. You will need to create one or more clients through the client factory to access the APIs you require using your azcore.TokenCredential.

To show an example, we will create a client to manage Virtual Machines. The code to achieve this task would be:

import "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute"

computeClientFactory,err := armcompute.NewClientFactory("<subscription ID>", credential, nil)
client := computeClientFactory.NewVirtualMachinesClient()

You can use the same pattern to connect with other Azure services that you are using. For example, in order to manage Virtual Network resources, you would install the Network package and create a VirtualNetwork Client:

import "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
import "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork"

networkClientFactory,err := armnetwork.NewClientFactory("<subscription ID>", credential, nil)
client := networkClientFactory.NewVirtualNetworksClient()

Interacting with Azure Resources

Now that we are authenticated and have created our sub-resource clients, we can use our client to make API calls. For resource management scenarios, most of our cases are centered around creating / updating / reading / deleting Azure resources. Those scenarios correspond to what we call "operations" in Azure. Once you are sure of which operations you want to call, you can then implement the operation call using the management client we just created in previous section.

To write the concrete code for the API call, you might need to look up the information of request parameters, types, and response body for a certain operation. We recommend using the following site for SDK reference:

Official Go docs for new Azure Go SDK packages - This web-site contains the complete SDK references for each released package as well as embedded code snippets for some operation.

To see the reference for a certain package, you can either click into each package on the web-site, or directly add the SDK path to the end of URL. For example, to see the reference for Azure Compute package, you can use https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute. Certain development tool or IDE has features that allow you to directly look up API definitions as well.

Let's illustrate the SDK usage by a few quick examples. In the following sample. we are going to create a resource group using the SDK. To achieve this scenario, we can take the follow steps

Step 1 : Decide which client we want to use, in our case, we know that it's related to Resource Group so our choice is the ResourceGroupsClient.
Step 2 : Find out which operation is responsible for creating a resource group. By locating the client in previous step, we are able to see all the functions under ResourceGroupsClient, and we can see the CreateOrUpdate function is what need.
Step 3 : Using the information about this operation, we can then fill in the required parameters, and implement it using the Go SDK. If we need extra information on what those parameters mean, we can also use the Azure service documentation on Microsoft Docs.

Let's show what final code looks like.

Example: Creating a Resource Group

Import the packages

import (
    "context"
    "log"
    "os"
    "time"

    "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 some global variables

var (
    ctx                 = context.TODO()
    subscriptionId      = os.Getenv("AZURE_SUBSCRIPTION_ID")
    location            = "westus2"
    resourceGroupName   = "resourceGroupName"
    interval            = 5 * time.Second
    rgClient            *armresources.ResourceGroupsClient
)

Write a function to create a resource group

func createResourceGroup(ctx context.Context) (*armresources.ResourceGroupsClientCreateOrUpdateResponse, error) {

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

    resp, err := rgClient.CreateOrUpdate(ctx, resourceGroupName, param, nil)

    return &resp, err
}

Invoking the createResourceGroup function in main

func main() {
    cred, err := azidentity.NewDefaultAzureCredential(nil)
    if err != nil {
        log.Fatalf("authentication failure: %+v", err)
    }
	
    clientFactory, err := armresources.NewClientFactory(subscriptionId, cred, nil)
    if err != nil {
        log.Fatalf("cannot create client factory: %+v", err)
    }
    rgClient = clientFactory.NewResourceGroupsClient()
	
    resourceGroup, err := createResourceGroup(ctx)
    if err != nil {
        log.Fatalf("cannot create resource group: %+v", err)
    }
    log.Printf("Resource Group %s created", *resourceGroup.ResourceGroup.ID)
}

Let's demonstrate management client's usage by showing additional samples.

Example: Managing Resource Groups

Update a resource group

func updateResourceGroup(ctx context.Context) (*armresources.ResourceGroupsClientUpdateResponse, error) {

    update := armresources.ResourceGroupPatchable{
        Tags: map[string]*string{
            "new": to.Ptr("tag"),
        },
    }

    resp,err :=rgClient.Update(ctx, resourceGroupName, update, nil)
    
    return  &resp, err
}

List all resource groups

func listResourceGroups(ctx context.Context) ([]*armresources.ResourceGroup, error) {

    pager := rgClient.NewListPager(nil)

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

    return resourceGroups, nil
}

You could see there is a pattern for pageable operation here. With NewListPager you will get an pager helper for fetching pages and determining if there are more pages to fetch. For more details, you could refer to Azure Go Management SDK Guideline.

Delete a resource group

func deleteResourceGroup(ctx context.Context) error {

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

You could see there is a pattern for LRO (long-running operations) here. With BeginDelete the LRO has started and you will get an poller helper for fetching operation result. For more details, you could refer to Azure Go Management SDK Guideline.

Invoking the update, list and delete of resource group in the main function

func main() {
    cred, err := azidentity.NewDefaultAzureCredential(nil)
    if err != nil {
        log.Fatalf("authentication failure: %+v", err)
    }

    clientFactory, err := armresources.NewClientFactory(subscriptionId, cred, nil)
    if err != nil {
        log.Fatalf("cannot create client factory: %+v", err)
    }
    rgClient = clientFactory.NewResourceGroupsClient()

    resourceGroup, err := createResourceGroup(ctx)
    if err != nil {
        log.Fatalf("cannot create resource group: %+v", err)
    }
    log.Printf("Resource Group %s created", *resourceGroup.ResourceGroup.ID)

    updatedRG, err := updateResourceGroup(ctx)
    if err != nil {
        log.Fatalf("cannot update resource group: %+v", err)
    }
    log.Printf("Resource Group %s updated", *updatedRG.ResourceGroup.ID)

    rgList, err := listResourceGroups(ctx)
    if err != nil {
        log.Fatalf("cannot list resource group: %+v", err)
    }
    log.Printf("We totally have %d resource groups", len(rgList))

    if err := deleteResourceGroup(ctx); err != nil {
        log.Fatalf("cannot delete resource group: %+v", err)
    }
    log.Printf("Resource Group deleted")
}

Example: Managing Virtual Machines

In addition to resource groups, we will also use Virtual Machine as an example and show how to manage how to create a Virtual Machine which involves three Azure services (Resource Group, Network and Compute)

Due to the complexity of this scenario, please click here for the complete sample.

Code Samples

More code samples for using the management library for Go SDK can be found in the following locations

Go SDK Code Samples
Example files under each package. For example, examples for Network packages can be found here

Further Infomation

For further infomation about the new SDK including advanced API usage and trouble shooting, you could refer to Azure Go Management SDK Guideline.

Need help?

File an issue via Github Issues
Check previous questions or ask new ones on StackOverflow using azure and Go tags.

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, please visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any questions or comments.

16 KiB Исходник Ответственный История