Merge pull request #204061 from chlowell/go-kv-quickstarts

Update Go SDK Key Vault quickstarts

Author: v-dirichards

articles/key-vault/certificates/quick-create-go.md

@@ -14,14 +14,14 @@ ms.devlang: golang
 
 In this quickstart, you'll learn to use the Azure SDK for Go to manage certificates in an Azure Key Vault.
 
-Azure Key Vault is a cloud service that works as a secure secrets store. You can securely store keys, passwords, certificates, and other secrets. For more information on Key Vault, you may review the [Overview](../general/overview.md). 
+Azure Key Vault is a cloud service that works as a secure secrets store. You can securely store keys, passwords, certificates, and other secrets. For more information on Key Vault, you may review the [Overview](../general/overview.md).
 
-Follow this guide to learn how to use the [azcertificates](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/keyvault/azcertificates) package to manage your Azure Key Vault certificates using Go.
+Follow this guide to learn how to use the [azcertificates](https://aka.ms/azsdk/go/keyvault-certificates/docs) package to manage your Azure Key Vault certificates using Go.
 
 ## Prerequisites
 
 - An Azure subscription - [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
-- **Go installed**: Version 1.16 or [above](https://go.dev/dl/)
+- **Go installed**: Version 1.18 or [above](https://go.dev/dl/)
 - [Azure CLI](/cli/azure/install-azure-cli)
 
 ## Set up your environment
@@ -42,7 +42,7 @@ Follow this guide to learn how to use the [azcertificates](https://pkg.go.dev/gi
 1. Deploy a new key vault instance.
 
     ```azurecli
-    az keyvault create --name <keyVaultName> --resource-group myResourceGroup 
+    az keyvault create --name <keyVaultName> --resource-group myResourceGroup
     ```
 
     Replace `<keyVaultName>` with a name that's unique across all of Azure. You typically use your personal or company name along with other numbers and identifiers.
@@ -65,103 +65,98 @@ package main
 import (
 	"context"
 	"fmt"
+	"log"
 	"time"
 
 	"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/keyvault/azcertificates"
 )
 
-var (
-	ctx = context.Background()
-)
-
 func getClient() *azcertificates.Client {
-
 	keyVaultName := os.Getenv("KEY_VAULT_NAME")
 	if keyVaultName == "" {
-		panic("KEY_VAULT_NAME environment variable not set")
+		log.Fatal("KEY_VAULT_NAME environment variable not set")
 	}
 	keyVaultUrl := fmt.Sprintf("https://%s.vault.azure.net/", keyVaultName)
 
 	cred, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
-		panic(err)
+		log.Fatal(err)
 	}
 
-	client, err := azcertificates.NewClient(keyVaultUrl, cred, nil)
-	if err != nil {
-		panic(err)
-	}
-	return client
+	return azcertificates.NewClient(keyVaultUrl, cred, nil)
 }
 
 func createCert(client *azcertificates.Client) {
-	resp, err := client.BeginCreateCertificate(ctx, "myCertName", azcertificates.CertificatePolicy{
-		IssuerParameters: &azcertificates.IssuerParameters{
-			Name: to.StringPtr("Self"),
-		},
-		X509CertificateProperties: &azcertificates.X509CertificateProperties{
-			Subject: to.StringPtr("CN=DefaultPolicy"),
+	params := azcertificates.CreateCertificateParameters{
+		CertificatePolicy: &azcertificates.CertificatePolicy{
+			IssuerParameters: &azcertificates.IssuerParameters{
+				Name: to.Ptr("Self"),
+			},
+			X509CertificateProperties: &azcertificates.X509CertificateProperties{
+				Subject: to.Ptr("CN=DefaultPolicy"),
+			},
 		},
-	}, nil)
-	if err != nil {
-		panic(err)
 	}
-
-	pollerResp, err := resp.PollUntilDone(ctx, 1*time.Second)
+	resp, err := client.CreateCertificate(context.TODO(), "myCertName", params, nil)
 	if err != nil {
-		panic(err)
+		log.Fatal(err)
 	}
-        fmt.Printf("Created certificate with ID: %s\n", *pollerResp.ID)
+
+	fmt.Printf("Requested a new certificate. Operation status: %s\n", *resp.Status)
 }
 
 func getCert(client *azcertificates.Client) {
-	getResp, err := client.GetCertificate(ctx, "myCertName", nil)
+	// an empty string version gets the latest version of the certificate
+	version := ""
+	getResp, err := client.GetCertificate(context.TODO(), "myCertName", version, nil)
 	if err != nil {
-		panic(err)
+		log.Fatal(err)
 	}
-	fmt.Println("Enabled set to:", *getResp.Properties.Enabled)
+	fmt.Println("Enabled set to:", *getResp.Attributes.Enabled)
 }
 
 func listCert(client *azcertificates.Client) {
-	poller := client.ListCertificates(nil)
-	for poller.NextPage(ctx) {
-		for _, cert := range poller.PageResponse().Certificates {
+	pager := client.NewListCertificatesPager(nil)
+	for pager.More() {
+		page, err := pager.NextPage(context.Background())
+		if err != nil {
+			log.Fatal(err)
+		}
+		for _, cert := range page.Value {
 			fmt.Println(*cert.ID)
 		}
 	}
-	if poller.Err() != nil {
-		panic(poller.Err)
-	}
 }
 
 func updateCert(client *azcertificates.Client) {
 	// disables the certificate, sets an expires date, and add a tag
-	_, err := client.UpdateCertificateProperties(ctx, "myCertName", &azcertificates.UpdateCertificatePropertiesOptions{
-		Version: "myNewVersion",
-		CertificateAttributes: &azcertificates.CertificateProperties{
-			Enabled: to.BoolPtr(false),
-			Expires: to.TimePtr(time.Now().Add(72 * time.Hour)),
+	params := azcertificates.UpdateCertificateParameters{
+		CertificateAttributes: &azcertificates.CertificateAttributes{
+			Enabled: to.Ptr(false),
+			Expires: to.Ptr(time.Now().Add(72 * time.Hour)),
 		},
-		Tags: map[string]string{"Owner": "SRE"},
-	})
+		Tags: map[string]*string{"Owner": to.Ptr("SRE")},
+	}
+	// an empty string version updates the latest version of the certificate
+	version := ""
+	_, err := client.UpdateCertificate(context.TODO(), "myCertName", version, params, nil)
 	if err != nil {
-		panic(err)
+		log.Fatal(err)
 	}
 	fmt.Println("Updated certificate properites: Enabled=false, Expires=72h, Tags=SRE")
 }
 
 func deleteCert(client *azcertificates.Client) {
-	pollerResp, err := client.BeginDeleteCertificate(ctx, "myCertName", nil)
-	if err != nil {
-		panic(err)
-	}
-	finalResp, err := pollerResp.PollUntilDone(ctx, time.Second)
+	// DeleteCertificate returns when Key Vault has begun deleting the certificate. That can take several
+	// seconds to complete, so it may be necessary to wait before performing other operations on the
+	// deleted certificate.
+	resp, err := client.DeleteCertificate(context.TODO(), "myCertName", nil)
 	if err != nil {
-		panic(err)
+		log.Fatal(err)
 	}
-	fmt.Println("Deleted certificate with ID: ", *finalResp.ID)
+	fmt.Println("Deleted certificate with ID: ", *resp.ID)
 }
 
 func main() {
@@ -211,103 +206,7 @@ go run main.go
 
 ## Code examples
 
-**Authenticate and create a client**
-
-```go
-cred, err := azidentity.NewDefaultAzureCredential(nil)
-if err != nil {
-  panic(err)
-}
-
-client, err = azcertificates.NewClient("https://my-key-vault.vault.azure.net/", cred, nil)
-if err != nil {
-  panic(err)
-}
-```
-
-**Create a certificate**
-
-```go
-resp, err := client.BeginCreateCertificate(context.TODO(), "myCert", azcertificates.CertificatePolicy{
-  IssuerParameters: &azcertificates.IssuerParameters{
-    Name: to.StringPtr("Self"),
-  },
-  X509CertificateProperties: &azcertificates.X509CertificateProperties{
-    Subject: to.StringPtr("CN=DefaultPolicy"),
-  },
-}, nil)
-if err != nil {
-  panic(err)
-}
-
-pollerResp, err := resp.PollUntilDone(context.TODO(), 1*time.Second)
-if err != nil {
-  panic(err)
-}
-fmt.Println(*pollerResp.ID)
-```
-
-**Get a certificate**
-
-```go
-getResp, err := client.GetCertificate(context.TODO(), "myCertName", nil)
-if err != nil {
-  panic(err)
-}
-fmt.Println(*getResp.ID)
-
-//optionally you can get a specific version
-getResp, err = client.GetCertificate(context.TODO(), "myCertName", &azcertificates.GetCertificateOptions{Version: "myCertVersion"})
-if err != nil {
-  panic(err)
-}
-```
-
-**List certificates**
-
-```go
-poller := client.ListCertificates(nil)
-for poller.NextPage(context.TODO()) {
-  for _, cert := range poller.PageResponse().Certificates {
-    fmt.Println(*cert.ID)
-  }
-}
-if poller.Err() != nil {
-  panic(err)
-}
-```
-
-**Update a certificate**
-
-```go
-_, err := client.UpdateCertificateProperties(context.TODO(), "myCertName", &azcertificates.UpdateCertificatePropertiesOptions{
-  Version: "myNewVersion",
-  CertificateAttributes: &azcertificates.CertificateProperties{
-    Enabled: to.BoolPtr(false),
-    Expires: to.TimePtr(time.Now().Add(72 * time.Hour)),
-  },
-  Tags: map[string]string{"Owner": "SRE"},
-})
-if err != nil {
-  panic(err)
-}
-```
-
-**Delete a certificate**
-
-```go
-pollerResp, err := client.BeginDeleteCertificate(context.TODO(), "myCertName", nil)
-if err != nil {
-  panic(err)
-}
-finalResp, err := pollerResp.PollUntilDone(context.TODO(), time.Second)
-if err != nil {
-  panic(err)
-}
-
-fmt.Println("Deleted certificate with ID: ", *finalResp.ID)
-```
-
+See the [module documentation](https://aka.ms/azsdk/go/keyvault-certificates/docs) for more examples.
 
 ## Clean up resources