New Data Source: `azurerm_api_management_subscription` by CorrenSoft · Pull Request #27824 · hashicorp/terraform-provider-azurerm

CorrenSoft · 2024-10-30T23:30:17Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Adds a new data source, including a Test and documentation.

Note

I found a missing {} in the data source guide, and I took the liberty of update it. Let me know if that is a problem.

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevent documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

$ make acctests SERVICE='apimanagement' TESTARGS='-run=TestAccDataSourceApiManagementSubscription_basic'
TF_ACC=1 go test -v ./internal/services/apimanagement -run=TestAccDataSourceApiManagementSubscription_basic -timeout 180m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccDataSourceApiManagementSubscription_basic
=== PAUSE TestAccDataSourceApiManagementSubscription_basic
=== CONT  TestAccDataSourceApiManagementSubscription_basic
--- PASS: TestAccDataSourceApiManagementSubscription_basic (284.09s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/apimanagement 284.316s

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_api_management_subscription - New data source [New Data Source: azurerm_api_management_subscription #27824]

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #20575

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

internal/services/apimanagement/api_management_subscription_data_source.go

apgmckay

Looks really nice we have a need for this exact feature.

stephybun · 2025-01-15T15:50:14Z

internal/services/apimanagement/api_management_subscription_data_source.go

+		"api_management_name": schemaz.SchemaApiManagementDataSourceName(),
+
+		"resource_group_name": commonschema.ResourceGroupName(),


Let's replace these with the resource's ID since we can infer the resource group from it

Suggested change

"api_management_name": schemaz.SchemaApiManagementDataSourceName(),

"resource_group_name": commonschema.ResourceGroupName(),

"api_management_id": {

Type: pluginsdk.TypeString,

Required: true,

ForceNew: true,

ValidateFunc: apimanagementservice.ValidateServiceID,

},

Applied the changes, and also updated the doc.

internal/services/apimanagement/api_management_subscription_data_source.go

stephybun · 2025-01-16T07:31:11Z

internal/services/apimanagement/api_management_subscription_data_source_test.go

+}
+
+data "azurerm_api_management_subscription" "test" {
+  api_management_id = api_management_id.test.id


Suggested change

api_management_id = api_management_id.test.id

api_management_id = azurerm_api_management.test.id

Thank you :)

stephybun

Thanks @CorrenSoft LGTM 👍

* Update for #27950 * Update for #27824 * Update for #28592 #28583 #28599 #28590 #28453 * Update #28528 * Update for #27853 * Update CHANGELOG.md #28221 * Update for #27760 * Update CHANGELOG.md #28480 * Update CHANGELOG.md typo * Update CHANGELOG.md #28372 * Update CHANGELOG.md for #26047 also alphabetised ENHANCEMENTS * Update for #28146 * Update CHANGELOG.md #28013 * Update CHANGELOG.md for #28492 * Update CHANGELOG.md for #28648 * Update CHANGELOG.md for #28549 * Update for #28469 #28620 * prep for release * i touched it last --------- Co-authored-by: catriona-m <[email protected]> Co-authored-by: jackofallops <[email protected]> Co-authored-by: sreallymatt <[email protected]> Co-authored-by: Matthew Frahry <[email protected]> Co-authored-by: jackofallops <[email protected]>

github-actions · 2025-02-21T02:13:57Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

Adds new data source, including test and docs.

ba18f95

CorrenSoft requested review from a team and katbyte as code owners October 30, 2024 23:30

github-actions bot added the waiting-response label Oct 30, 2024

rcskosir added the new-data-source label Oct 31, 2024

Merge remote-tracking branch 'remotes/origin/main' into feature/20575

2e32f19

github-actions bot removed the waiting-response label Nov 4, 2024

apgmckay reviewed Nov 26, 2024

View reviewed changes

internal/services/apimanagement/api_management_subscription_data_source.go Show resolved Hide resolved

apgmckay approved these changes Nov 26, 2024

View reviewed changes

Merge branch 'main' into feature/20575

9b62fb6

github-actions bot added documentation service/api-management size/XL waiting-response labels Jan 8, 2025

Empty line

ff040f7

github-actions bot added waiting-response and removed waiting-response labels Jan 8, 2025

gofumpt-ing

bdeebf0

github-actions bot removed the waiting-response label Jan 8, 2025

stephybun reviewed Jan 15, 2025

View reviewed changes

github-actions bot added the waiting-response label Jan 15, 2025

Apply feedback and update docs accordingly.

4717d5c

github-actions bot added waiting-response and removed waiting-response labels Jan 15, 2025

Fix format

8000de7

github-actions bot removed the waiting-response label Jan 15, 2025

stephybun reviewed Jan 16, 2025

View reviewed changes

github-actions bot added the waiting-response label Jan 16, 2025

Fix test and missing field in the data source.

4df2569

github-actions bot removed the waiting-response label Jan 16, 2025

stephybun approved these changes Jan 21, 2025

View reviewed changes

stephybun merged commit 4c98155 into hashicorp:main Jan 21, 2025

github-actions bot added this to the v4.17.0 milestone Jan 21, 2025

stephybun added a commit that referenced this pull request Jan 21, 2025

Update for #27824

33dbdb8

CorrenSoft deleted the feature/20575 branch January 21, 2025 13:23

github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Data Source: `azurerm_api_management_subscription`#27824

New Data Source: `azurerm_api_management_subscription`#27824
stephybun merged 8 commits intohashicorp:mainfrom
CorrenSoft:feature/20575

CorrenSoft commented Oct 30, 2024 •

edited

Loading

Uh oh!

Uh oh!

apgmckay left a comment

Uh oh!

stephybun Jan 15, 2025

Uh oh!

CorrenSoft Jan 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stephybun Jan 16, 2025

Uh oh!

CorrenSoft Jan 16, 2025

Uh oh!

stephybun left a comment

Uh oh!

github-actions bot commented Feb 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		"api_management_name": schemaz.SchemaApiManagementDataSourceName(),

		"resource_group_name": commonschema.ResourceGroupName(),

-		"api_management_name": schemaz.SchemaApiManagementDataSourceName(),
-		"resource_group_name": commonschema.ResourceGroupName(),
+		"api_management_id": {
+				Type:         pluginsdk.TypeString,
+				Required:     true,
+				ForceNew:     true,
+				ValidateFunc: apimanagementservice.ValidateServiceID,
+			},

	api_management_id = api_management_id.test.id
	api_management_id = azurerm_api_management.test.id

Conversation

CorrenSoft commented Oct 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Note

Description

Note

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

Uh oh!

Uh oh!

apgmckay left a comment

Choose a reason for hiding this comment

Uh oh!

stephybun Jan 15, 2025

Choose a reason for hiding this comment

Uh oh!

CorrenSoft Jan 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stephybun Jan 16, 2025

Choose a reason for hiding this comment

Uh oh!

CorrenSoft Jan 16, 2025

Choose a reason for hiding this comment

Uh oh!

stephybun left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CorrenSoft commented Oct 30, 2024 •

edited

Loading