azure

Documentation

Index

• func GetBearerTokenAuthorizer(azureEnvironment azure.Environment, tenantID string, clientID string, ...) (*autorest.BearerAuthorizer, error)
• func GetEnvironmentName() string
• func IsValidLocation(location string) bool
• func LocationValidator(context, val string) error
• type Config
  • func GetConfigFromEnvironment() (Config, error)
  • func NewConfigWithDefaults() Config

Functions

func GetBearerTokenAuthorizer

func GetBearerTokenAuthorizer(
	azureEnvironment azure.Environment,
	tenantID string,
	clientID string,
	clientSecret string,
) (*autorest.BearerAuthorizer, error)

GetBearerTokenAuthorizer returns a *autorest.BearerAuthorizer used for authenticating outbound requests to the Azure APIs

func GetEnvironmentName

func GetEnvironmentName() string

GetEnvironmentName returns the name of cloud environment. Expected return vaules are: ["AzurePublicCloud", "AzureChinaCloud"]

func IsValidLocation

func IsValidLocation(location string) bool

IsValidLocation returns a bool indicating whether the provided location is a valid one

func LocationValidator

func LocationValidator(context, val string) error

LocationValidator is a custom schema validator that validates a specified location is a real Azure region.

Types

type Config

type Config struct {
	Environment    azure.Environment
	SubscriptionID string `envconfig:"SUBSCRIPTION_ID" required:"true"`
	TenantID       string `envconfig:"TENANT_ID" required:"true"`
	ClientID       string `envconfig:"CLIENT_ID" required:"true"`
	ClientSecret   string `envconfig:"CLIENT_SECRET" required:"true"`
}

Config represents details necessary for the broker to interact with an Azure subscription

func GetConfigFromEnvironment

func GetConfigFromEnvironment() (Config, error)

GetConfigFromEnvironment returns Azure-related configuration derived from environment variables

func NewConfigWithDefaults

func NewConfigWithDefaults() Config

NewConfigWithDefaults returns a Config object with default values already applied. Callers are then free to set custom values for the remaining fields and/or override default values.