-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Add configuration file format section in documentation #28877
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.
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
base: main
Are you sure you want to change the base?
Add configuration file format section in documentation #28877
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds configuration file format documentation to two DataMigration cmdlet help files to provide users with examples of the JSON configuration structure expected by the -ConfigFilePath parameter.
Key Changes
- Added JSON configuration examples for
Get-AzDataMigrationAssessmentshowing required fields for assessment operations - Added JSON configuration examples for
Get-AzDataMigrationPerformanceDataCollectionshowing performance data collection configuration
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/DataMigration/DataMigration/help/Get-AzDataMigrationAssessment.md | Added configuration file format section with JSON example showing assessment config structure (action, outputFolder, overwrite, sqlConnectionStrings) |
| src/DataMigration/DataMigration/help/Get-AzDataMigrationPerformanceDataCollection.md | Added configuration file format section with JSON example showing performance collection config structure (action, outputFolder, perfQueryIntervalInSec, staticQueryIntervalInSec, numberOfIterations, sqlConnectionStrings) |
src/DataMigration/DataMigration/help/Get-AzDataMigrationAssessment.md
Outdated
Show resolved
Hide resolved
src/DataMigration/DataMigration/help/Get-AzDataMigrationPerformanceDataCollection.md
Outdated
Show resolved
Hide resolved
src/DataMigration/DataMigration/help/Get-AzDataMigrationAssessment.md
Outdated
Show resolved
Hide resolved
src/DataMigration/DataMigration/help/Get-AzDataMigrationPerformanceDataCollection.md
Outdated
Show resolved
Hide resolved
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
@notyashhh |
Description
Added configuration file format section in documentation
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.