Skip to content
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.

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

New Data Source: azurerm_api_management_subscription #27824

Merged
merged 8 commits into from
Jan 21, 2025

Conversation

CorrenSoft
Copy link
Contributor

@CorrenSoft CorrenSoft commented Oct 30, 2024

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.

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.

Copy link

@apgmckay apgmckay left a comment

Choose a reason for hiding this comment

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

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

Comment on lines 40 to 42
"api_management_name": schemaz.SchemaApiManagementDataSourceName(),

"resource_group_name": commonschema.ResourceGroupName(),
Copy link
Member

Choose a reason for hiding this comment

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

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,
},

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied the changes, and also updated the doc.

}

data "azurerm_api_management_subscription" "test" {
api_management_id = api_management_id.test.id
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
api_management_id = api_management_id.test.id
api_management_id = azurerm_api_management.test.id

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you :)

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks @CorrenSoft LGTM 👍

@stephybun stephybun merged commit 4c98155 into hashicorp:main Jan 21, 2025
35 checks passed
@github-actions 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
@CorrenSoft CorrenSoft deleted the feature/20575 branch January 21, 2025 13:23
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.

data source for azurerm_api_management_subscription
4 participants