[dataprotection] improve docs, help, example to reflect new retention rule changes #29648
Open
IannGeorges wants to merge 3 commits into
Open
[dataprotection] improve docs, help, example to reflect new retention rule changes #29648IannGeorges wants to merge 3 commits into
IannGeorges wants to merge 3 commits into
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
Member
Author
|
doc, example, & help improvements for the following merged pr: #29533 |
Collaborator
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates DataProtection cmdlet documentation and examples to align with the new retention-rule behavior (OperationalStore rules in AzureBlob are additive and must use Default_OperationalStore, and duplicate rule names are rejected unless overwriting).
Changes:
- Removed the AzureBlob “operational-only policy” example and revised the “hybrid” example to add
Default_OperationalStoreadditively (preserving Vault retention). - Expanded cmdlet help/docs with clearer synopsis/description, a new AzureBlob OperationalStore example, and added validation/deprecation notes.
- Updated the cmdlet parameter help text to note deprecation of
-OverwriteLifeCycle.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md | Updates AzureBlob policy examples to reflect additive OperationalStore retention rule behavior. |
| src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md | Clarifies retention-rule add/remove semantics, adds AzureBlob OperationalStore example, and documents validation/deprecation notes. |
| src/DataProtection/DataProtection.Autorest/examples/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md | Aligns generated example text with new validation and deprecation guidance. |
| src/DataProtection/DataProtection.Autorest/docs/New-AzDataProtectionBackupPolicy.md | Mirrors help updates for AzureBlob backup policy examples in generated docs. |
| src/DataProtection/DataProtection.Autorest/docs/Edit-AzDataProtectionPolicyRetentionRuleClientObject.md | Mirrors help updates and adds “Accepted values” + validation/deprecation notes in generated docs. |
| src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Policy/Edit-AzDataProtectionPolicyRetentionRuleClientObject.ps1 | Updates parameter HelpMessage strings (notably -OverwriteLifeCycle deprecation and removal guidance). |
Collaborator
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
|
||
| ## SYNOPSIS | ||
| Adds or removes Retention Rule to existing Policy | ||
| Adds or removes Retention Rule to an existing backup policy. |
|
|
||
| ## DESCRIPTION | ||
| Adds or removes Retention Rule to existing Policy | ||
| Adds or removes Retention Rule to an existing backup policy. |
| ### -Name | ||
| Retention Rule Name | ||
| Retention Rule Name. | ||
| Note: `"Default"` retention rules cannot be removed, regardless of lifecycle. |
Comment on lines
+112
to
+113
| Retention Rule Name. | ||
| Note: `"Default"` retention rules cannot be removed, regardless of lifecycle. |
Comment on lines
+20
to
+21
| [Parameter(ParameterSetName='AddRetention',Mandatory, HelpMessage='Retention Rule Name.')] | ||
| [Parameter(ParameterSetName='RemoveRetention',Mandatory, HelpMessage='Retention Rule Name. Note: "Default" retention rules cannot be removed, regardless of lifecycle.')] |
Collaborator
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Contributor
|
Hi @IannGeorges, the ChangeLog file path is src/DataProtection/DataProtection/ChangeLog.md. Please add a line right below |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
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.