Skip to content

Commit

Permalink
azurerm_private_endpoint - add member_name property of `ip_config…
Browse files Browse the repository at this point in the history 
…uration` block, support multiple `ip_configuration` blocks.
  • Loading branch information
@ziyeqf
ziyeqf committed Nov 22, 2022
1 parent eb6194f commit cf08ff7
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 19 deletions.
15 changes: 13 additions & 2 deletions internal/services/network/private_endpoint_resource.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,6 @@ func resourcePrivateEndpoint() *pluginsdk.Resource {
"ip_configuration": {
Type: pluginsdk.TypeList,
Optional: true,
MaxItems: 1,
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"name": {
Expand All @@ -196,6 +195,13 @@ func resourcePrivateEndpoint() *pluginsdk.Resource {
ForceNew: true,
ValidateFunc: validation.StringIsNotEmpty,
},
"member_name": { // TODO: set to Required & ForceNew, remove Computed in 4.0
Type: pluginsdk.TypeString,
Optional: true,
Computed: true, // to avoid breaking change, set it to `Computed`.
ForceNew: true,
ValidateFunc: validation.StringIsNotEmpty,
},
},
},
},
Expand Down Expand Up @@ -764,13 +770,17 @@ func expandPrivateEndpointIPConfigurations(input []interface{}) *[]network.Priva
v := item.(map[string]interface{})
privateIPAddress := v["private_ip_address"].(string)
subResourceName := v["subresource_name"].(string)
memberName := v["member_name"].(string)
if memberName == "" {
memberName = subResourceName
}
name := v["name"].(string)
result := network.PrivateEndpointIPConfiguration{
Name: utils.String(name),
PrivateEndpointIPConfigurationProperties: &network.PrivateEndpointIPConfigurationProperties{
PrivateIPAddress: utils.String(privateIPAddress),
GroupID: utils.String(subResourceName),
MemberName: utils.String(subResourceName),
MemberName: utils.String(memberName),
},
}
results = append(results, result)
Expand All @@ -790,6 +800,7 @@ func flattenPrivateEndpointIPConfigurations(ipConfigurations *[]network.PrivateE
"name": item.Name,
"private_ip_address": item.PrivateIPAddress,
"subresource_name": item.GroupID,
"member_name": item.MemberName,
})
}

Expand Down
79 changes: 74 additions & 5 deletions internal/services/network/private_endpoint_resource_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,21 @@ func TestAccPrivateEndpoint_multipleInstances(t *testing.T) {
})
}

func TestAccPrivateEndpoint_multipleIpConfigurations(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_private_endpoint", "test")
r := PrivateEndpointResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.recoveryServiceVaultWithMultiIpConfig(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep(),
})
}

func (PrivateEndpointResource) template(data acceptance.TestData, seviceCfg string) string {
return fmt.Sprintf(`
provider "azurerm" {
Expand All @@ -316,7 +331,7 @@ provider "azurerm" {
data "azurerm_subscription" "current" {}
resource "azurerm_resource_group" "test" {
name = "zjhe-acctestRG-privatelink-%d"
name = "acctestRG-privatelink-%d"
location = "%s"
}
Expand Down Expand Up @@ -501,7 +516,7 @@ provider "azurerm" {
}
resource "azurerm_resource_group" "test" {
name = "zjhe-acctestRG-privatelink-%d"
name = "acctestRG-privatelink-%d"
location = "%s"
}
Expand Down Expand Up @@ -581,7 +596,7 @@ provider "azurerm" {
}
resource "azurerm_resource_group" "test" {
name = "zjhe-acctestRG-privatelink-%d"
name = "acctestRG-privatelink-%d"
location = "%s"
}
Expand Down Expand Up @@ -656,7 +671,7 @@ provider "azurerm" {
}
resource "azurerm_resource_group" "test" {
name = "zjhe-acctestRG-privatelink-%d"
name = "acctestRG-privatelink-%d"
location = "%s"
}
Expand Down Expand Up @@ -741,7 +756,7 @@ provider "azurerm" {
}
resource "azurerm_resource_group" "test" {
name = "zjhe-acctestRG-privatelink-%d"
name = "acctestRG-privatelink-%d"
location = "%s"
}
Expand Down Expand Up @@ -862,3 +877,57 @@ resource "azurerm_private_endpoint" "test" {
}
`, r.template(data, r.serviceAutoApprove(data)), count, data.RandomInteger)
}

