export-terraform-overview.md: inform user about portal vs CLI distinction #1474
Conversation
|
@gerrytan : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 2bb9ad9: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Azure Export for Terraform documentation to clarify the distinction between the portal and CLI export experiences. The changes inform users about the CLI tool's additional capabilities when they encounter limitations with the portal export feature (such as the 1,000 resource limit or unsupported resource types).
Key changes:
- Updated title and description to explicitly mention "CLI" to differentiate from portal experience
- Added a new "Comparison with portal export experience" section highlighting CLI advantages
- Included reference to the portal export experience documentation
|
|
||
| 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. |
There was a problem hiding this comment.
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".
| - **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. |
|
|
||
| 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. |
There was a problem hiding this comment.
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.
| # 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). |
There was a problem hiding this comment.
Grammar error: "is CLI a tool" should be "is a CLI tool". The word order is incorrect.
| 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). |
|
|
||
| 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. |
There was a problem hiding this comment.
Spelling error: "wil" should be "will".
| - **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. |
| - **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. |
There was a problem hiding this comment.
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.
| - **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. |
| - **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. |
There was a problem hiding this comment.
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."
prmerger-automator
bot
added
the
aq-pr-triaged
|
Hi @gerrytan - This pull request was opened in the public repo. PMs should work in the private repo, per the Microsoft Docs contributor guide. We can keep this PR open for review and merge, but would you make future content updates in the private repo? Thank you! @TomArcherMsft Can you take a look? |
|
Learn Build status updates of commit 3841e76: ✅ Validation status: passed
For more details, please refer to the build report. |
|
@stemaMSFT can you please also review this. |
|
Learn Build status updates of commit 1d949ef: ✅ Validation status: passed
For more details, please refer to the build report. |
|
#sign-off |
|
Invalid command: '#sign-off'. Only the assigned author of one or more file in this PR can sign off. @TomArcherMsft |
|
Learn Build status updates of commit 422a0e4: ✅ Validation status: passed
For more details, please refer to the build report. |
|
@gerrytan - Thanks for your review. In the public repo, pull requests should be signed off by the author, another member of the content team, or a PM. @TomArcherMsft Could you take a look? Thanks! |
|
@TomArcherMsft ping |
4 participants
When user are unable to export Azure resources to Terraform via portal (due to max limit / unsupported resource type), we want to provide a banner / info message with this doc link: https://learn.microsoft.com/en-us/azure/developer/terraform/azure-export-for-terraform/export-terraform-overview.
This change highlights the key differences of portal vs CLI TF export experience.