Skip to content

Add troubleshooting for Azure Policy remediation on CMK-encrypted registries#158

Open
cshung wants to merge 1 commit into
MicrosoftDocs:mainfrom
cshung:acr-cmk-policy-remediation-troubleshoot
Open

Add troubleshooting for Azure Policy remediation on CMK-encrypted registries#158
cshung wants to merge 1 commit into
MicrosoftDocs:mainfrom
cshung:acr-cmk-policy-remediation-troubleshoot

Conversation

@cshung

@cshung cshung commented Jul 8, 2026

Copy link
Copy Markdown

Summary

Adds a troubleshooting section to the ACR customer-managed key (CMK) troubleshooting article documenting a known limitation: automatic Azure Policy Modify remediation isn't currently supported on CMK-encrypted registries. Such remediation fails with a BadRequest, leaving the registry noncompliant.

What the section covers

  • The symptom and the exact BadRequest error text, so the page is discoverable by searching the error.
  • Why it happens, at a customer-appropriate level: automatic remediation resubmits the full registry configuration, which can't carry the protected customer-managed key settings, so the registry rejects the update.
  • The supported workaround: set the property the policy targets directly with the Azure CLI (example given for the Configure container registries to disable ARM audience token authentication policy), which changes only that one setting and leaves encryption untouched.

Context

Based on a customer support incident root-caused to this behavior. The policy definition itself is correct. The wording ("isn't currently supported") avoids implying the limitation is necessarily permanent.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 4f24ca7:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

@cshung cshung reopened this Jul 8, 2026
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 4f24ca7:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

@v-dirichards

Copy link
Copy Markdown
Contributor

@cshung Thank you for your contribution. Would you take a moment to sign the Contributor License Agreement (CLA)? After the CLA is signed, someone can review your pull request. Thanks!

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator Bot added the aq-pr-triaged C+L Pull Request Review Team label label Jul 8, 2026
@cshung
cshung force-pushed the acr-cmk-policy-remediation-troubleshoot branch from 4f24ca7 to 84c78fc Compare July 8, 2026 16:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 updates the Azure Container Registry (ACR) customer-managed key (CMK) troubleshooting tutorial to document a known Azure Policy Modify remediation limitation for CMK-encrypted registries and to provide a supported CLI-based workaround to restore compliance.

Changes:

  • Adds a new troubleshooting section explaining why Azure Policy Modify remediation can fail for CMK-encrypted registries.
  • Documents a CLI workaround (az acr config authentication-as-arm update) to set the targeted property without impacting encryption.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md Outdated
Comment thread articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md Outdated
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 84c78fc:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

@cshung
cshung force-pushed the acr-cmk-policy-remediation-troubleshoot branch from 84c78fc to cac8c9e Compare July 8, 2026 16:10
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit cac8c9e:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

@cshung
cshung force-pushed the acr-cmk-policy-remediation-troubleshoot branch from cac8c9e to 047c6b7 Compare July 8, 2026 16:13
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 047c6b7:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

@cshung
cshung force-pushed the acr-cmk-policy-remediation-troubleshoot branch from 047c6b7 to 34d2f57 Compare July 8, 2026 16:24
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 34d2f57:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

Document the known limitation where automatic Modify policy remediation
fails on registries encrypted with a customer-managed key, including the
exact BadRequest error and the supported CLI workaround.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@cshung
cshung force-pushed the acr-cmk-policy-remediation-troubleshoot branch from 34d2f57 to 07c3ef7 Compare July 8, 2026 16:28
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 07c3ef7:

✅ Validation status: passed

File Status Preview URL Details
articles/container-registry/tutorial-troubleshoot-customer-managed-keys.md ✅Succeeded

For more details, please refer to the build report.

@cshung

cshung commented Jul 8, 2026

Copy link
Copy Markdown
Author

@cshung please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree company="Microsoft"

@prmerger-automator
prmerger-automator Bot requested a review from KumudD July 8, 2026 17:24
@prmerger-automator

Copy link
Copy Markdown
Contributor

@cshung : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@prmerger-automator

Copy link
Copy Markdown
Contributor

@cshung : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@Court72

Court72 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

@KumudD

Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants