azurerm_nginx_deployment: Deprecate diagnose_support_enabled in v5.0

NGINXaaS is deprecating the diagnose_support_enabled field. Metrics will be enabled by default on all deployments and doesn't need to be explicity enabled via this field.

Author: arpith-f5

internal/services/nginx/nginx_api_key_resource_test.go

@@ -175,12 +175,11 @@ resource "azurerm_subnet" "test" {
 }
 
 resource "azurerm_nginx_deployment" "test" {
-  name                     = "acctest-%[1]d"
-  resource_group_name      = azurerm_resource_group.test.name
-  sku                      = "standardv2_Monthly"
-  capacity                 = 10
-  location                 = azurerm_resource_group.test.location
-  diagnose_support_enabled = false
+  name                = "acctest-%[1]d"
+  resource_group_name = azurerm_resource_group.test.name
+  sku                 = "standardv2_Monthly"
+  capacity            = 10
+  location            = azurerm_resource_group.test.location
 
   frontend_public {
     ip_address = [azurerm_public_ip.test.id]

internal/services/nginx/nginx_certificate_resource_test.go

@@ -223,12 +223,11 @@ resource "azurerm_user_assigned_identity" "test" {
 
 
 resource "azurerm_nginx_deployment" "test" {
-  name                     = "acctest-%[1]d"
-  resource_group_name      = azurerm_resource_group.test.name
-  sku                      = "standardv2_Monthly"
-  capacity                 = 10
-  location                 = azurerm_resource_group.test.location
-  diagnose_support_enabled = false
+  name                = "acctest-%[1]d"
+  resource_group_name = azurerm_resource_group.test.name
+  sku                 = "standardv2_Monthly"
+  capacity            = 10
+  location            = azurerm_resource_group.test.location
 
   identity {
     type         = "UserAssigned"

internal/services/nginx/nginx_configuration_resource_test.go

@@ -289,8 +289,6 @@ resource "azurerm_nginx_deployment" "test" {
   capacity            = 10
   location            = azurerm_resource_group.test.location
 
-  diagnose_support_enabled = false
-
   frontend_public {
     ip_address = [azurerm_public_ip.test.id]
   }

internal/services/nginx/nginx_deployment_data_source.go

@@ -29,7 +29,7 @@ type DeploymentDataSourceModel struct {
 	Location               string                                     `tfschema:"location"`
 	Capacity               int64                                      `tfschema:"capacity"`
 	AutoScaleProfile       []AutoScaleProfile                         `tfschema:"auto_scale_profile"`
-	DiagnoseSupportEnabled bool                                       `tfschema:"diagnose_support_enabled"`
+	DiagnoseSupportEnabled bool                                       `tfschema:"diagnose_support_enabled, removedInNextMajorVersion"`
 	Email                  string                                     `tfschema:"email"`
 	IpAddress              string                                     `tfschema:"ip_address"`
 	LoggingStorageAccount  []LoggingStorageAccount                    `tfschema:"logging_storage_account,removedInNextMajorVersion"`
@@ -107,11 +107,6 @@ func (m DeploymentDataSource) Attributes() map[string]*pluginsdk.Schema {
 			},
 		},
 
-		"diagnose_support_enabled": {
-			Type:     pluginsdk.TypeBool,
-			Computed: true,
-		},
-
 		"email": {
 			Type:     pluginsdk.TypeString,
 			Computed: true,
@@ -232,6 +227,12 @@ func (m DeploymentDataSource) Attributes() map[string]*pluginsdk.Schema {
 				},
 			},
 		}
+
+		dataSource["diagnose_support_enabled"] = &pluginsdk.Schema{
+			Deprecated: "this property is deprecated and will be removed in v5.0, metrics are enabled by default.",
+			Type:       pluginsdk.TypeBool,
+			Computed:   true,
+		}
 	}
 	return dataSource
 }
@@ -323,7 +324,6 @@ func (m DeploymentDataSource) Read() sdk.ResourceFunc {
 					output.IpAddress = pointer.From(props.IPAddress)
 					output.NginxVersion = pointer.From(props.NginxVersion)
 					output.DataplaneAPIEndpoint = pointer.From(props.DataplaneApiEndpoint)
-					output.DiagnoseSupportEnabled = pointer.From(props.EnableDiagnosticsSupport)
 
 					if !features.FivePointOh() {
 						if props.Logging != nil && props.Logging.StorageAccount != nil {
@@ -334,6 +334,7 @@ func (m DeploymentDataSource) Read() sdk.ResourceFunc {
 								},
 							}
 						}
+						output.DiagnoseSupportEnabled = pointer.From(props.EnableDiagnosticsSupport)
 					}
 
 					if profile := props.NetworkProfile; profile != nil {

internal/services/nginx/nginx_deployment_resource.go

@@ -77,7 +77,7 @@ type DeploymentModel struct {
 	Location               string                                     `tfschema:"location"`
 	Capacity               int64                                      `tfschema:"capacity"`
 	AutoScaleProfile       []AutoScaleProfile                         `tfschema:"auto_scale_profile"`
-	DiagnoseSupportEnabled bool                                       `tfschema:"diagnose_support_enabled"`
+	DiagnoseSupportEnabled bool                                       `tfschema:"diagnose_support_enabled, removedInNextMajorVersion"`
 	Email                  string                                     `tfschema:"email"`
 	IpAddress              string                                     `tfschema:"ip_address"`
 	LoggingStorageAccount  []LoggingStorageAccount                    `tfschema:"logging_storage_account,removedInNextMajorVersion"`
@@ -188,12 +188,6 @@ func (m DeploymentResource) Arguments() map[string]*pluginsdk.Schema {
 			},
 		},
 
-		"diagnose_support_enabled": {
-			Type:         pluginsdk.TypeBool,
-			Optional:     true,
-			ValidateFunc: nil,
-		},
-
 		"email": {
 			Type:         pluginsdk.TypeString,
 			Optional:     true,
@@ -324,6 +318,13 @@ func (m DeploymentResource) Arguments() map[string]*pluginsdk.Schema {
 				},
 			},
 		}
+
+		resource["diagnose_support_enabled"] = &pluginsdk.Schema{
+			Deprecated:   "this property is deprecated and will be removed in v5.0, metrics are enabled by default.",
+			Type:         pluginsdk.TypeBool,
+			Optional:     true,
+			ValidateFunc: nil,
+		}
 	}
 	return resource
 }
@@ -397,9 +398,9 @@ func (m DeploymentResource) Create() sdk.ResourceFunc {
 						},
 					}
 				}
