Skip to content

Conversation

@amarjeetkr
Copy link
Member

@amarjeetkr amarjeetkr commented Nov 17, 2025

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.md and reviewed the following information:

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

Copilot AI review requested due to automatic review settings November 17, 2025 06:35
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copilot finished reviewing on behalf of amarjeetkr November 17, 2025 06:39
Copy link
Contributor

Copilot AI left a 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-AzDataMigrationAssessment showing required fields for assessment operations
  • Added JSON configuration examples for Get-AzDataMigrationPerformanceDataCollection showing 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)

@notyashhh
Copy link
Member

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@amarjeetkr
Copy link
Member Author

@notyashhh
All the checks are passed, could you please approve the PR?
Also this needs to be published. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants