[data[protection] fix help docs to reflect latest retention rules change#29652
Open
IannGeorges wants to merge 1 commit into
Open
[data[protection] fix help docs to reflect latest retention rules change#29652IannGeorges wants to merge 1 commit into
IannGeorges wants to merge 1 commit into
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
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 help to reflect the latest AzureBlob retention rule behavior (OperationalStore rule now added alongside the existing Vault rule), and removes an outdated operational-only policy example.
Changes:
- Removed the operational-only AzureBlob policy example from generated and source help markdown.
- Updated the hybrid AzureBlob example to add
Default_OperationalStorewithout overwriting the existingDefault(Vault) rule, and clarified the accompanying narrative. - Simplified
-Nameparameter help text inEdit-AzDataProtectionPolicyRetentionRuleClientObject.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md | Aligns user-facing help example(s) and narrative with current AzureBlob retention rule semantics. |
| src/DataProtection/DataProtection.Autorest/docs/New-AzDataProtectionBackupPolicy.md | Mirrors the same help updates in the AutoRest-generated docs output. |
| src/DataProtection/DataProtection.Autorest/custom/Cmdlets/Policy/Edit-AzDataProtectionPolicyRetentionRuleClientObject.ps1 | Updates parameter help messages related to retention rule naming/removal constraints. |
| The fourth command overwrites the vault lifecycle with operational store lifecycle. | ||
| The last command creates the operational store policy. | ||
|
|
||
| ### Example 4: Create a vaulted policy for AzureBlob |
| The fourth command overwrites the vault lifecycle with operational store lifecycle. | ||
| The last command creates the operational store policy. | ||
|
|
||
| ### Example 4: Create a vaulted policy for AzureBlob |
| [Parameter(ParameterSetName='AddRetention',Mandatory, HelpMessage='Retention Rule Name. Note: Default_OperationalStore is applicable to AzureBlob only and is reserved for OperationalStore lifecycles; on AzureBlob, -Name Default is reserved for VaultStore lifecycles.')] | ||
| [Parameter(ParameterSetName='RemoveRetention',Mandatory, HelpMessage='Retention Rule Name. Note: Default and Default_OperationalStore are default retention rules and cannot be removed.')] | ||
| [Parameter(ParameterSetName='AddRetention',Mandatory, HelpMessage='Retention Rule Name.')] | ||
| [Parameter(ParameterSetName='RemoveRetention',Mandatory, HelpMessage='Retention Rule Name. Note: Default retention rules cannot be removed.')] |
Collaborator
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
YanaXu
requested changes
May 21, 2026
| Next we create FirstOfDay, FirstOfWeek tag criteria and update the policy. | ||
| The last command creates the policy. | ||
|
|
||
| ### Example 4: Create a operational policy for AzureBlob |
Contributor
There was a problem hiding this comment.
Please add the examples to files under "examples" and run "build-module.ps1". The files under "docs" are auto generated.
Contributor
|
Hi @IannGeorges, |
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.