Skip to content

Commit

Permalink
azurerm_mssql_managed_instance_failover_group: add property `second…
Browse files Browse the repository at this point in the history 
…ary_type` (#28633)

* wip adding prop secondary_type

* docs update

* add suffix to test resources

* docs update

* clean up

* fmt docs

* defined default value

* use pet names

* Update internal/services/mssqlmanagedinstance/mssql_managed_instance_failover_group_resource.go

Co-authored-by: sreallymatt <[email protected]>

* Apply suggestions from code review

Co-authored-by: sreallymatt <[email protected]>

* pet removal

* feedback

* feedback

* fmt

* undo unnecessary change

* fmt

---------

Co-authored-by: sreallymatt <[email protected]>
  • Loading branch information
@wyattfry @sreallymatt
wyattfry and sreallymatt authored Feb 8, 2025
1 parent 1b41f2e commit 92bb86b
Show file tree
Hide file tree
Showing 3 changed files with 182 additions and 56 deletions.
12 changes: 12 additions & 0 deletions internal/services/mssqlmanagedinstance/mssql_managed_instance_failover_group_resource.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ type MsSqlManagedInstanceFailoverGroupModel struct {
ManagedInstanceId string `tfschema:"managed_instance_id"`
PartnerManagedInstanceId string `tfschema:"partner_managed_instance_id"`
ReadOnlyEndpointFailoverPolicyEnabled bool `tfschema:"readonly_endpoint_failover_policy_enabled"`
SecondaryType string `tfschema:"secondary_type"`

ReadWriteEndpointFailurePolicy []MsSqlManagedInstanceReadWriteEndpointFailurePolicyModel `tfschema:"read_write_endpoint_failover_policy"`

Expand Down Expand Up @@ -118,6 +119,13 @@ func (r MsSqlManagedInstanceFailoverGroupResource) Arguments() map[string]*plugi
},
},
},

"secondary_type": {
Type: pluginsdk.TypeString,
Optional: true,
Default: string(instancefailovergroups.SecondaryInstanceTypeGeo),
ValidateFunc: validation.StringInSlice(instancefailovergroups.PossibleValuesForSecondaryInstanceType(), false),
},
}
}

Expand Down Expand Up @@ -207,6 +215,7 @@ func (r MsSqlManagedInstanceFailoverGroupResource) Create() sdk.ResourceFunc {
PartnerManagedInstanceId: utils.String(partnerId.ID()),
},
},
SecondaryType: pointer.To(instancefailovergroups.SecondaryInstanceType(model.SecondaryType)),
},
}

Expand Down Expand Up @@ -286,6 +295,7 @@ func (r MsSqlManagedInstanceFailoverGroupResource) Update() sdk.ResourceFunc {
PartnerManagedInstanceId: utils.String(partnerId.ID()),
},
},
SecondaryType: pointer.To(instancefailovergroups.SecondaryInstanceType(state.SecondaryType)),
},
}

Expand Down Expand Up @@ -380,6 +390,8 @@ func (r MsSqlManagedInstanceFailoverGroupResource) Read() sdk.ResourceFunc {
}
}

model.SecondaryType = string(pointer.From(props.SecondaryType))