+				prop.EnableDiagnosticsSupport = pointer.To(model.DiagnoseSupportEnabled)
 			}
 
-			prop.EnableDiagnosticsSupport = pointer.To(model.DiagnoseSupportEnabled)
 			prop.NetworkProfile = expandNetworkProfile(model.FrontendPublic, model.FrontendPrivate, model.NetworkInterface)
 
 			isBasicSKU := strings.HasPrefix(model.Sku, "basic")
@@ -512,7 +513,6 @@ func (m DeploymentResource) Read() sdk.ResourceFunc {
 					output.IpAddress = pointer.From(props.IPAddress)
 					output.NginxVersion = pointer.From(props.NginxVersion)
 					output.DataplaneAPIEndpoint = pointer.From(props.DataplaneApiEndpoint)
-					output.DiagnoseSupportEnabled = pointer.From(props.EnableDiagnosticsSupport)
 
 					if !features.FivePointOh() {
 						if props.Logging != nil && props.Logging.StorageAccount != nil {
@@ -523,6 +523,7 @@ func (m DeploymentResource) Read() sdk.ResourceFunc {
 								},
 							}
 						}
+						output.DiagnoseSupportEnabled = pointer.From(props.EnableDiagnosticsSupport)
 					}
 
 					if profile := props.NetworkProfile; profile != nil {

internal/services/nginx/nginx_deployment_resource_test.go

@@ -175,7 +175,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_public {
@@ -208,7 +207,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_private {
@@ -243,7 +241,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_public {
@@ -286,7 +283,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_public {
@@ -325,11 +321,10 @@ func (a DeploymentResource) update(data acceptance.TestData) string {
 %s
 
 resource "azurerm_nginx_deployment" "test" {
-  name                     = "acctest-%[2]d"
-  resource_group_name      = azurerm_resource_group.test.name
-  sku                      = "standardv2_Monthly"
-  location                 = azurerm_resource_group.test.location
-  diagnose_support_enabled = false
+  name                = "acctest-%[2]d"
+  resource_group_name = azurerm_resource_group.test.name
+  sku                 = "standardv2_Monthly"
+  location            = azurerm_resource_group.test.location
 
   frontend_public {
     ip_address = [azurerm_public_ip.test.id]
@@ -361,7 +356,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_private {
@@ -396,7 +390,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_private {
@@ -431,7 +424,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_public {
@@ -530,7 +522,6 @@ resource "azurerm_nginx_deployment" "test" {
   resource_group_name       = azurerm_resource_group.test.name
   sku                       = "standardv2_Monthly"
   location                  = azurerm_resource_group.test.location
-  diagnose_support_enabled  = false
   automatic_upgrade_channel = "stable"
 
   frontend_public {

website/docs/5.0-upgrade-guide.html.markdown

@@ -393,6 +393,7 @@ Please follow the format in the example below for listing breaking changes in re
 
 * The deprecated `logging_storage_account` block has been removed in favour of the `azurerm_monitor_diagnostic_setting` resource.
 * The deprecated `managed_resource_group` property has been removed.
+* The deprecated `diagnose_support_enabled` property has been removed.
 
 ### `azurerm_palo_alto_next_generation_firewall_virtual_hub_local_rulestack`
 
@@ -564,6 +565,7 @@ Please follow the format in the example below for listing breaking changes in da
 
 * The deprecated `logging_storage_account` block has been removed.
 * The deprecated `managed_resource_group` property has been removed.
+* The deprecated `diagnose_support_enabled` property has been removed.
 
 ### `azurerm_servicebus_namespace_disaster_recovery_config`
 

website/docs/d/nginx_deployment.html.markdown

@@ -41,8 +41,6 @@ In addition to the Arguments listed above - the following Attributes are exporte
 
 * `auto_scale_profile` - An `auto_scale_profile` block as defined below.
 
-* `diagnose_support_enabled` - Whether metrics are exported to Azure Monitor.
-
 * `email` - Preferred email associated with the NGINX Deployment.
 
 * `frontend_private` - A `frontend_private` block as defined below.

website/docs/r/nginx_certificate.html.markdown

@@ -55,13 +55,11 @@ resource "azurerm_subnet" "example" {
 }
 
 resource "azurerm_nginx_deployment" "example" {
-  name                     = "example-nginx"
-  resource_group_name      = azurerm_resource_group.example.name
-  sku                      = "publicpreview_Monthly_gmz7xq9ge3py"
-  location                 = azurerm_resource_group.example.location
-  managed_resource_group   = "example"
-  diagnose_support_enabled = true
-
+  name                   = "example-nginx"
+  resource_group_name    = azurerm_resource_group.example.name
+  sku                    = "publicpreview_Monthly_gmz7xq9ge3py"
+  location               = azurerm_resource_group.example.location
+  managed_resource_group = "example"
   frontend_public {
     ip_address = [azurerm_public_ip.example.id]
   }

website/docs/r/nginx_configuration.html.markdown

@@ -55,11 +55,10 @@ resource "azurerm_subnet" "example" {
 }
 
 resource "azurerm_nginx_deployment" "example" {
-  name                     = "example-nginx"
-  resource_group_name      = azurerm_resource_group.example.name
-  sku                      = "publicpreview_Monthly_gmz7xq9ge3py"
-  location                 = azurerm_resource_group.example.location
-  diagnose_support_enabled = true
+  name                = "example-nginx"
+  resource_group_name = azurerm_resource_group.example.name
+  sku                 = "publicpreview_Monthly_gmz7xq9ge3py"
+  location            = azurerm_resource_group.example.location
 
   frontend_public {
     ip_address = [azurerm_public_ip.example.id]