Azure App Platform Module for Go
The armappplatform
module provides operations for working with Azure App Platform.
Source code
Getting started
Prerequisites
- an Azure subscription
- Go 1.18 or above (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.)
Install the package
This project uses Go modules for versioning and dependency management.
Install the Azure App Platform module:
go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform
Authorization
When creating a client, you will need to provide a credential for authenticating with Azure App Platform. The azidentity
module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.
cred, err := azidentity.NewDefaultAzureCredential(nil)
For more information on authentication, please see the documentation for azidentity
at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.
Client Factory
Azure App Platform module consists of one or more clients. We provide a client factory which could be used to create any client in this module.
clientFactory, err := armappplatform.NewClientFactory(<subscription ID>, cred, nil)
You can use ClientOptions
in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm
to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore
at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.
options := arm.ClientOptions {
ClientOptions: azcore.ClientOptions {
Cloud: cloud.AzureChina,
},
}
clientFactory, err := armappplatform.NewClientFactory(<subscription ID>, cred, &options)
Clients
A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.
client := clientFactory.NewAppsClient()
Provide Feedback
If you encounter bugs or have suggestions, please
open an issue and assign the App Platform
label.
Contributing
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, 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 repos 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
additional questions or comments.