Skip to content

App Config RP 2024-06-01#29313

Open
mrm9084 wants to merge 19 commits intoAzure:mainfrom
mrm9084:AppConfigUpdate
Open

App Config RP 2024-06-01#29313
mrm9084 wants to merge 19 commits intoAzure:mainfrom
mrm9084:AppConfigUpdate

Conversation

@mrm9084
Copy link
Copy Markdown
Member

@mrm9084 mrm9084 commented Mar 24, 2026

Description

Updates the Azure App Configuration RP module to the latest released version of 2024-06-01

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 March 24, 2026 21:19
@azure-client-tools-bot-prd
Copy link
Copy Markdown

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

Copy link
Copy Markdown
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

Updates the Az.AppConfiguration module’s management-plane (RP) surface to use App Configuration API version 2024-06-01, including new replica-related cmdlets and related documentation/test assets.

Changes:

  • Updated AutoRest configuration to target the 2024-06-01 swagger and added/updated directives.
  • Added documentation/help/examples/tests for App Configuration replica cmdlets.
  • Updated module manifest exports, changelog, solution metadata, and UX API version references.

Reviewed changes

Copilot reviewed 31 out of 31 changed files in this pull request and generated 14 comments.

Show a summary per file
File Description
src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationStore.md Updates cmdlet help to reflect new/removed parameters.
src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationReplica.md Adds help page for replica update cmdlet.
src/AppConfiguration/AppConfiguration/help/Remove-AzAppConfigurationReplica.md Adds help page for replica removal cmdlet.
src/AppConfiguration/AppConfiguration/help/New-AzAppConfigurationStore.md Updates help to include new store creation parameters.
src/AppConfiguration/AppConfiguration/help/New-AzAppConfigurationReplica.md Adds help page for replica creation cmdlet.
src/AppConfiguration/AppConfiguration/help/Get-AzAppConfigurationReplica.md Adds help page for replica get/list cmdlet.
src/AppConfiguration/AppConfiguration/help/Az.AppConfiguration.md Adds replica cmdlets to the module help index and refreshes descriptions.
src/AppConfiguration/AppConfiguration/ChangeLog.md Adds upcoming release notes for API version upgrade, replicas, and parameter changes.
src/AppConfiguration/AppConfiguration/Az.AppConfiguration.psd1 Updates exported functions and dependency version; includes replica cmdlets in exports.
src/AppConfiguration/AppConfiguration.sln Updates solution project entries/IDs for the generated AppConfiguration project.
src/AppConfiguration/AppConfiguration.Autorest/test/Update-AzAppConfigurationReplica.Tests.ps1 Adds Pester coverage for replica update scenarios.
src/AppConfiguration/AppConfiguration.Autorest/test/Remove-AzAppConfigurationReplica.Tests.ps1 Adds Pester coverage for replica delete scenarios.
src/AppConfiguration/AppConfiguration.Autorest/test/New-AzAppConfigurationReplica.Tests.ps1 Adds Pester coverage for replica create scenarios.
src/AppConfiguration/AppConfiguration.Autorest/test/Get-AzAppConfigurationReplica.Tests.ps1 Adds Pester coverage for replica get/list scenarios.
src/AppConfiguration/AppConfiguration.Autorest/generate-info.json Updates generation metadata identifier.
src/AppConfiguration/AppConfiguration.Autorest/examples/Update-AzAppConfigurationReplica.md Adds example(s) for updating replicas.
src/AppConfiguration/AppConfiguration.Autorest/examples/Remove-AzAppConfigurationReplica.md Adds example(s) for removing replicas.
src/AppConfiguration/AppConfiguration.Autorest/examples/New-AzAppConfigurationReplica.md Adds example(s) for creating replicas.
src/AppConfiguration/AppConfiguration.Autorest/examples/Get-AzAppConfigurationReplica.md Adds example(s) for getting/listing replicas.
src/AppConfiguration/AppConfiguration.Autorest/docs/Update-AzAppConfigurationStore.md Updates reference docs to match updated parameter surface.
src/AppConfiguration/AppConfiguration.Autorest/docs/Update-AzAppConfigurationReplica.md Adds reference doc for replica update cmdlet.
src/AppConfiguration/AppConfiguration.Autorest/docs/Remove-AzAppConfigurationReplica.md Adds reference doc for replica removal cmdlet.
src/AppConfiguration/AppConfiguration.Autorest/docs/New-AzAppConfigurationStore.md Updates reference docs to include new store creation parameters.
src/AppConfiguration/AppConfiguration.Autorest/docs/New-AzAppConfigurationReplica.md Adds reference doc for replica creation cmdlet.
src/AppConfiguration/AppConfiguration.Autorest/docs/Get-AzAppConfigurationReplica.md Adds reference doc for replica get/list cmdlet.
src/AppConfiguration/AppConfiguration.Autorest/docs/Az.AppConfiguration.md Updates Autorest docs index with new replica cmdlets and refreshed descriptions.
src/AppConfiguration/AppConfiguration.Autorest/UX/Microsoft.AppConfiguration/locations-deletedConfigurationStores.json Bumps UX API version to 2024-06-01.
src/AppConfiguration/AppConfiguration.Autorest/UX/Microsoft.AppConfiguration/configurationStores.json Bumps UX API version to 2024-06-01.
src/AppConfiguration/AppConfiguration.Autorest/UX/Microsoft.AppConfiguration/configurationStores-replicas.json Adds UX description for replica resource type using 2024-06-01.
src/AppConfiguration/AppConfiguration.Autorest/README.md Updates spec commit/input-file and adds directives for new API surface.
src/AppConfiguration/AppConfiguration.Autorest/Properties/AssemblyInfo.cs Updates assembly versioning to align with module versioning.

