azure-samples/azure-sdk-for-go-samples

Examples of how to utilize Azure services from Go.

languages	products	page_type	description
go	azure	sample	A collection of samples showing how to use the Azure SDK for Go.

Azure SDK for Go Samples

This repo contains a collection of sample usages of the new version of Azure/azure-sdk-for-go. All the samples are placed under sdk folder and the folder structures are corresponding to the service packages under the /sdk directory of the Azure/azure-sdk-for-go repo. You can refer to this doc to get started with Azure SDK for Go.

For general SDK help, please refer to the SDK README.

To run tests

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.

Using Azure CLI to Sign In

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

If your code is going to run in a none-user-interactive environment, you can also authenticate by setting environment variables as below.

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__"
  

Run tests

1. Clone the repository.

   git clone https://github.com/Azure-Samples/azure-sdk-for-go-samples.git
   

2. Set the environment variable.

   # bash
   export AZURE_SUBSCRIPTION_ID=<your Azure subscription id> 
   # If no value is set, the created resource will be deleted by default.
   # anything other than empty to keep the resources
   export KEEP_RESOURCE=1 
   
   # powershell
   $env:AZURE_SUBSCRIPTION_ID=<your Azure subscription id> 
   $env:KEEP_RESOURCE=1
   

3. Choose one sample and run.

   cd azure-sdk-for-go-samples/sdk/resourcemanager/<service>/<single sample>
   go run main.go
   

Resources

• SDK code is at Azure/azure-sdk-for-go.
• SDK docs are at godoc.org.
• SDK notifications are published via the Azure update feed.
• Azure API docs are at docs.microsoft.com/rest/api.
• General Azure docs are at docs.microsoft.com/azure.

License

This code is provided under the MIT license. See LICENSE for details.

Contribute

We welcome your contributions! For instructions and our code of conduct see CONTRIBUTING.md. And thank you!

azure-sdk-for-go-samples's Issues

[aad] add service principal authorization sample

Can we create a sample showing how to assign a service principal rights to a subscription, and rights to a specific resource? This would utilize RoleDefinitions and RoleAssignments from the authorization service. Thanks!

deprecate other samples in this org

• at least the ones which have an equivalent here

Run samples continuously

run cronjobs at specific hours

[cosmos] add Cosmos/MongoDB samples

• migrate https://github.com/Azure-Samples/azure-cosmos-db-mongodb-golang-getting-started
• also see https://docs.microsoft.com/en-us/azure/cosmos-db/create-mongodb-golang

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [x] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

[aad] add Azure CLI auth file sample

use https://github.com/Azure/go-autorest/blob/master/autorest/azure/auth/authfile.go

[aad] add service principal creation sample

Can we create a sample which shows how to create a new service principal and get a client ID and secret? It would use the graphrbac service. Thanks!

add test job against sdk dev branch

We currently test against the master branch in the SDK repo: http://azuresdkci.cloudapp.net/view/golang/job/azure-sdk-for-go-samples/

Can we add a test against the dev branch so we can prep for upcoming releases?

[groups] migrate remaining group & resource samples

• https://github.com/Azure-Samples/resource-manager-go-resources-and-groups
• https://github.com/Azure-Samples/resource-manager-go-template-deployment

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [x] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

[cognitive] Add Stable Cognitive Service SDK sample

Samples app ID does not have enough permissions to create AD apps

bee3737f-b06f-444f-b3c3-5b0f3fce46ea client ID can't be used to create Active Directory apps. It fails with 403. But the Azure CLI client ID has enough permissions: 04b07795-8ddb-461a-bbee-02f9e1bf7b46.
cc @joshgav

[storage] add additional blob operations

Port remaining blob operations
from https://github.com/Azure-Samples/storage-blob-go-getting-started/blob/master/storageExample.go
to https://github.com/Azure-Samples/azure-sdk-for-go-samples/blob/master/storage/blockblob.go

[dns] add DNS sample

migrate DNS sample from main repo: https://github.com/Azure/azure-sdk-for-go/tree/f111fc2fa3861c5fdced76cae4c9c71821969577/arm/examples/dns

Sample for auth code using x/oauth2

Thanks for your contributions and feedback to the samples for Go on Azure!

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [ ] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

Related errors and log messages

Expected/desired behavior

OS and Go version

Windows version, Linux distribution and version, macOS version.
Go version

Thanks again!

Dev and master branch should be synced often

Dev branch is running tests using the sdk and runtime dev branches. For that reason, a different dep file is needed so dep ensure can pull the correct repo branches. SO dev and master branches in this repo should be synced, with the only difference being the dep file

Thank you for your contribution and feedback! Help us review faster by providing the following information:

This issue is a: (mark with an x)

• bug report
• request for new sample
• documentation issue or request
• regression (a behavior that used to work and stopped in a new release)

Steps to reproduce:

Errors and log messages:

Expected behavior:

OS and Go versions:

Further info:

[keyvault] migrate keyvault samples

