Skip to content

[Contribution Guide Update] Adding List guidance for sub-resources #32751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promisinganuj wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Contribution Guide Update] Adding List guidance for sub-resources #32751

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
951e4e5
Adding List guidance for sub-resources
promisinganuj Jul 9, 2026
0ca0bea
Update contributing/topics/guide-list-resource.md
promisinganuj Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions contributing/topics/guide-list-resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,6 +476,19 @@ Before adding a List Resource, the resource must have Resource Identity implemen
* `subscription_id` - (Optional) The Subscription ID to query. Defaults to the value specified in the Provider Configuration.
````

## Handling List for Sub-resources

Some resources can be listed only beneath a parent resource, rather than at the subscription or resource group scope. Treat this as a scoping concern, not a typed versus untyped implementation detail.
Comment thread
promisinganuj marked this conversation as resolved.
Outdated

For these sub-resources:

* Do not expose `subscription_id` or `resource_group_name`.
* Accept the immediate parent resource ID as a required argument.
* Parse that parent ID and call the API that lists directly beneath that parent.
* Apply the same rule to deeper hierarchies by taking the ID of the immediate parent resource at each level.

Example: see [mysql_flexible_database_resource_list.go](../../internal/services/mysql/mysql_flexible_database_resource_list.go) and [mysql_flexible_database.html.markdown](../../website/docs/list-resources/mysql_flexible_database.html.markdown).

## Known Issues and Considerations

### Cancelled Context
Expand Down
Loading