[Deprecation] azurerm_express_route_connection - Remove `private_li…

…nk_fast_path_enabled` (hashicorp#28161) * deprecate `private_link_fast_path_enabled` * update deprecate message * remove private_link_fast_path_enabled from doc * update deprecate msg * update documentation
wuxu92 · Jan 7, 2025 · 1387a8b · 1387a8b
1 parent 4a33e95
commit 1387a8b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 25 deletions.
diff --git a/internal/services/network/express_route_connection_resource.go b/internal/services/network/express_route_connection_resource.go
@@ -15,6 +15,7 @@ import (
 	"github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-03-01/expressrouteconnections"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/features"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/services/network/validate"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
@@ -23,7 +24,7 @@ import (
 )
 
 func resourceExpressRouteConnection() *pluginsdk.Resource {
-	return &pluginsdk.Resource{
+	resource := &pluginsdk.Resource{
 		Create: resourceExpressRouteConnectionCreate,
 		Read:   resourceExpressRouteConnectionRead,
 		Update: resourceExpressRouteConnectionUpdate,
@@ -75,11 +76,6 @@ func resourceExpressRouteConnection() *pluginsdk.Resource {
 				Optional: true,
 			},
 
-			"private_link_fast_path_enabled": {
-				Type:     pluginsdk.TypeBool,
-				Optional: true,
-			},
-
 			"express_route_gateway_bypass_enabled": {
 				Type:     pluginsdk.TypeBool,
 				Optional: true,
@@ -157,6 +153,16 @@ func resourceExpressRouteConnection() *pluginsdk.Resource {
 			},
 		},
 	}
+
+	if !features.FivePointOhBeta() {
+		resource.Schema["private_link_fast_path_enabled"] = &pluginsdk.Schema{
+			Type:       pluginsdk.TypeBool,
+			Optional:   true,
+			Deprecated: "'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider",
+		}
+	}
+
+	return resource
 }
 
 func resourceExpressRouteConnectionCreate(d *pluginsdk.ResourceData, meta interface{}) error {
@@ -195,14 +201,6 @@ func resourceExpressRouteConnectionCreate(d *pluginsdk.ResourceData, meta interf
 		},
 	}
 
-	privateLinkFastPath := d.GetRawConfig().AsValueMap()["private_link_fast_path_enabled"]
-	if !privateLinkFastPath.IsNull() {
-		if d.Get("private_link_fast_path_enabled").(bool) && !d.Get("express_route_gateway_bypass_enabled").(bool) {
-			return fmt.Errorf("`express_route_gateway_bypass_enabled` must be enabled when `private_link_fast_path_enabled` is set to `true`")
-		}
-		parameters.Properties.EnablePrivateLinkFastPath = pointer.To(d.Get("private_link_fast_path_enabled").(bool))
-	}
-
 	if v, ok := d.GetOk("authorization_key"); ok {
 		parameters.Properties.AuthorizationKey = pointer.To(v.(string))
 	}
@@ -243,7 +241,6 @@ func resourceExpressRouteConnectionRead(d *pluginsdk.ResourceData, meta interfac
 			d.Set("routing_weight", props.RoutingWeight)
 			d.Set("authorization_key", props.AuthorizationKey)
 			d.Set("enable_internet_security", props.EnableInternetSecurity)
-			d.Set("private_link_fast_path_enabled", pointer.From(props.EnablePrivateLinkFastPath))
 
 			if props.ExpressRouteGatewayBypass != nil {
 				d.Set("express_route_gateway_bypass_enabled", props.ExpressRouteGatewayBypass)
@@ -295,14 +292,6 @@ func resourceExpressRouteConnectionUpdate(d *pluginsdk.ResourceData, meta interf
 		},
 	}
 
-	privateLinkFastPath := d.GetRawConfig().AsValueMap()["private_link_fast_path_enabled"]
-	if !privateLinkFastPath.IsNull() {
-		if d.Get("private_link_fast_path_enabled").(bool) && !d.Get("express_route_gateway_bypass_enabled").(bool) {
-			return fmt.Errorf("`express_route_gateway_bypass_enabled` must be enabled when `private_link_fast_path_enabled` is set to `true`")
-		}
-		parameters.Properties.EnablePrivateLinkFastPath = pointer.To(d.Get("private_link_fast_path_enabled").(bool))
-	}
-
 	if v, ok := d.GetOk("authorization_key"); ok {
 		parameters.Properties.AuthorizationKey = pointer.To(v.(string))
 	}

diff --git a/website/docs/5.0-upgrade-guide.html.markdown b/website/docs/5.0-upgrade-guide.html.markdown
@@ -106,6 +106,10 @@ Please follow the format in the example below for listing breaking changes in re
 
 * The `minimum_tls_version` property no longer accepts `1.0` and `1.1` as a value.
 
+### `azurerm_express_route_connection`
+
+* The deprecated `private_link_fast_path_enabled` property has been removed as it is no longer supported by the resource.
+
 ### `azurerm_logic_app_standard`
 
 * The deprecated `site_config.public_network_access_enabled` property has been removed and superseded by the `public_network_access` property.

diff --git a/website/docs/r/express_route_connection.html.markdown b/website/docs/r/express_route_connection.html.markdown
@@ -98,8 +98,6 @@ The following arguments are supported:
 
 * `express_route_gateway_bypass_enabled` - (Optional) Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to `false`.
 
-* `private_link_fast_path_enabled` - (Optional) Bypass the Express Route gateway when accessing private-links. When enabled `express_route_gateway_bypass_enabled` must be set to `true`.
-
 * `routing` - (Optional) A `routing` block as defined below.
 
 * `routing_weight` - (Optional) The routing weight associated to the Express Route Connection. Possible value is between `0` and `32000`. Defaults to `0`.