armauth

Documentation

Index

• Constants
• func GetAuthMethod() string
• func NewARMCredential(opt *Options) (azcore.TokenCredential, error)
• type ArmConfig
  • func NewArmConfig(opt *Options) (*ArmConfig, error)
• type Options

Constants

const (
	UCPCredentialAuth    = "UCPCredential"
	ServicePrincipalAuth = "ServicePrincipal"
	WorkloadIdentityAuth = "WorkloadIdentity"
	ManagedIdentityAuth  = "ManagedIdentity"
	CliAuth              = "CLI"
)

Authentication methods

Functions

func GetAuthMethod

func GetAuthMethod() string

GetAuthMethod returns the authentication method to use based on environment variables.

func NewARMCredential

func NewARMCredential(opt *Options) (azcore.TokenCredential, error)

NewARMCredential evaluates the authentication method and returns the appropriate credential.

Types

type ArmConfig

type ArmConfig struct {
	// ClientOptions is the client options for Azure SDK client.
	ClientOptions clientv2.Options
}

ArmConfig is the configuration we use for managing ARM resources

func NewArmConfig

func NewArmConfig(opt *Options) (*ArmConfig, error)

NewArmConfig creates a new ArmConfig instance with the given options, or default options if none are provided, and returns it or an error if one occurs.

type Options

type Options struct {
	// CredentialProvider is an UCP credential client for Azure service principal.
	CredentialProvider sdk_cred.CredentialProvider[sdk_cred.AzureCredential]
}

Options represents the options of ArmConfig.