authentication

Documentation

Index

• func DetermineEnvironment(name string) (*azure.Environment, error)
• func LoadEnvironmentFromUrl(endpoint string) (*azure.Environment, error)
• type Builder
  • func (b Builder) Build() (*Config, error)
• type Config
  • func (c Config) GetAuthorizationToken(oauthConfig *adal.OAuthConfig, endpoint string) (*autorest.BearerAuthorizer, error)

Functions

func DetermineEnvironment

func DetermineEnvironment(name string) (*azure.Environment, error)

DetermineEnvironment determines what the Environment name is within the Azure SDK for Go and then returns the association environment, if it exists.

func LoadEnvironmentFromUrl

func LoadEnvironmentFromUrl(endpoint string) (*azure.Environment, error)

LoadEnvironmentFromUrl attempts to load the specified environment from the endpoint. if the endpoint is an empty string, or an environment can't be found at the endpoint url then an error is returned

Types

type Builder

type Builder struct {
	// Core
	ClientID       string
	SubscriptionID string
	TenantID       string
	Environment    string

	// The custom Resource Manager Endpoint which should be used
	// only applicable for Azure Stack at this time.
	CustomResourceManagerEndpoint string

	// Azure CLI Tokens Auth
	SupportsAzureCliToken bool

	// Managed Service Identity Auth
	SupportsManagedServiceIdentity bool
	MsiEndpoint                    string

	// Service Principal (Client Cert) Auth
	SupportsClientCertAuth bool
	ClientCertPath         string
	ClientCertPassword     string

	// Service Principal (Client Secret) Auth
	SupportsClientSecretAuth bool
	ClientSecret             string
}

Builder supports all of the possible Authentication values and feature toggles required to build a working Config for Authentication purposes.

func (Builder) Build

func (b Builder) Build() (*Config, error)

Build takes the configuration from the Builder and builds up a validated Config for authenticating with Azure

type Config

type Config struct {
	ClientID                         string
	SubscriptionID                   string
	TenantID                         string
	Environment                      string
	AuthenticatedAsAServicePrincipal bool

	// A Custom Resource Manager Endpoint
	// at this time this should only be applicable for Azure Stack.
	CustomResourceManagerEndpoint string
	// contains filtered or unexported fields
}

Config is the configuration structure used to instantiate a new Azure management client.

func (Config) GetAuthorizationToken

func (c Config) GetAuthorizationToken(oauthConfig *adal.OAuthConfig, endpoint string) (*autorest.BearerAuthorizer, error)

GetAuthorizationToken returns an authorization token for the authentication method defined in the Config