-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Azure Automation Documentation update for Resume-AzAutomationJob and Suspend-AzAutomationJob #29066
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
Azure Automation Documentation update for Resume-AzAutomationJob and Suspend-AzAutomationJob #29066
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 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 |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
Commenter does not have sufficient privileges for PR 29066 in repo Azure/azure-powershell |
|
@isra-fel please could you trigger the execution of the pipelines again? Thanks! |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
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
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.