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.

Sign up for GitHub

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

azurerm_mssql_managed_instance - support for properties database_format and hybrid_secondary_usage #28248

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+182 −2
Open

azurerm_mssql_managed_instance - support for properties database_format and hybrid_secondary_usage #28248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 35 additions & 2 deletions internal/services/mssqlmanagedinstance/mssql_managed_instance_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ type MsSqlManagedInstanceModel struct {
AzureActiveDirectoryAdministrator []AzureActiveDirectoryAdministrator `tfschema:"azure_active_directory_administrator"`
ZoneRedundantEnabled bool `tfschema:"zone_redundant_enabled"`
Tags map[string]string `tfschema:"tags"`
DatabaseFormat string `tfschema:"database_format"`
HybridSecondaryUsage string `tfschema:"hybrid_secondary_usage"`
}

type AzureActiveDirectoryAdministrator struct {
Expand Down Expand Up @@ -230,12 +232,26 @@ func (r MsSqlManagedInstanceResource) Arguments() map[string]*pluginsdk.Schema {
ForceNew: true,
},

"database_format": {
Type: schema.TypeString,
Optional: true,
Default: managedinstances.ManagedInstanceDatabaseFormatSQLServerTwoZeroTwoTwo,
ValidateFunc: validation.StringInSlice(managedinstances.PossibleValuesForManagedInstanceDatabaseFormat(), false),
},

"dns_zone_partner_id": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validate.ManagedInstanceID,
},

"hybrid_secondary_usage": {
Type: schema.TypeString,
Optional: true,
Default: managedinstances.HybridSecondaryUsageActive,
ValidateFunc: validation.StringInSlice(managedinstances.PossibleValuesForHybridSecondaryUsage(), false),
},

"identity": commonschema.SystemAssignedUserAssignedIdentityOptional(),

"maintenance_configuration_name": {
Expand Down Expand Up @@ -361,6 +377,13 @@ func (r MsSqlManagedInstanceResource) CustomizeDiff() sdk.ResourceFunc {
}
}

// Once the `AlwaysUpToDate` is enabled, you can't go back to `SQLServer2022` update policy.
if oldVal, newVal := rd.GetChange("database_format"); oldVal.(string) == string(managedinstances.ManagedInstanceDatabaseFormatAlwaysUpToDate) && newVal.(string) == string(managedinstances.ManagedInstanceDatabaseFormatSQLServerTwoZeroTwoTwo) {
if err := rd.ForceNew("database_format"); err != nil {
return err
}
}

_, aadAdminOk := rd.GetOk("azure_active_directory_administrator")
authOnlyEnabled := rd.Get("azure_active_directory_administrator.0.azuread_authentication_only_enabled").(bool)
_, loginOk := rd.GetOk("administrator_login")
Expand Down Expand Up @@ -426,7 +449,9 @@ func (r MsSqlManagedInstanceResource) Create() sdk.ResourceFunc {
VCores: pointer.To(model.VCores),
ZoneRedundant: pointer.To(model.ZoneRedundantEnabled),
// `Administrators` is only valid when specified during creation`
Administrators: expandMsSqlManagedInstanceExternalAdministrators(model.AzureActiveDirectoryAdministrator),
Administrators: expandMsSqlManagedInstanceExternalAdministrators(model.AzureActiveDirectoryAdministrator),
DatabaseFormat: pointer.To(managedinstances.ManagedInstanceDatabaseFormat(model.DatabaseFormat)),
HybridSecondaryUsage: pointer.To(managedinstances.HybridSecondaryUsage(model.HybridSecondaryUsage)),
},
Tags: pointer.To(model.Tags),
}
Expand Down Expand Up @@ -583,7 +608,13 @@ func (r MsSqlManagedInstanceResource) Update() sdk.ResourceFunc {
}
}

metadata.Logger.Infof("Updating %s", *id)
if metadata.ResourceData.HasChange("database_format") {
properties.Properties.DatabaseFormat = pointer.To(managedinstances.ManagedInstanceDatabaseFormat(state.DatabaseFormat))
}

if metadata.ResourceData.HasChange("hybrid_secondary_usage") {
properties.Properties.HybridSecondaryUsage = pointer.To(managedinstances.HybridSecondaryUsage(state.HybridSecondaryUsage))
}

err = client.CreateOrUpdateThenPoll(ctx, *id, properties)
if err != nil {
Expand Down Expand Up @@ -674,6 +705,8 @@ func (r MsSqlManagedInstanceResource) Read() sdk.ResourceFunc {
if props.ServicePrincipal != nil {
model.ServicePrincipalType = string(pointer.From(props.ServicePrincipal.Type))
}
model.DatabaseFormat = string(pointer.From(props.DatabaseFormat))
model.HybridSecondaryUsage = string(pointer.From(props.HybridSecondaryUsage))
}
}
return metadata.Encode(&model)
Expand Down
141 changes: 141 additions & 0 deletions internal/services/mssqlmanagedinstance/mssql_managed_instance_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,57 @@ func TestAccMsSqlManagedInstance_update(t *testing.T) {
})
}

