aztfexport

The tool automates the process of bringing existing Azure resources under Terraform management by performing the following steps:

1. Identification: Uses aztft to map an Azure resource ID to the corresponding Terraform resource type.
2. Import: Executes terraform import under the hood for each identified resource.
3. Configuration Generation: Uses tfadd to generate the Terraform HCL code for each imported resource.

The goal is to produce a Terraform state and configuration that are consistent with the remote Azure state, such that a terraform plan shows no differences.

Configuration is stored in $HOME/.aztfexport/config.json. You should manage this file using the aztfexport config command.

Subcommands

• get: Retrieve a specific configuration item.
• set: Update a configuration item.
• show: Display the entire configuration.

Supported Config Items

• installation_id: A UUID used as an identifier in telemetry traces. If Azure CLI or Azure PowerShell is present, this ID remains consistent across those tools.
• telemetry_enabled: A boolean to enable or disable telemetry. Set to false to opt-out.

The aztfexportclient package provides a set of tea.Cmd functions designed to be used within a Bubble Tea application. These functions wrap operations performed on a meta.Meta instance and return messages (tea.Msg) that the Bubble Tea program can handle to update its state or trigger UI changes.

Each function typically follows this pattern:

1. It accepts a context.Context and a meta.Meta object.
2. It returns a tea.Cmd.
3. When executed by the Bubble Tea runtime, the command performs the requested operation (e.g., listing resources, importing items, generating configuration).
4. It returns either an ErrMsg on failure or a specific success message (e.g., ListResourceDoneMsg, ImportItemsDoneMsg) on success.

The aztfexport CLI operates in several distinct modes, which determine the scope and target of the export process. These modes are defined by the Mode type:

• resource: Export a specific Azure resource.
• resource-group: Export all resources within a specific resource group.
• query: Export resources based on a query pattern.
• mapping-file: Use a mapping file to drive the export.

When initializing an OidcCredential via NewOidcCredential, use the OidcCredentialOptions struct to provide the necessary authentication parameters:

• TenantID: The Azure AD tenant ID.
• ClientID: The application (client) ID.
• RequestToken: The bearer token used to authorize the request to the OIDC provider.
• RequestUrl: The URL from which to fetch the JWT assertion.
• Token: (Optional) If provided, this static token is used directly as the assertion instead of making an HTTP request.
• ClientOptions: Standard azcore.ClientOptions for the underlying Azure SDK client.

type OidcCredentialOptions struct {
	azcore.ClientOptions
	TenantID     string
	ClientID     string
	RequestToken string
	RequestUrl   string
	Token        string
}

Use CleanUpWorkspace to perform workspace cleanup operations. On success, it returns WorkspaceCleanupDoneMsg.

cmd := aztfexportclient.CleanUpWorkspace(ctx, meta)

Use Init to initialize the underlying provider. If successful, it returns an InitProviderDoneMsg. If it fails, it returns an ErrMsg.

cmd := aztfexportclient.Init(ctx, meta)

To initialize the UI client with existing metadata, use NewClient. This returns a NewClientMsg containing the meta.Meta object.

import "github.com/Azure/aztfexport/internal/ui/aztfexportclient"

// Inside a Bubble Tea Update or Init function:
cmd := aztfexportclient.NewClient(meta)