Include:

• resource management for Vaults
• operations for Keys, Secrets, and Certificates
• sample for deploying certs to a VM
• sample for utilizing secrets in a web app to call a third-party service

A resource management sample available at https://github.com/Azure-Samples/key-vault-go-manage.

Add master to Travis

Should be enough to specify 1.10beta2 ( not 1.10.x or anything else).

Create a single resource group per test package

Packages with more than a single example use the same resource group name. When running the examples with go test, the second example running cannot start properly creating the resource group because a resource group with the same name is being deleted on Azure. Maybe we could fix this with a single setup and teardown for all tests in the same package (all tests would run in exactly the same resource group, without deleting / creating it again in between).

Thanks for your contributions and feedback to the samples for Go on Azure!

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [ ] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

Related errors and log messages

Expected/desired behavior

OS and Go version

Windows version, Linux distribution and version, macOS version.
Go version

Thanks again!

Add slack notifications

Thank you for your contribution and feedback! Help us review faster by providing the following information:

This issue is a: (mark with an x)

• bug report
• request for new sample
• documentation issue or request
• regression (a behavior that used to work and stopped in a new release)

Steps to reproduce:

Errors and log messages:

Expected behavior:

OS and Go versions:

Further info:

Parse test results

[containerinstance] Add Azure Container Instance samples

Lately I have been working with the Azure Container Instance SDK - do you think it would help if I added samples here?

You can take a look at what I've been doing here.

The samples would contain probably the creation, list, update and delete of container / container groups.

Thanks!

Add Sample Web App which uses OAuth2 authorization code

The flow can seem a little convoluted and since it's not usable directly (i.e. needs to be used in a web app) we should add a sample just for that.

Link in comments to Azure REST API Reference

Most of the time I'm using an Azure SDK I end up looking at the REST API Reference to better understand required parameters and see some examples.

Do you think it would be a good idea to include, before each method, a link to the REST API method page?

Example for Azure Container Instance CreateOrUpdate

Thanks,
Radu M

update env vars for public Travis

Thank you for your contribution and feedback! Help us review faster by providing the following information:

This issue is a: (mark with an x)

• bug report
• request for new sample
• documentation issue or request
• regression (a behavior that used to work and stopped in a new release)

[compute] add VM with MSI sample

move
from: https://github.com/Azure-Samples/compute-go-msi-vm/blob/master/main.go
to: https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/compute, perhaps a file named vm_msi.go?

append to user-agent string for all requests

to help us track usage of this repo let's append a name to the user-agent string. is there a relevant version string to include too?

[key vault] add samples for managing keys, secrets, and certificates

• manage keys with Key Vault

• manage secrets with Key Vault

• manage certificates with Key Vault

• deploy certs to a VM for use in serving https web app

• use secrets in a VM to specify third-party API keys

add license headers to all files

[compute] add compute sample

• https://github.com/Azure-Samples/virtual-machines-go-manage
• https://github.com/Azure-Samples/arm-compute-go-vm-extensions
• https://github.com/Azure-Samples/compute-go-msi-vm

fix main test job

latest commits led to failure in Jenkins tests, we need to fix

http://azuresdkci.cloudapp.net/view/golang/job/azure-sdk-for-go-samples/

[compute] add VM operations samples

Move VM management operations
from: https://github.com/Azure-Samples/virtual-machines-go-manage/blob/master/example.go#L264
to: https://github.com/Azure-Samples/azure-sdk-for-go-samples/blob/master/compute - perhaps a new file titled vm_operations.go?

update samples for v12

v12 will be released in the coming days and existing samples will need to be updated.

add README.md files to directories

Thank you for your contribution and feedback! Help us review faster by providing the following information:

This issue is a: (mark with an x)

• bug report
• request for new sample
• documentation issue or request
• regression (a behavior that used to work and stopped in a new release)

Further info:

The official Microsoft site documentation for Azure SDK for Go (docs.microsoft.com/go/azure) links to the following sample directories without a README.md:

• https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/compute
• https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/containerinstance
• https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/containerservice

There should be at least a short README in these directories so that users have more context after following links from the documentation site to the samples.

[network] add load balancer sample

move
from https://github.com/Azure-Samples/network-go-manage-loadbalancer/blob/master/example.go
to https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/network, loadbalancer.go file

[storage] update storage sample

migrate all demonstrated operations from:

• https://github.com/Azure-Samples/storage-blob-go-getting-started
• https://github.com/Azure-Samples/storage-go-resource-provider-getting-started

consolidate existing samples in this org

• https://github.com/Azure-Samples/resources-go-manage-resources-with-msi
• https://github.com/Azure-Samples/service-bus-go-management
• https://github.com/Azure-Samples/app-service-web-go-manage

Tracked in #22

• https://github.com/Azure-Samples/resource-manager-go-resources-and-groups
• https://github.com/Azure-Samples/resource-manager-go-template-deployment

Tracked in #21

