[Resources] Added expand functionality to GetAzureResource and GetAzureResourceGroup
#28161
Conversation
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
Test-AzResourceGroupDeployment output an empty warning as the conditionals were not accounting for all cases
Co-authored-by: Vincent Dai <23257217+vidai-msft@users.noreply.github.com>
Introduces new filter models (GenericResourceFilterWithExpand, ResourceGroupFilterWithExpand) and updates SDK interfaces and implementations to support the $expand query parameter for retrieving createdTime and changedTime on resources and resource groups. Updates related cmdlets and tests to validate the new properties.
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
This was
linked to
issues
Jul 10, 2025
a0x1ab
changed the title
GetAzureResource and GetAzureResourceGroup
There was a problem hiding this comment.
Pull Request Overview
This PR adds $expand support to the GetAzureResource and GetAzureResourceGroup cmdlets so that CreatedTime and ChangedTime are returned, and updates models, SDK clients, and tests accordingly.
- Extend
$expandparameter usage in OData queries and direct GET calls to includecreatedTime,changedTime - Augment
PSResource/PSResourceGroupmodels and extensions withCreatedTime/ChangedTime - Add and update tests to verify expanded properties and update SDK transforms and changelog
Reviewed Changes
Copilot reviewed 10 out of 21 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Resources/Resources/ChangeLog.md | Documented new expand functionality and fixed warnings |
| src/Resources/Resources.Test/ResourceGroups/GetAzureResourceGroupCommandTests.cs | Added tests for timestamps on resource group cmdlet |
| src/Resources/Resources.Test/Resource/GetAzureResourceCommandTests.cs | Updated tests to use expanded model and assert timestamps |
| src/Resources/Resources.Test/Models.ResourceGroups/ResourceClientTests.cs | Updated mock setups to include $expand parameter |
| src/Resources/Resources.Management.Sdk/README.md | Insert SDK readme transforms for $expand |
| src/Resources/ResourceManager/SdkModels/ResourceGroups/PSResourceGroup.cs | Added CreatedTime and ChangedTime properties |
| src/Resources/ResourceManager/SdkExtensions/NewResourcesExtensions.cs | Populate new timestamp properties in extension method |
| src/Resources/ResourceManager/SdkClient/ResourceManagerSdkClient.cs | Change ListResources/ListByResourceGroup to use expanded filter |
| src/Resources/ResourceManager/SdkClient/NewResourceManagerSdkClient.cs | Update FilterResourceGroups to set Expand and call GET with expand |
| src/Resources/ResourceManager/Implementation/Resource/GetAzureResourceCmdlet.cs | Switch to expanded filter and set Expand in cmdlet |
Comments suppressed due to low confidence (2)
src/Resources/Resources/ChangeLog.md:23
- [nitpick] Add a space before the issue references, e.g.
...GetAzureResourceGroup[#5814] [#27865], for consistent formatting.
* Added functionality for cmdlet `GetAzureResource` and `GetAzureResourceGroup`[#5814][#27865]
src/Resources/Resources.Test/Resource/GetAzureResourceCommandTests.cs:76
- [nitpick] Consider adding a test for the list (subscription-level) path of the Get-AzureResource cmdlet to verify
CreatedTimeandChangedTimeare returned when no ResourceId is provided.
public void GetsResourcesById()
Co-authored-by: Vincent Dai <23257217+vidai-msft@users.noreply.github.com>
Introduces new filter models (GenericResourceFilterWithExpand, ResourceGroupFilterWithExpand) and updates SDK interfaces and implementations to support the $expand query parameter for retrieving createdTime and changedTime on resources and resource groups. Updates related cmdlets and tests to validate the new properties.
Fixed changelog
Deleted the GetsResourceGroupsWithTimestamps test, which duplicated the logic of an existing test. This reduces redundancy and simplifies the test suite.
|
Please fix the test errors. Don't forget to submit the recording files. |
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
wyunchi-ms
reviewed
Jul 14, 2025
| @@ -171,7 +171,8 @@ private void RunSimpleCmdlet() | |||
| tagValue: null, | |||
| filter: this.ODataQuery); | |||
|
|
|||
| var odataQuery = new Rest.Azure.OData.ODataQuery<GenericResourceFilter>(expression); | |||
| var odataQuery = new Rest.Azure.OData.ODataQuery<Azure.Management.Resources.Models.GenericResourceFilterWithExpand>(expression); | |||
| odataQuery.Expand = "createdTime,changedTime"; | |||
There was a problem hiding this comment.
It may be better to add a ExpandProperty parameter, and the validate set is the set of the valid property values, and default value can be "createdTime,changedTime"
There was a problem hiding this comment.
And I think it will be better to set Expand false by default. Only show the expand informations when user want them.
|
Hi @a0x1ab , please check wyunchi-ms's comment. |
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
PR pertains to the following issues:
Get-AzResourceGroup: IncludecreatedTimeandchangedTime, at least optionally #27865This PR introduces the following changes:
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.