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_private_dns_resolver_dns_forwarding_ruleset #19941

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
package privatednsresolver

import (
"context"
"fmt"
"time"

"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
"github.com/hashicorp/go-azure-sdk/resource-manager/dnsresolver/2022-07-01/dnsforwardingrulesets"
"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
"github.com/hashicorp/terraform-provider-azurerm/internal/tags"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
)

type PrivateDNSResolverDnsForwardingRulesetDataSourceModel struct {
Name string `tfschema:"name"`
ResourceGroupName string `tfschema:"resource_group_name"`
DnsResolverOutboundEndpoints []string `tfschema:"private_dns_resolver_outbound_endpoint_ids"`
Location string `tfschema:"location"`
Tags map[string]string `tfschema:"tags"`
}

type PrivateDNSResolverDnsForwardingRulesetDataSource struct{}

var _ sdk.DataSource = PrivateDNSResolverDnsForwardingRulesetDataSource{}

func (r PrivateDNSResolverDnsForwardingRulesetDataSource) ResourceType() string {
return "azurerm_private_dns_resolver_dns_forwarding_ruleset"
}

func (r PrivateDNSResolverDnsForwardingRulesetDataSource) ModelObject() interface{} {
return &PrivateDNSResolverDnsForwardingRulesetDataSourceModel{}
}

func (r PrivateDNSResolverDnsForwardingRulesetDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc {
return dnsforwardingrulesets.ValidateDnsForwardingRulesetID
}

func (r PrivateDNSResolverDnsForwardingRulesetDataSource) Arguments() map[string]*pluginsdk.Schema {
return map[string]*pluginsdk.Schema{
"name": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validation.StringIsNotEmpty,
},

"resource_group_name": commonschema.ResourceGroupName(),
}
}

func (r PrivateDNSResolverDnsForwardingRulesetDataSource) Attributes() map[string]*pluginsdk.Schema {
return map[string]*pluginsdk.Schema{
"location": commonschema.LocationComputed(),

"private_dns_resolver_outbound_endpoint_ids": {
Type: pluginsdk.TypeList,
Computed: true,
Elem: &pluginsdk.Schema{
Type: pluginsdk.TypeString,
},
},

"tags": tags.SchemaDataSource(),
}
}

func (r PrivateDNSResolverDnsForwardingRulesetDataSource) Read() sdk.ResourceFunc {
return sdk.ResourceFunc{
Timeout: 5 * time.Minute,
Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
client := metadata.Client.PrivateDnsResolver.DnsForwardingRulesetsClient

var state PrivateDNSResolverDnsForwardingRulesetDataSourceModel
if err := metadata.Decode(&state); err != nil {
return fmt.Errorf("decoding: %+v", err)
}

id := dnsforwardingrulesets.NewDnsForwardingRulesetID(
metadata.Client.Account.SubscriptionId, state.ResourceGroupName, state.Name)
resp, err := client.Get(ctx, id)
if err != nil {
return fmt.Errorf("retrieving %s: %+v", id, err)
}

model := resp.Model
if model == nil {
return fmt.Errorf("retrieving %s: model was nil", id)
}

state.Location = location.Normalize(model.Location)
state.DnsResolverOutboundEndpoints = flattenDnsResolverOutboundEndpoints(&model.Properties.DnsResolverOutboundEndpoints)

if model.Tags != nil {
state.Tags = *model.Tags
}

metadata.SetID(id)

return metadata.Encode(&state)
},
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package privatednsresolver_test

import (
"fmt"
"testing"

"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
)

type PrivateDNSResolverDnsForwardingRulesetDataSource struct{}

func TestAccPrivateDNSResolverDnsForwardingRulesetDataSource_basic(t *testing.T) {
data := acceptance.BuildTestData(t, "data.azurerm_private_dns_resolver_dns_forwarding_ruleset", "test")
d := PrivateDNSResolverDnsForwardingRulesetDataSource{}

data.DataSourceTest(t, []acceptance.TestStep{
{
Config: d.basic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).Key("name").Exists(),
check.That(data.ResourceName).Key("resource_group_name").Exists(),
check.That(data.ResourceName).Key("location").HasValue(location.Normalize(data.Locations.Primary)),
check.That(data.ResourceName).Key("private_dns_resolver_outbound_endpoint_ids.0").Exists(),
),
},
})
}

func (d PrivateDNSResolverDnsForwardingRulesetDataSource) basic(data acceptance.TestData) string {
return fmt.Sprintf(`
%s

data "azurerm_private_dns_resolver_dns_forwarding_ruleset" "test" {
name = azurerm_private_dns_resolver_dns_forwarding_ruleset.test.name
resource_group_name = azurerm_resource_group.test.name
}
`, PrivateDNSResolverDnsForwardingRulesetResource{}.basic(data))
}
1 change: 1 addition & 0 deletions internal/services/privatednsresolver/registration.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ func (r Registration) SupportedResources() map[string]*pluginsdk.Resource {
// DataSources returns a list of Data Sources supported by this Service
func (r Registration) DataSources() []sdk.DataSource {
return []sdk.DataSource{
PrivateDNSResolverDnsForwardingRulesetDataSource{},
PrivateDNSResolverDnsResolverDataSource{},
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
subcategory: "Private DNS Resolver"
layout: "azurerm"
page_title: "Azure Resource Manager: azurerm_private_dns_resolver_dns_forwarding_ruleset"
description: |-
Gets information about an existing Private DNS Resolver Dns Forwarding Ruleset.
---

# Data Source: azurerm_private_dns_resolver_dns_forwarding_ruleset

Gets information about an existing Private DNS Resolver Dns Forwarding Ruleset.

## Example Usage

```hcl
data "azurerm_private_dns_resolver_dns_forwarding_ruleset" "example" {
name = "example-ruleset"
resource_group_name = "example-ruleset-resourcegroup"
}
```

## Arguments Reference

The following arguments are supported:

* `name` - (Required) Name of the existing Private DNS Resolver Dns Forwarding Ruleset.

* `resource_group_name` - (Required) Name of the Resource Group where the Private DNS Resolver Dns Forwarding Ruleset exists.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

* `id` - The ID of the Private DNS Resolver Dns Forwarding Ruleset.

* `private_dns_resolver_outbound_endpoint_ids` - The IDs list of the Private DNS Resolver Outbound Endpoints that are linked to the Private DNS Resolver Dns Forwarding Ruleset.

* `location` - The Azure Region where the Private DNS Resolver Dns Forwarding Ruleset exists.

* `tags` - The tags assigned to the Private DNS Resolver Dns Forwarding Ruleset.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `read` - (Defaults to 5 minutes) Used when retrieving the Private DNS Resolver Dns Forwarding Ruleset.