func (r PrivateEndpointResource) recoveryServiceVaultWithMultiIpConfig(data acceptance.TestData) string {
return fmt.Sprintf(`
%s
locals {
ip_configs = {
"SiteRecovery-prot2" = "10.5.2.24"
"SiteRecovery-srs1" = "10.5.2.25"
"SiteRecovery-id1" = "10.5.2.26"
"SiteRecovery-tel1" = "10.5.2.27"
"SiteRecovery-rcm1" = "10.5.2.28"
}
}
resource "azurerm_recovery_services_vault" "test" {
name = "acctest-vault-%[2]d"
location = azurerm_resource_group.test.location
resource_group_name = azurerm_resource_group.test.name
sku = "Standard"
soft_delete_enabled = false
identity {
type = "SystemAssigned"
}
}
resource "azurerm_private_endpoint" "test" {
name = "acctest-privatelink-%[2]d"
resource_group_name = azurerm_resource_group.test.name
location = azurerm_resource_group.test.location
subnet_id = azurerm_subnet.endpoint.id
private_service_connection {
name = "acctest-privatelink-%[2]d"
is_manual_connection = false
subresource_names = ["AzureSiteRecovery"]
private_connection_resource_id = azurerm_recovery_services_vault.test.id
}
dynamic "ip_configuration" {
for_each = local.ip_configs
content {
name = ip_configuration.key
private_ip_address = ip_configuration.value
subresource_name = "AzureSiteRecovery"
member_name = ip_configuration.key
}
}
}
`, r.template(data, r.serviceAutoApprove(data)), data.RandomInteger)
}
30 changes: 18 additions & 12 deletions website/docs/r/private_endpoint.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,18 +176,20 @@ A `private_service_connection` supports the following:

-> Several possible values for this field are shown below, however this is not extensive:

| Resource Type | SubResource Name | Secondary SubResource Name |
| ----------------------------- | ---------------- | -------------------------- |
| Data Lake File System Gen2 | dfs | dfs_secondary |
| SQL Database / Data Warehouse | sqlServer | |
| SQL Managed Instance | managedInstance | |
| Storage Account | blob | blob_secondary |
| Storage Account | file | file_secondary |
| Storage Account | queue | queue_secondary |
| Storage Account | table | table_secondary |
| Storage Account | web | web_secondary |
| Web App / Function App | sites | |
| Resource Type | SubResource Name | Secondary SubResource Name |
|-------------------------------|------------------------|----------------------------|
| Data Lake File System Gen2 | dfs | dfs_secondary |
| SQL Database / Data Warehouse | sqlServer | |
| SQL Managed Instance | managedInstance | |
| Storage Account | blob | blob_secondary |
| Storage Account | file | file_secondary |
| Storage Account | queue | queue_secondary |
| Storage Account | table | table_secondary |
| Storage Account | web | web_secondary |
| Web App / Function App | sites | |
| Web App / Function App Slots | sites-<slotName> | |
| Recovery Services Vault | AzureBackup | |
| Recovery Services Vault | AzureSiteRecovery | |

Some resource types (such as Storage Account) only support 1 subresource per private endpoint. See the product [documentation](https://docs.microsoft.com/azure/private-link/private-endpoint-overview#private-link-resource) for more information.

Expand All @@ -201,7 +203,11 @@ An `ip_configuration` supports the following:

* `private_ip_address` - (Required) Specifies the static IP address within the private endpoint's subnet to be used. Changing this forces a new resource to be created.

* `subresource_name` - (Required) Specifies the subresource this IP address applies to. `subresource_names` corresponds to `group_id` and in this context is also used for `member_name`. Changing this forces a new resource to be created.
* `subresource_name` - (Required) Specifies the subresource this IP address applies to. `subresource_names` corresponds to `group_id`. Changing this forces a new resource to be created.

* `member_name` - (Optional) Specifies the member name this IP address applies to. If it is not specified, it will use the value of `subresource_name`. Changing this forces a new resource to be created.

-> **NOTE:** `member_name` will be required and will not take the value of `subresource_name` in the next major version.

## Attributes Reference

Expand Down

0 comments on commit cf08ff7

Please sign in to comment.