Comment on lines +18 to +23
BeforeAll {
$updateReplicaStoreName = "azupd" + (Get-Random -Maximum 99999)
New-AzAppConfigurationStore -Name $updateReplicaStoreName -ResourceGroupName $env.resourceGroup -Location $env.location -Sku Standard
$updateReplicaName = "westus2replica"
New-AzAppConfigurationReplica -ConfigStoreName $updateReplicaStoreName -ResourceGroupName $env.resourceGroup -Name $updateReplicaName -Location "westus2"
}
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test uses a per-run random store name (Get-Random) and references Update-AzAppConfigurationReplica.Recording.json, but that recording file is not present in the test folder. In playback mode the random name won’t match any recording, and the missing recording file will likely cause the mocking harness to fail. Please switch to deterministic names from env.json (or add new fixed entries) and commit the corresponding .Recording.json for this test.

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 24, 2026 21:34
@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 24, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copy link
Copy Markdown
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

Copilot reviewed 31 out of 31 changed files in this pull request and generated 9 comments.

Accept wildcard characters: False
```

### -DataPlaneProxyAuthenticationMode
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR introduces new store parameters in the public surface area, but the added tests focus on replica cmdlets. Consider adding Pester coverage that exercises these new New-AzAppConfigurationStore / Update-AzAppConfigurationStore parameters (at least acceptance + read-back validation where possible) to prevent regressions in parameter wiring/serialization.

Copilot uses AI. Check for mistakes.
Accept wildcard characters: False
```

### -DefaultKeyValueRevisionRetentionPeriodInSecond
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR introduces new store parameters in the public surface area, but the added tests focus on replica cmdlets. Consider adding Pester coverage that exercises these new New-AzAppConfigurationStore / Update-AzAppConfigurationStore parameters (at least acceptance + read-back validation where possible) to prevent regressions in parameter wiring/serialization.

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 24, 2026 23:28
Copy link
Copy Markdown
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

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

Comments suppressed due to low confidence (1)

