Skip to content

export-terraform-overview.md: inform user about portal vs CLI distinction #1474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gerrytan wants to merge 4 commits into
base: main
Choose a base branch
from
Open

export-terraform-overview.md: inform user about portal vs CLI distinction #1474

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2bb9ad9
export-terraform-overview.md: inform user about portal v CLI distinction
gerrytan Dec 2, 2025
3841e76
Improve accuracy of partial export / property support
gerrytan Dec 3, 2025
1d949ef
AI PR feedback: grammar and typos
gerrytan Dec 3, 2025
422a0e4
AI PR feedback: use 'the' article
gerrytan Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions articles/terraform/azure-export-for-terraform/export-terraform-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Overview of Azure Export for Terraform
description: Learn the benefits and uses of Azure Export for Terraform
title: Overview of Azure Export for Terraform CLI
description: Learn the benefits and uses of Azure Export for Terraform CLI
ms.topic: overview
ms.date: 05/10/2023
ms.author: stema
ms.custom: devx-track-terraform,devx-track-export-terraform
---

# Overview of Azure Export for Terraform
# Overview of Azure Export for Terraform CLI

Azure Export for Terraform is a tool designed to help reduce friction in translation between Azure and Terraform concepts.
Azure Export for Terraform (`aztfexport`) is CLI a tool designed to help reduce friction in translation between Azure and Terraform concepts. This tool complements the [portal Terraform export experience](get-started-export-resources-portal.md).
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar error: "is CLI a tool" should be "is a CLI tool". The word order is incorrect.

Suggested change
Azure Export for Terraform (`aztfexport`) is CLI a tool designed to help reduce friction in translation between Azure and Terraform concepts. This tool complements the [portal Terraform export experience](get-started-export-resources-portal.md).
Azure Export for Terraform (`aztfexport`) is a CLI tool designed to help reduce friction in translation between Azure and Terraform concepts. This tool complements the [portal Terraform export experience](get-started-export-resources-portal.md).

Copilot uses AI. Check for mistakes.

## Benefits

Expand All @@ -20,6 +20,13 @@ Azure Export for Terraform enables you to:
- **Inspect preexisting infrastructure with all exposed properties.** Whether learning a newly released resource or investigating an issue in production, Azure Export for Terraform supports a read-only export with the option to expose all configurable resource properties.
- **Follow plan/apply workflow to integrate non-Terraform infrastructure into Terraform.** Export HCL code, inspect non-Terraform resources and easily integrate them into your production infrastructure and remote backends.

## Comparison with portal export experience

This CLI tool provides more features in comparison to the portal experience.

- **Number of resources that can be exported**. In portal only up to 1000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error wil be returned if the limit is exceeded.
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Number formatting: According to the Microsoft Writing Style Guide, numbers 1,000 and above should use commas as thousands separators. "1000" should be formatted as "1,000".

Suggested change
- **Number of resources that can be exported**. In portal only up to 1000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error wil be returned if the limit is exceeded.
- **Number of resources that can be exported**. In portal only up to 1,000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error wil be returned if the limit is exceeded.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passive voice: The phrase "Error wil be returned" uses passive voice. According to the Microsoft Writing Style Guide, active voice should be used. Consider rephrasing to "The tool returns an error if the limit is exceeded" or similar active construction.

Copilot generated this review using guidance from repository custom instructions.
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling error: "wil" should be "will".

Suggested change
- **Number of resources that can be exported**. In portal only up to 1000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error wil be returned if the limit is exceeded.
- **Number of resources that can be exported**. In portal only up to 1000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error will be returned if the limit is exceeded.

Copilot uses AI. Check for mistakes.
- **Supported resource types**. In portal, some resource types such as Key Vault cannot be exported, but they are supported in the CLI tool.
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar improvement: The phrase "In portal" should be "In the portal" for proper article usage. This applies to both occurrences in this section. According to the Microsoft Writing Style Guide, articles should be used for clarity.

Suggested change
- **Number of resources that can be exported**. In portal only up to 1000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error wil be returned if the limit is exceeded.
- **Supported resource types**. In portal, some resource types such as Key Vault cannot be exported, but they are supported in the CLI tool.
- **Number of resources that can be exported**. In the portal only up to 1000 resources can be exported, and the maximum exported configuration payload is 4 MB. Error wil be returned if the limit is exceeded.
- **Supported resource types**. In the portal, some resource types such as Key Vault cannot be exported, but they are supported in the CLI tool.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the Microsoft Writing Style Guide and the custom coding guidelines for this repository, ordered and unordered lists should use complete sentences with proper punctuation, ending with a period. The list items in this section are incomplete sentences and should be expanded for clarity. For example:

  • "Number of resources that can be exported. In the portal, only up to 1,000 resources can be exported, and the maximum exported configuration payload is 4 MB. An error will be returned if the limit is exceeded."

Copilot generated this review using guidance from repository custom instructions.

## Installation

The [Azure Export for Terraform GitHub page](https://github.com/Azure/aztfexport/releases) lists releases of the tool with links to installation for various platforms (Windows MSIs, Homebrew, and Linux installations) and the source code.
Expand Down