model.ReadWriteEndpointFailurePolicy = []MsSqlManagedInstanceReadWriteEndpointFailurePolicyModel{
{
Mode: string(props.ReadWriteEndpoint.FailoverPolicy),
Expand Down
1 change: 1 addition & 0 deletions ...rnal/services/mssqlmanagedinstance/mssql_managed_instance_failover_group_resource_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ resource "azurerm_mssql_managed_instance_failover_group" "test" {
location = "%[3]s"
managed_instance_id = azurerm_mssql_managed_instance.test.id
partner_managed_instance_id = azurerm_mssql_managed_instance.secondary.id
secondary_type = "Standby"
readonly_endpoint_failover_policy_enabled = true
Expand Down
225 changes: 169 additions & 56 deletions website/docs/r/mssql_managed_instance_failover_group.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,104 +15,215 @@ Manages an Azure SQL Managed Instance Failover Group.
-> **Note:** For a more complete example, see the [`./examples/sql-azure/managed_instance_failover_group` directory](https://github.com/hashicorp/terraform-provider-azurerm/tree/main/examples/sql-azure/managed_instance_failover_group) within the GitHub Repository.

```hcl
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "West Europe"
locals {
name = "mymssqlmitest"
primary_name = "${local.name}-primary"
primary_location = "West Europe"
failover_name = "${local.name}-failover"
failover_location = "North Europe"
}
resource "azurerm_virtual_network" "example" {
name = "example"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
resource "azurerm_mssql_managed_instance_failover_group" "example" {
name = "example-failover-group"
location = azurerm_mssql_managed_instance.primary.location
managed_instance_id = azurerm_mssql_managed_instance.primary.id
partner_managed_instance_id = azurerm_mssql_managed_instance.failover.id
secondary_type = "Geo"
read_write_endpoint_failover_policy {
mode = "Automatic"
grace_minutes = 60
}
depends_on = [
azurerm_private_dns_zone_virtual_network_link.primary,
azurerm_private_dns_zone_virtual_network_link.failover,
]
}
resource "azurerm_private_dns_zone" "example" {
name = "${local.name}.private"
resource_group_name = azurerm_resource_group.primary.name
}
## Primary SQL Managed Instance
resource "azurerm_resource_group" "primary" {
name = local.primary_name
location = local.primary_location
}
resource "azurerm_virtual_network" "primary" {
name = local.primary_name
location = azurerm_resource_group.primary.location
resource_group_name = azurerm_resource_group.primary.name
address_space = ["10.0.0.0/16"]
}
resource "azurerm_subnet" "example" {
name = "example"
resource_group_name = azurerm_resource_group.example.name
virtual_network_name = azurerm_virtual_network.example.name
address_prefixes = ["10.0.2.0/24"]
resource "azurerm_private_dns_zone_virtual_network_link" "primary" {
name = "primary-link"
resource_group_name = azurerm_resource_group.primary.name
private_dns_zone_name = azurerm_private_dns_zone.example.name
virtual_network_id = azurerm_virtual_network.primary.id
}
resource "azurerm_network_security_group" "example" {
name = "example"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
resource "azurerm_subnet" "primary" {
name = local.primary_name
resource_group_name = azurerm_resource_group.primary.name
virtual_network_name = azurerm_virtual_network.primary.name
address_prefixes = ["10.0.1.0/24"]
delegation {
name = "delegation"
service_delegation {
actions = [
"Microsoft.Network/virtualNetworks/subnets/join/action",
"Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action",
"Microsoft.Network/virtualNetworks/subnets/unprepareNetworkPolicies/action",
]
name = "Microsoft.Sql/managedInstances"
}
}
}
resource "azurerm_subnet_network_security_group_association" "example" {
subnet_id = azurerm_subnet.example.id
network_security_group_id = azurerm_network_security_group.example.id
resource "azurerm_network_security_group" "primary" {
name = local.primary_name
location = azurerm_resource_group.primary.location
resource_group_name = azurerm_resource_group.primary.name
}
resource "azurerm_route_table" "example" {
name = "example"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
resource "azurerm_subnet_network_security_group_association" "primary" {
subnet_id = azurerm_subnet.primary.id
network_security_group_id = azurerm_network_security_group.primary.id
}
resource "azurerm_subnet_route_table_association" "example" {
subnet_id = azurerm_subnet.example.id
route_table_id = azurerm_route_table.example.id
resource "azurerm_route_table" "primary" {
name = local.primary_name
location = azurerm_resource_group.primary.location
resource_group_name = azurerm_resource_group.primary.name
}
resource "azurerm_subnet_route_table_association" "primary" {
subnet_id = azurerm_subnet.primary.id
route_table_id = azurerm_route_table.primary.id
}
resource "azurerm_mssql_managed_instance" "primary" {
name = "example-primary"
resource_group_name = azurerm_resource_group.example.name
location = azurerm_resource_group.example.location
name = local.primary_name
resource_group_name = azurerm_resource_group.primary.name
location = azurerm_resource_group.primary.location
administrator_login = "mradministrator"
administrator_login_password = "thisIsDog11"
license_type = "BasePrice"
subnet_id = azurerm_subnet.example.id
subnet_id = azurerm_subnet.primary.id
sku_name = "GP_Gen5"
vcores = 4
storage_size_in_gb = 32
depends_on = [
azurerm_subnet_network_security_group_association.example,
azurerm_subnet_route_table_association.example,
azurerm_subnet_network_security_group_association.primary,
azurerm_subnet_route_table_association.primary,
]
}
resource "azurerm_virtual_network_peering" "primary_to_failover" {
name = "primary-to-failover"
remote_virtual_network_id = azurerm_virtual_network.failover.id
resource_group_name = azurerm_resource_group.primary.name
virtual_network_name = azurerm_virtual_network.primary.name
}
## Secondary (Fail-over) SQL Managed Instance
resource "azurerm_resource_group" "failover" {
name = local.failover_name
location = local.failover_location
}
resource "azurerm_virtual_network" "failover" {
name = local.failover_name
location = azurerm_resource_group.failover.location
resource_group_name = azurerm_resource_group.failover.name
address_space = ["10.1.0.0/16"]
}
resource "azurerm_private_dns_zone_virtual_network_link" "failover" {
name = "failover-link"
resource_group_name = azurerm_private_dns_zone.example.resource_group_name
private_dns_zone_name = azurerm_private_dns_zone.example.name
virtual_network_id = azurerm_virtual_network.failover.id
}
tags = {
environment = "prod"
resource "azurerm_subnet" "default" {
name = "default"
resource_group_name = azurerm_resource_group.failover.name
virtual_network_name = azurerm_virtual_network.failover.name
address_prefixes = ["10.1.0.0/24"]
}
resource "azurerm_subnet" "failover" {
name = "ManagedInstance"
resource_group_name = azurerm_resource_group.failover.name
virtual_network_name = azurerm_virtual_network.failover.name
address_prefixes = ["10.1.1.0/24"]
delegation {
name = "delegation"
service_delegation {
actions = [
"Microsoft.Network/virtualNetworks/subnets/join/action",
"Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action",
"Microsoft.Network/virtualNetworks/subnets/unprepareNetworkPolicies/action",
]
name = "Microsoft.Sql/managedInstances"
}
}
}
resource "azurerm_mssql_managed_instance" "secondary" {
name = "example-secondary"
resource_group_name = azurerm_resource_group.example.name
location = azurerm_resource_group.example.location
resource "azurerm_network_security_group" "failover" {
name = local.failover_name
location = azurerm_resource_group.failover.location
resource_group_name = azurerm_resource_group.failover.name
}
resource "azurerm_subnet_network_security_group_association" "failover" {
subnet_id = azurerm_subnet.failover.id
network_security_group_id = azurerm_network_security_group.failover.id
}
resource "azurerm_route_table" "failover" {
name = local.failover_name
location = azurerm_resource_group.failover.location
resource_group_name = azurerm_resource_group.failover.name
}
resource "azurerm_subnet_route_table_association" "failover" {
subnet_id = azurerm_subnet.failover.id
route_table_id = azurerm_route_table.failover.id
}
resource "azurerm_mssql_managed_instance" "failover" {
name = local.failover_name
resource_group_name = azurerm_resource_group.failover.name
location = azurerm_resource_group.failover.location
administrator_login = "mradministrator"
administrator_login_password = "thisIsDog11"
license_type = "BasePrice"
subnet_id = azurerm_subnet.example.id
subnet_id = azurerm_subnet.failover.id
sku_name = "GP_Gen5"
vcores = 4
storage_size_in_gb = 32
dns_zone_partner_id = azurerm_mssql_managed_instance.primary.id
depends_on = [
azurerm_subnet_network_security_group_association.example,
azurerm_subnet_route_table_association.example,
azurerm_subnet_network_security_group_association.failover,
azurerm_subnet_route_table_association.failover,
]
tags = {
environment = "prod"
}
}
resource "azurerm_mssql_managed_instance_failover_group" "example" {
name = "example-failover-group"
location = azurerm_mssql_managed_instance.primary.location
managed_instance_id = azurerm_mssql_managed_instance.primary.id
partner_managed_instance_id = azurerm_mssql_managed_instance.secondary.id
read_write_endpoint_failover_policy {
mode = "Automatic"
grace_minutes = 60
}
resource "azurerm_virtual_network_peering" "failover_to_primary" {
name = "failover-to-primary"
remote_virtual_network_id = azurerm_virtual_network.primary.id
resource_group_name = azurerm_resource_group.failover.name
virtual_network_name = azurerm_virtual_network.failover.name
}
```

-> **Note:** There are many prerequisites that must be in place before creating the failover group. To see them all, refer to [Configure a failover group for Azure SQL Managed Instance](https://learn.microsoft.com/en-us/azure/azure-sql/managed-instance/failover-group-configure-sql-mi).

## Arguments Reference

The following arguments are supported:
Expand All @@ -129,6 +240,8 @@ The following arguments are supported:

* `readonly_endpoint_failover_policy_enabled` - (Optional) Failover policy for the read-only endpoint. Defaults to `true`.

* `secondary_type` - (Optional) The type of the secondary Managed Instance. Possible values are `Geo`, `Standby`. Defaults to `Geo`.

---

A `read_write_endpoint_failover_policy` block supports the following:
Expand Down

0 comments on commit 92bb86b

Please sign in to comment.