azure

Documentation

Overview

Package azure provides utilities to load, parse, and validate Azure cloud configuration.

Index

• type CloudConfig
  • func NewCloudConfigFromFile(filePath string) (*CloudConfig, error)
  • func (cfg *CloudConfig) SetUserAgent(userAgent string)

Types

type CloudConfig

type CloudConfig struct {
	azclient.ARMClientConfig `json:",inline" mapstructure:",squash"`
	azclient.AzureAuthConfig `json:",inline" mapstructure:",squash"`
	*ratelimit.Config        `json:",inline" mapstructure:",squash"` // if nil, the rate limiting will be enabled by default

	// azure resource location
	Location string `json:"location,omitempty" mapstructure:"location,omitempty"`
	// subscription ID
	SubscriptionID string `json:"subscriptionID,omitempty" mapstructure:"subscriptionID,omitempty"`
	// default resource group where the azure resources are deployed
	ResourceGroup string `json:"resourceGroup,omitempty" mapstructure:"resourceGroup,omitempty"`
	// name of the virtual network of cluster
	VnetName string `json:"vnetName,omitempty" mapstructure:"vnetName,omitempty"`
	// name of the resource group where the virtual network is deployed
	VnetResourceGroup string `json:"vnetResourceGroup,omitempty" mapstructure:"vnetResourceGroup,omitempty"`
}

CloudConfig holds the configuration parsed from the --cloud-config flag.

func NewCloudConfigFromFile

func NewCloudConfigFromFile(filePath string) (*CloudConfig, error)

NewCloudConfigFromFile loads cloud config from a file given the file path.

func (*CloudConfig) SetUserAgent

func (cfg *CloudConfig) SetUserAgent(userAgent string)

SetUserAgent sets the user agent string to access Azure resources.