func TestAccMsSqlManagedInstance_databaseFormat(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_mssql_managed_instance", "test")
r := MsSqlManagedInstanceResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.databaseFormat(data, "SQLServer2022"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("administrator_login_password"),
{
Config: r.databaseFormat(data, "AlwaysUpToDate"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("administrator_login_password"),
})
}

func TestAccMsSqlManagedInstance_hybridSecondaryUsage(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_mssql_managed_instance", "test")
r := MsSqlManagedInstanceResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.hybridSecondaryUsage(data, "Passive"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("administrator_login_password"),
{
Config: r.hybridSecondaryUsage(data, "Active"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("administrator_login_password"),
{
Config: r.hybridSecondaryUsage(data, "Passive"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("administrator_login_password"),
})
}

func TestAccMsSqlManagedInstance_premium(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_mssql_managed_instance", "test")
r := MsSqlManagedInstanceResource{}
Expand Down Expand Up @@ -394,6 +445,96 @@ resource "azurerm_mssql_managed_instance" "test" {
`, r.template(data, data.Locations.Primary), data.RandomInteger)
}

func (r MsSqlManagedInstanceResource) databaseFormat(data acceptance.TestData, databaseFormat string) string {
return fmt.Sprintf(`
%[1]s

provider "azurerm" {
features {
resource_group {
/* Due to the creation of unmanaged Microsoft.Network/networkIntentPolicies in this service,
prevent_deletion_if_contains_resources has been added here to allow the test resources to be
deleted until this can be properly investigated
*/
prevent_deletion_if_contains_resources = false
}
}
}

resource "azurerm_mssql_managed_instance" "test" {
name = "acctestsqlserver%[2]d"
resource_group_name = azurerm_resource_group.test.name
location = azurerm_resource_group.test.location

license_type = "BasePrice"
sku_name = "GP_Gen5"
storage_size_in_gb = 32
subnet_id = azurerm_subnet.test.id
vcores = 4

administrator_login = "missadministrator"
administrator_login_password = "NCC-1701-D"

database_format = "%[3]s"

depends_on = [
azurerm_subnet_network_security_group_association.test,
azurerm_subnet_route_table_association.test,
]

tags = {
environment = "staging"
database = "test"
}
}
`, r.template(data, data.Locations.Primary), data.RandomInteger, databaseFormat)
}

func (r MsSqlManagedInstanceResource) hybridSecondaryUsage(data acceptance.TestData, hybridSecondaryUsage string) string {
return fmt.Sprintf(`
%[1]s

provider "azurerm" {
features {
resource_group {
/* Due to the creation of unmanaged Microsoft.Network/networkIntentPolicies in this service,
prevent_deletion_if_contains_resources has been added here to allow the test resources to be
deleted until this can be properly investigated
*/
prevent_deletion_if_contains_resources = false
}
}
}

resource "azurerm_mssql_managed_instance" "test" {
name = "acctestsqlserver%[2]d"
resource_group_name = azurerm_resource_group.test.name
location = azurerm_resource_group.test.location

license_type = "BasePrice"
sku_name = "GP_Gen5"
storage_size_in_gb = 32
subnet_id = azurerm_subnet.test.id
vcores = 4

administrator_login = "missadministrator"
administrator_login_password = "NCC-1701-D"

hybrid_secondary_usage = "%[3]s"

depends_on = [
azurerm_subnet_network_security_group_association.test,
azurerm_subnet_route_table_association.test,
]

tags = {
environment = "staging"
database = "test"
}
}
`, r.template(data, data.Locations.Primary), data.RandomInteger, hybridSecondaryUsage)
}

func (r MsSqlManagedInstanceResource) basicZRS(data acceptance.TestData) string {
return fmt.Sprintf(`
%[1]s
Expand Down
6 changes: 6 additions & 0 deletions website/docs/r/mssql_managed_instance.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,14 @@ The following arguments are supported:

* `collation` - (Optional) Specifies how the SQL Managed Instance will be collated. Default value is `SQL_Latin1_General_CP1_CI_AS`. Changing this forces a new resource to be created.

* `database_format` - (Optional) Specifies the internal format of the SQL Managed Instance databases specific to the SQL engine version. Possible values are `AlwaysUpToDate` and `SQLServer2022`. Defaults to `SQLServer2022`.

~> **NOTE:** Changing `database_format` from `AlwaysUpToDate` to `SQLServer2022` forces a new SQL Managed Instance to be created.

* `dns_zone_partner_id` - (Optional) The ID of the SQL Managed Instance which will share the DNS zone. This is a prerequisite for creating an `azurerm_sql_managed_instance_failover_group`. Setting this after creation forces a new resource to be created.

* `hybrid_secondary_usage` - (Optional) Specifies the hybrid secondary usage for disaster recovery of the SQL Managed Instance. Possible values are `Active` and `Passive`. Defaults to `Active`.

* `identity` - (Optional) An `identity` block as defined below.

* `maintenance_configuration_name` - (Optional) The name of the Public Maintenance Configuration window to apply to the SQL Managed Instance. Valid values include `SQL_Default` or an Azure Location in the format `SQL_{Location}_MI_{Size}`(for example `SQL_EastUS_MI_1`). Defaults to `SQL_Default`.
Expand Down
Loading