• https://github.com/Azure-Samples/network-go-manage-network-security-group
• https://github.com/Azure-Samples/network-go-manage-loadbalancer
• https://github.com/Azure-Samples/network-go-manage-network-interface

Tracked in #20

• https://github.com/Azure-Samples/azure-cosmos-db-mongodb-golang-getting-started

Tracked in #8

• https://github.com/Azure-Samples/key-vault-go-manage

Tracked in #2

• https://github.com/Azure-Samples/virtual-machines-go-manage
• https://github.com/Azure-Samples/arm-compute-go-vm-extensions
• https://github.com/Azure-Samples/compute-go-msi-vm

Tracked in #1

• https://github.com/Azure-Samples/storage-go-resource-provider-getting-started
• https://github.com/Azure-Samples/storage-blob-go-getting-started

Container Instance examples cannot be run alone

All 4 examples depend on each other. They should be able to run on their own

Thanks for your contributions and feedback to the samples for Go on Azure!

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [ ] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

Related errors and log messages

Expected/desired behavior

OS and Go version

Windows version, Linux distribution and version, macOS version.
Go version

Thanks again!

Samples should include both ARM and dataplane

Combine ARM and dataplane call;s in examples.
Example: in the same sample, create a storage account, and upload blobs.

[network] migrate remaining network samples

Make sure existing samples are covered in network/ dir:

• https://github.com/Azure-Samples/network-go-manage-loadbalancer
• https://github.com/Azure-Samples/network-go-manage-network-security-group
• https://github.com/Azure-Samples/network-go-manage-network-interface

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [x] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

PrintAndLog formatting

Hi, everyone!
Started working on #28 and stumbled upon PrintAndLog:

// PrintAndLog writes to stdout and to a logger.
func PrintAndLog(message string) {
	log.Println(message)
	fmt.Println(message)
}

The main issue I have with this is that I cannot pass formatted messages - do you think something like below would work?

// PrintfAndLog writes to stdout and to a logger.
func PrintfAndLog(format string, args ...interface{}) {
	log.Printf(format, args...)
	fmt.Printf(format, args...)
}

Also, why do we do both log.Print and fmt.Print?

Update: after using this with the actual test, I understand the need for both - the question is whether we also need to have one with the ability to format the message, as above - maybe PrintfAndLog?

Example of usage for method above here:

helpers.PrintAndLog(fmt.Sprintf("container group name: %v", *c.Name))

The question is whether this is a valid use case, or the print and log should only be used for well known // Output messages.

An alternative would be to use the testing package.

Thanks,
Radu M

[compute] add VM extensions sample

move
from: https://github.com/Azure-Samples/arm-compute-go-vm-extensions
to: https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/compute

What are these samples meant to show? Do they overlap with #103? If possible would be great to cut the code down to just the additional functionality this shows. Thanks!

add automated testing via Travis

Let's add automated testing via Travis so contributors and reviewers learn quickly if there are problems with their code.

We'll have to add secrets to Travis, and then I think our first step would be to run go test ./....

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [x] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

[webapps] Azure Web Apps samples

Hi, everyone!
I'm starting to look at adding the web apps examples and I'm trying to understand what the most important operations would be, as the operation list for web apps is quite long.

Besides the usual create, list, delete operations, which ones do you think should be part of the samples (like creating a deployment slot, starting, stopping, swapping slots...)

Thanks,
Radu M

add flag to choose between OAuth grant types

The SDK and the iam/ directory in this repo support both the Client Credentials (az Service Principal) OAuth grant type and the Device Flow grant type. Currently the grant type is selected here:

azure-sdk-for-go-samples/iam/oauth.go

Line 58 in aea69c0

func GetResourceManagementToken(grantType OAuthGrantType) (adal.OAuthTokenProvider, error) {

.

Can we make selection of the grant type configurable via flag and/or env var? Thanks!

Here's an article on the different grant types: https://alexbilbie.com/guide-to-oauth-2-grants/

This issue is a: (mark with an x)

- [ ] bug report (consider searching issues before submitting)
- [x] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Modify to use helpers to get Authorizer from env when go-autorest 10.0.0 is released

publish this repo

content in this repo isn't sensitive, so I think as soon as the structure is satisfactory we should make it public. thoughts? objections?

Starting a list of items to complete prior to publication:

• Write README (#23)
• Update code for SDK v12 (#29)
• Make sure Travis tests run (#25)

/cc @sptramer @salameer @marstr

migrate examples from SDK repo here

https://github.com/Azure/azure-sdk-for-go/tree/master/arm/examples

[go-autorest] show how to introspect requests

available in #33

Investigate run tests in parallel

Tests are taking quite long to run, can we run some of them in parallel ?

[storage] add storage keys sample

Migrate remaining operations
from: https://github.com/Azure-Samples/storage-go-resource-provider-getting-started/blob/master/example.go
to: https://github.com/Azure-Samples/azure-sdk-for-go-samples/blob/master/storage/account.go

write README