Skip to content

Conversation

@kkarmakarMS
Copy link
Contributor

Description

Updating the documentation for the Resume-AzAutomationJob and the Suspend-AzAutomationJob cmdlet so that the public docs mention the exact behavior of the cmdlets and to avoid customer confusion.

Mandatory Checklist

  • 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 January 16, 2026 10:06
@azure-client-tools-bot-prd
Copy link

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

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 pull request updates the documentation for the Resume-AzAutomationJob and Suspend-AzAutomationJob cmdlets to clarify that these commands are only applicable for PowerShell Workflow jobs, helping to avoid customer confusion.

Changes:

  • Updated SYNOPSIS sections to indicate PowerShell Workflow job limitation
  • Updated DESCRIPTION sections to clarify PowerShell Workflow job context
  • Updated module index file with the new descriptions

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/Automation/Automation/help/Suspend-AzAutomationJob.md Added PowerShell Workflow job clarification to SYNOPSIS and DESCRIPTION sections
src/Automation/Automation/help/Resume-AzAutomationJob.md Added PowerShell Workflow job clarification to SYNOPSIS and DESCRIPTION sections
src/Automation/Automation/help/Az.Automation.md Updated index entries for both cmdlets to reflect the PowerShell Workflow limitation

@isra-fel
Copy link
Member

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@azure-pipelines
Copy link
Contributor

Commenter does not have sufficient privileges for PR 29066 in repo Azure/azure-powershell

@kkarmakarMS
Copy link
Contributor Author

@isra-fel please could you trigger the execution of the pipelines again? Thanks!

@isra-fel
Copy link
Member

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft vidai-msft merged commit c4480a6 into Azure:main Jan 17, 2026
12 checks passed
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.

3 participants