src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationStore.md:1

  • The help content shows -EnableSystemAssignedIdentity as <Boolean>, but the generated docs in AppConfiguration.Autorest/docs/Update-AzAppConfigurationStore.md show it as nullable (System.Nullable[System.Boolean]). Please align the hand-shipped help under src/AppConfiguration/AppConfiguration/help/ with the actual cmdlet parameter type (and the generated docs) so users don't get conflicting information about whether the parameter supports an unset/tri-state value.

Comment on lines +18 to +19
-Location <String> -Sku <String> [-CreateMode <String>] [-DataPlaneProxyAuthenticationMode <String>]
[-DataPlaneProxyPrivateLinkDelegation <String>] [-DefaultKeyValueRevisionRetentionPeriodInSecond <Int64>]
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New store parameters (DataPlaneProxyAuthenticationMode, DataPlaneProxyPrivateLinkDelegation, DefaultKeyValueRevisionRetentionPeriodInSecond) are introduced/advertised here, but this PR doesn't include Pester coverage that exercises these parameters (e.g., create/update with the parameters set and verify the resulting store properties). Adding tests for these new parameters would better protect against regressions in the new API version surface.

Copilot uses AI. Check for mistakes.
@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 24, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copilot AI review requested due to automatic review settings March 25, 2026 18:53
Copy link
Copy Markdown
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

Copilot reviewed 37 out of 41 changed files in this pull request and generated 7 comments.

Comments suppressed due to low confidence (2)

src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationStore.md:1

  • Capitalize the proper service name for consistency and correctness (e.g., 'Azure App Configuration store'). This same phrasing appears in several updated help files in this PR, so aligning the capitalization across them would improve help quality.
    src/AppConfiguration/AppConfiguration/help/Update-AzAppConfigurationStore.md:1
  • Update-AzAppConfigurationStore shows -EnableSystemAssignedIdentity <Boolean> here, but the regenerated Autorest docs in this PR show a nullable boolean (<Boolean?>). Please regenerate/align the help so the parameter type is consistent across shipped help surfaces (or adjust generation so both reflect the actual cmdlet signature).

@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 25, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@NoriZC
Copy link
Copy Markdown
Contributor

NoriZC commented Mar 25, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@mrm9084
Copy link
Copy Markdown
Member Author

mrm9084 commented Mar 25, 2026

There seems to be a few build issues:

Module ClassName Target Severity ProblemId Description Remediation
Az.AppConfiguration Update-AzAppConfigurationStore Update-AzAppConfigurationStore 0 2000 The cmdlet Update-AzAppConfigurationStore no longer supports the parameter SoftDeleteRetentionInDay and no alias was found for the original parameter name. Add the parameter SoftDeleteRetentionInDay back to the cmdlet Update-AzAppConfigurationStore, or add an alias to the original parameter name.
Az.AppConfiguration Update-AzAppConfigurationStore Update-AzAppConfigurationStore 0 1050 The parameter set UpdateExpanded for cmdlet Update-AzAppConfigurationStore has been removed. Add parameter set UpdateExpanded back to cmdlet Update-AzAppConfigurationStore.
Az.AppConfiguration Update-AzAppConfigurationStore Update-AzAppConfigurationStore 0 1050 The parameter set UpdateViaIdentityExpanded for cmdlet Update-AzAppConfigurationStore has been removed. Add parameter set UpdateViaIdentityExpanded back to cmdlet Update-AzAppConfigurationStore.
Az.AppConfiguration Update-AzAppConfigurationStore Update-AzAppConfigurationStore 0 1050 The parameter set __AllParameterSets for cmdlet Update-AzAppConfigurationStore has been removed. Add parameter set __AllParameterSets back to cmdlet Update-AzAppConfigurationStore.
``
  1. SoftDeleteRetentionInDay is in comments but I don't actually see it even being used in the old version. Not sure what happened there.
  2. UpdateExpanded I don't even see in the old version.
  3. UpdateViaIdentityExpanded I see no reference to this in the old version either. I see no change involving either of these in my pr.
  4. __AllParameterSets doesn't even show up in this PR.

