Interface BaseMeta

internal/meta/base_meta.go:51–87

type TFConfigTransformer func(configs ConfigInfos) (ConfigInfos, error)

type BaseMeta interface {
	// Logger returns a slog.Logger
	Logger() *slog.Logger
	// ProviderName returns the target provider name, which is either azurerm or azapi.
	ProviderName() string
	// Init initializes the base meta, including initialize terraform, provider and soem runtime temporary resources.
	Init(ctx context.Context) error
	// DeInit deinitializes the base meta, including cleaning up runtime temporary resources.
	DeInit(ctx context.Context) error
	// Workspace returns the path of the output directory.
	Workspace() string
	// ParallelImport imports the specified import list in parallel (parallelism is set during the meta builder function).
	// Import error won't be returned in the error, but is recorded in each ImportItem.
	ParallelImport(ctx context.Context, items []*ImportItem) error
	// PushState pushes the terraform state file (the base state of the workspace, adding the newly imported resources) back to the workspace.
	PushState(ctx context.Context) error
	// CleanTFState clean up the specified TF resource from the workspace's state file.
	CleanTFState(ctx context.Context, addr string)
	// GetTerraformCfg generates the TF configuration from the import list. Only resources successfully imported will be processed.
	GetTerraformCfg(ctx context.Context, l ImportList) ([]byte, error)
	// WriteTerraformCfg writes the TF configuration generated from the import list. Only resources successfully imported will be processed.
	WriteTerraformCfg(ctx context.Context, l ImportList) error
	// GetSkippedResources get list of resources that are skipped to be imported.
	GetSkippedResources(ctx context.Context, l ImportList) []string
	// WriteSkippedResources writes a file listing record resources that are skipped to be imported to the output directory.
	WriteSkippedResources(ctx context.Context, l ImportList) error
	// GetImportBlocks get a list of TF import blocks of the importing resources.
	GetImportBlocks(ctx context.Context, l ImportList) []byte
	// WriteResourceMapping writes a resource mapping file to the output directory. In case import block generation is specified, a TF import block file will also be generated.
	WriteResourceMapping(ctx context.Context, l ImportList) error
	// CleanUpWorkspace is a weired method that is only meant to be used internally by aztfexport, which under the hood will remove everything in the output directory, except the generated TF config.
	// This method does nothing if HCLOnly in the Config is not set.
	CleanUpWorkspace(ctx context.Context) error

	SetPreImportHook(config.ImportCallback)
	SetPostImportHook(config.ImportCallback)
}

var _ BaseMeta = &baseMeta{}