Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

environment

package

Go to main page

Versions in this module

v1

v1.24.2

Apr 25, 2026

v1.24.1

Apr 18, 2026

v1.24.0

Apr 15, 2026

v1.23.15

Apr 11, 2026

v1.23.14

Apr 4, 2026

Changes in this version

+ func InvalidEnvironmentNameError(name string) error

v1.23.13

Mar 26, 2026

Changes in this version

+ const AksClusterEnvVarName

+ const AppServiceAspireDashboardUrlEnvVarName

+ const AzdInitialEnvironmentConfigName

+ const ConfigFileName

+ const ContainerEnvironmentEndpointEnvVarName

+ const ContainerRegistryEndpointEnvVarName

+ const DotEnvFileName

+ const EnvNameEnvVarName

+ const LocationEnvVarName

+ const PlatformTypeEnvVarName

+ const PrincipalIdEnvVarName

+ const PrincipalTypeEnvVarName

+ const ResourceGroupEnvVarName

+ const SubscriptionIdEnvVarName

+ const TenantIdEnvVarName

+ var EnvironmentNameMaxLength = 64

+ var EnvironmentNameRegexp = regexp.MustCompile(`^[a-zA-Z0-9-\(\)_\.]{1,64}$`)

+ var ErrAccessDenied = errors.New("access denied connecting Azure Blob Storage container.")

+ var ErrDefaultEnvironmentNotFound = errors.New("default environment not found")

+ var ErrExists = errors.New("environment already exists")

+ var ErrInvalidContainer = errors.New("storage container name is invalid.")

+ var ErrNameNotSpecified = errors.New("environment not specified")

+ var ErrNotFound = errors.New("environment not found")

+ var ValidRemoteKinds = []string

+ func CleanName(name string) string

+ func IsValidEnvironmentName(name string) bool

+ func Key(name string) string

+ type DataStore interface

+ ConfigPath func(env *Environment) string

+ Delete func(ctx context.Context, name string) error

+ EnvPath func(env *Environment) string

+ Get func(ctx context.Context, name string) (*Environment, error)

+ List func(ctx context.Context) ([]*contracts.EnvListEnvironment, error)

+ Reload func(ctx context.Context, env *Environment) error

+ Save func(ctx context.Context, env *Environment, options *SaveOptions) error

+ type Description struct

+ DotEnvPath string

+ HasLocal bool

+ HasRemote bool

+ IsDefault bool

+ Name string

+ type Environment struct

+ Config config.Config

+ func New(name string) *Environment

+ func NewWithValues(name string, values map[string]string) *Environment

+ func (e *Environment) Dotenv() map[string]string

+ func (e *Environment) DotenvDelete(key string)

+ func (e *Environment) DotenvSet(key string, value string)

+ func (e *Environment) Environ() []string

+ func (e *Environment) GetLocation() string

+ func (e *Environment) GetServiceProperty(serviceName string, propertyName string) string

+ func (e *Environment) GetSubscriptionId() string

+ func (e *Environment) GetTenantId() string

+ func (e *Environment) Getenv(key string) string

+ func (e *Environment) LookupEnv(key string) (string, bool)

+ func (e *Environment) Name() string

+ func (e *Environment) SetLocation(location string)

+ func (e *Environment) SetServiceProperty(serviceName string, propertyName string, value string)

+ func (e *Environment) SetSubscriptionId(id string)

+ type EnvironmentInitError struct

+ Name string

+ func NewEnvironmentInitError(envName string) *EnvironmentInitError

+ func (err *EnvironmentInitError) Error() string

+ type EnvironmentResolver func(ctx context.Context) (*Environment, error)

+ type LocalDataStore DataStore

+ func NewLocalFileDataStore(azdContext *azdcontext.AzdContext, configManager config.FileConfigManager) LocalDataStore

+ type LocalFileDataStore struct

+ func (fs *LocalFileDataStore) ConfigPath(env *Environment) string

+ func (fs *LocalFileDataStore) Delete(ctx context.Context, name string) error

+ func (fs *LocalFileDataStore) EnvPath(env *Environment) string

+ func (fs *LocalFileDataStore) Get(ctx context.Context, name string) (*Environment, error)

+ func (fs *LocalFileDataStore) List(ctx context.Context) ([]*contracts.EnvListEnvironment, error)

+ func (fs *LocalFileDataStore) Reload(ctx context.Context, env *Environment) error

+ func (fs *LocalFileDataStore) Save(ctx context.Context, env *Environment, options *SaveOptions) error

+ type Manager interface

+ ConfigPath func(env *Environment) string

+ Create func(ctx context.Context, spec Spec) (*Environment, error)

+ Delete func(ctx context.Context, name string) error

+ EnvPath func(env *Environment) string

+ Get func(ctx context.Context, name string) (*Environment, error)

+ GetStateCacheManager func() *state.StateCacheManager

+ InvalidateEnvCache func(ctx context.Context, envName string) error

+ List func(ctx context.Context) ([]*Description, error)

+ LoadOrInitInteractive func(ctx context.Context, name string) (*Environment, error)

+ Reload func(ctx context.Context, env *Environment) error

+ Save func(ctx context.Context, env *Environment) error

+ SaveWithOptions func(ctx context.Context, env *Environment, options *SaveOptions) error

+ func NewManager(serviceLocator ioc.ServiceLocator, azdContext *azdcontext.AzdContext, ...) (Manager, error)

+ type RemoteDataStore DataStore

+ func NewStorageBlobDataStore(configManager config.Manager, blobClient storage.BlobClient) RemoteDataStore

+ type RemoteKind string

+ const RemoteKindAzureBlobStorage

+ type SaveOptions struct

+ IsNew bool

+ type Spec struct

+ Examples []string

+ Location string

+ Name string

+ Subscription string

+ type StorageBlobDataStore struct

+ func (fs *StorageBlobDataStore) ConfigPath(env *Environment) string

+ func (fs *StorageBlobDataStore) EnvPath(env *Environment) string

+ func (sbd *StorageBlobDataStore) Delete(ctx context.Context, name string) error

+ func (sbd *StorageBlobDataStore) Get(ctx context.Context, name string) (*Environment, error)

+ func (sbd *StorageBlobDataStore) List(ctx context.Context) ([]*contracts.EnvListEnvironment, error)

+ func (sbd *StorageBlobDataStore) Reload(ctx context.Context, env *Environment) error

+ func (sbd *StorageBlobDataStore) Save(ctx context.Context, env *Environment, options *SaveOptions) error

+ type TargetResource struct

+ func NewTargetResource(subscriptionId string, resourceGroupName string, resourceName string, ...) *TargetResource

+ func (ds *TargetResource) Metadata() map[string]string

+ func (ds *TargetResource) ResourceGroupName() string

+ func (ds *TargetResource) ResourceName() string

+ func (ds *TargetResource) ResourceType() string

+ func (ds *TargetResource) SetMetadata(metadata map[string]string)

+ func (ds *TargetResource) SubscriptionId() string