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_outbound_endpoint #19950

Merged
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,115 @@
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/dnsresolvers"
"github.com/hashicorp/go-azure-sdk/resource-manager/dnsresolver/2022-07-01/outboundendpoints"
"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 PrivateDNSResolverOutboundEndpointDataSourceModel struct {
Name string `tfschema:"name"`
PrivateDNSResolverId string `tfschema:"private_dns_resolver_id"`
Location string `tfschema:"location"`
SubnetId string `tfschema:"subnet_id"`
Tags map[string]string `tfschema:"tags"`
}

type PrivateDNSResolverOutboundEndpointDataSource struct{}

var _ sdk.DataSource = PrivateDNSResolverOutboundEndpointDataSource{}

func (r PrivateDNSResolverOutboundEndpointDataSource) ResourceType() string {
return "azurerm_private_dns_resolver_outbound_endpoint"
}

func (r PrivateDNSResolverOutboundEndpointDataSource) ModelObject() interface{} {
return &PrivateDNSResolverOutboundEndpointDataSourceModel{}
}

func (r PrivateDNSResolverOutboundEndpointDataSource) IDValidationFunc() pluginsdk.SchemaValidateFunc {
return outboundendpoints.ValidateOutboundEndpointID
}

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

"private_dns_resolver_id": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: dnsresolvers.ValidateDnsResolverID,
},
}
}

func (r PrivateDNSResolverOutboundEndpointDataSource) Attributes() map[string]*pluginsdk.Schema {
return map[string]*pluginsdk.Schema{
"subnet_id": {
Type: pluginsdk.TypeString,
Computed: true,
},

"location": commonschema.LocationComputed(),

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

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

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

privateDnsResolverId, err := outboundendpoints.ParseDnsResolverID(state.PrivateDNSResolverId)
if err != nil {
return err
}

id := outboundendpoints.NewOutboundEndpointID(
privateDnsResolverId.SubscriptionId,
privateDnsResolverId.ResourceGroupName,
privateDnsResolverId.DnsResolverName,
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.PrivateDNSResolverId = dnsresolvers.NewDnsResolverID(id.SubscriptionId, id.ResourceGroupName, id.DnsResolverName).ID()
state.SubnetId = model.Properties.Subnet.Id

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 DNSResolverOutboundEndpointDataSource struct{}

func TestAccDNSResolverOutboundEndpointDataSource_basic(t *testing.T) {
data := acceptance.BuildTestData(t, "data.azurerm_private_dns_resolver_outbound_endpoint", "test")
d := DNSResolverOutboundEndpointDataSource{}

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

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

data "azurerm_private_dns_resolver_outbound_endpoint" "test" {
name = azurerm_private_dns_resolver_outbound_endpoint.test.name
private_dns_resolver_id = azurerm_private_dns_resolver.test.id
}
`, DNSResolverOutboundEndpointResource{}.basic(data))
}
1 change: 1 addition & 0 deletions internal/services/privatednsresolver/registration.go
Original file line number Diff line number Diff line change
@@ -42,6 +42,7 @@ func (r Registration) SupportedResources() map[string]*pluginsdk.Resource {
func (r Registration) DataSources() []sdk.DataSource {
return []sdk.DataSource{
PrivateDNSResolverDnsResolverDataSource{},
PrivateDNSResolverOutboundEndpointDataSource{},
}
}

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_outbound_endpoint"
description: |-
Gets information about an existing Private DNS Resolver Outbound Endpoint.
---

# Data Source: azurerm_private_dns_resolver_outbound_endpoint

Gets information about an existing Private DNS Resolver Outbound Endpoint.

## Example Usage

```hcl
data "azurerm_private_dns_resolver_outbound_endpoint" "example" {
name = "example-endpoint"
private_dns_resolver_id = "example-private-dns-resolver-id"
}
```

## Arguments Reference

The following arguments are supported:

* `name` - (Required) Name of the Private DNS Resolver Outbound Endpoint.

* `private_dns_resolver_id` - (Required) ID of the Private DNS Resolver Outbound Endpoint.

## Attributes Reference

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

* `id` - The ID of the Private DNS Resolver Outbound Endpoint.

* `location` - The Azure Region where the Private DNS Resolver Outbound Endpoint exists.

* `subnet_id` - The ID of the Subnet that is linked to the Private DNS Resolver Outbound Endpoint.

* `tags` - The tags assigned to the Private DNS Resolver Outbound Endpoint.

## 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 Outbound Endpoint.