@NoriZC any ideas? @jimmyca15

@mrm9084 mrm9084 marked this pull request as ready for review March 30, 2026 21:09
@VeryEarly VeryEarly assigned VeryEarly and unassigned VeryEarly Mar 31, 2026
@VeryEarly
Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copilot AI review requested due to automatic review settings April 2, 2026 22:12
Copy link
Copy Markdown
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

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

- Added `New-AzAppConfigurationReplica` cmdlet
- Added `Get-AzAppConfigurationReplica` cmdlet
- Added `Remove-AzAppConfigurationReplica` cmdlet
* Added `DataPlaneProxyAuthenticationMode`, `DataPlaneProxyPrivateLinkDelegation`, and `DefaultKeyValueRevisionRetentionPeriodInSecond` parameters to `New-AzAppConfigurationStore` and `Update-AzAppConfigurationStore`
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ChangeLog entry has a parameter name typo: DefaultKeyValueRevisionRetentionPeriodInSecond should be DefaultKeyValueRevisionRetentionPeriodInSeconds (matches the cmdlet parameter spelling elsewhere in this PR).

Copilot uses AI. Check for mistakes.
Comment on lines +101 to +104
- where:
parameter-name: DefaultKeyValueRevisionRetentionPeriodInSecond
set:
parameter-name: DefaultKeyValueRevisionRetentionPeriodInSeconds
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New directive renames DefaultKeyValueRevisionRetentionPeriodInSecond to ...InSeconds but doesn't document why. Per AutoRest README conventions, add a short comment explaining the intent (e.g., aligning the PowerShell parameter name with the underlying ...InSeconds unit / pluralization).

Copilot generated this review using guidance from repository custom instructions.
Comment on lines +105 to +108
- where:
parameter-name: SoftDeleteRetentionInDay
set:
parameter-name: SoftDeleteRetentionInDays
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New directive renames SoftDeleteRetentionInDay to SoftDeleteRetentionInDays but lacks a comment explaining the rationale (unit/pluralization and user-facing breaking change). Please add a brief comment for maintainers.

Copilot generated this review using guidance from repository custom instructions.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jimmyca15 copilot when asked to fix the plural also changed this, but it results in a breaking change. But if we make the DefaultKeyValueRevisionRetentionPeriodInSeconds change it will be inconsistent with this.

Copilot AI review requested due to automatic review settings April 2, 2026 23:00
Copy link
Copy Markdown
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

Copilot reviewed 40 out of 44 changed files in this pull request and generated 1 comment.

input-file:
- $(repo)/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json
- $(repo)/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-06-01/appconfiguration.json

Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The AutoRest config is updated to the 2024-06-01 spec, but the checked-in generated module outputs under generated/AppConfiguration/AppConfiguration.Autorest still appear to target the old API version (no 2024-06-01 references) and do not include the new Replica cmdlets. Please re-run generation and commit the updated generated outputs (or ensure the build regenerates them) so the actual shipped module matches the updated docs/manifest.

Suggested change
# Write generated artifacts to the checked-in module location so the shipped output stays aligned
# with the 2024-06-01 specification and includes newly added operations such as Replica cmdlets.
output-folder: $(repo)/generated/AppConfiguration/AppConfiguration.Autorest
# Clear previously generated files to prevent stale outputs from older API versions remaining in the module.
clear-output-folder: true

Copilot uses AI. Check for mistakes.
@VeryEarly
Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@jimmyca15
Copy link
Copy Markdown
Member

Looks good other than our change to add more properties to the output of configuration store operations seems to have put us at risk of overflowing horizontal space. I'd like to revert that before we go in.

@VeryEarly
Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

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.

5 participants