We recommend using Azure Native.
azure.mysql.FlexibleServer
Explore with Pulumi AI
Manages a MySQL Flexible Server.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vn",
    location: example.location,
    resourceGroupName: example.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "example-sn",
    resourceGroupName: example.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
    serviceEndpoints: ["Microsoft.Storage"],
    delegations: [{
        name: "fs",
        serviceDelegation: {
            name: "Microsoft.DBforMySQL/flexibleServers",
            actions: ["Microsoft.Network/virtualNetworks/subnets/join/action"],
        },
    }],
});
const exampleZone = new azure.privatedns.Zone("example", {
    name: "example.mysql.database.azure.com",
    resourceGroupName: example.name,
});
const exampleZoneVirtualNetworkLink = new azure.privatedns.ZoneVirtualNetworkLink("example", {
    name: "exampleVnetZone.com",
    privateDnsZoneName: exampleZone.name,
    virtualNetworkId: exampleVirtualNetwork.id,
    resourceGroupName: example.name,
});
const exampleFlexibleServer = new azure.mysql.FlexibleServer("example", {
    name: "example-fs",
    resourceGroupName: example.name,
    location: example.location,
    administratorLogin: "psqladmin",
    administratorPassword: "H@Sh1CoR3!",
    backupRetentionDays: 7,
    delegatedSubnetId: exampleSubnet.id,
    privateDnsZoneId: exampleZone.id,
    skuName: "GP_Standard_D2ds_v4",
}, {
    dependsOn: [exampleZoneVirtualNetworkLink],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vn",
    location=example.location,
    resource_group_name=example.name,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("example",
    name="example-sn",
    resource_group_name=example.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"],
    service_endpoints=["Microsoft.Storage"],
    delegations=[{
        "name": "fs",
        "service_delegation": {
            "name": "Microsoft.DBforMySQL/flexibleServers",
            "actions": ["Microsoft.Network/virtualNetworks/subnets/join/action"],
        },
    }])
example_zone = azure.privatedns.Zone("example",
    name="example.mysql.database.azure.com",
    resource_group_name=example.name)
example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("example",
    name="exampleVnetZone.com",
    private_dns_zone_name=example_zone.name,
    virtual_network_id=example_virtual_network.id,
    resource_group_name=example.name)
example_flexible_server = azure.mysql.FlexibleServer("example",
    name="example-fs",
    resource_group_name=example.name,
    location=example.location,
    administrator_login="psqladmin",
    administrator_password="H@Sh1CoR3!",
    backup_retention_days=7,
    delegated_subnet_id=example_subnet.id,
    private_dns_zone_id=example_zone.id,
    sku_name="GP_Standard_D2ds_v4",
    opts = pulumi.ResourceOptions(depends_on=[example_zone_virtual_network_link]))
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/mysql"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/privatedns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name:              pulumi.String("example-vn"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("example-sn"),
			ResourceGroupName:  example.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.2.0/24"),
			},
			ServiceEndpoints: pulumi.StringArray{
				pulumi.String("Microsoft.Storage"),
			},
			Delegations: network.SubnetDelegationArray{
				&network.SubnetDelegationArgs{
					Name: pulumi.String("fs"),
					ServiceDelegation: &network.SubnetDelegationServiceDelegationArgs{
						Name: pulumi.String("Microsoft.DBforMySQL/flexibleServers"),
						Actions: pulumi.StringArray{
							pulumi.String("Microsoft.Network/virtualNetworks/subnets/join/action"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleZone, err := privatedns.NewZone(ctx, "example", &privatedns.ZoneArgs{
			Name:              pulumi.String("example.mysql.database.azure.com"),
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		exampleZoneVirtualNetworkLink, err := privatedns.NewZoneVirtualNetworkLink(ctx, "example", &privatedns.ZoneVirtualNetworkLinkArgs{
			Name:               pulumi.String("exampleVnetZone.com"),
			PrivateDnsZoneName: exampleZone.Name,
			VirtualNetworkId:   exampleVirtualNetwork.ID(),
			ResourceGroupName:  example.Name,
		})
		if err != nil {
			return err
		}
		_, err = mysql.NewFlexibleServer(ctx, "example", &mysql.FlexibleServerArgs{
			Name:                  pulumi.String("example-fs"),
			ResourceGroupName:     example.Name,
			Location:              example.Location,
			AdministratorLogin:    pulumi.String("psqladmin"),
			AdministratorPassword: pulumi.String("H@Sh1CoR3!"),
			BackupRetentionDays:   pulumi.Int(7),
			DelegatedSubnetId:     exampleSubnet.ID(),
			PrivateDnsZoneId:      exampleZone.ID(),
			SkuName:               pulumi.String("GP_Standard_D2ds_v4"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleZoneVirtualNetworkLink,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vn",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
    });
    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "example-sn",
        ResourceGroupName = example.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.2.0/24",
        },
        ServiceEndpoints = new[]
        {
            "Microsoft.Storage",
        },
        Delegations = new[]
        {
            new Azure.Network.Inputs.SubnetDelegationArgs
            {
                Name = "fs",
                ServiceDelegation = new Azure.Network.Inputs.SubnetDelegationServiceDelegationArgs
                {
                    Name = "Microsoft.DBforMySQL/flexibleServers",
                    Actions = new[]
                    {
                        "Microsoft.Network/virtualNetworks/subnets/join/action",
                    },
                },
            },
        },
    });
    var exampleZone = new Azure.PrivateDns.Zone("example", new()
    {
        Name = "example.mysql.database.azure.com",
        ResourceGroupName = example.Name,
    });
    var exampleZoneVirtualNetworkLink = new Azure.PrivateDns.ZoneVirtualNetworkLink("example", new()
    {
        Name = "exampleVnetZone.com",
        PrivateDnsZoneName = exampleZone.Name,
        VirtualNetworkId = exampleVirtualNetwork.Id,
        ResourceGroupName = example.Name,
    });
    var exampleFlexibleServer = new Azure.MySql.FlexibleServer("example", new()
    {
        Name = "example-fs",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AdministratorLogin = "psqladmin",
        AdministratorPassword = "H@Sh1CoR3!",
        BackupRetentionDays = 7,
        DelegatedSubnetId = exampleSubnet.Id,
        PrivateDnsZoneId = exampleZone.Id,
        SkuName = "GP_Standard_D2ds_v4",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleZoneVirtualNetworkLink,
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.inputs.SubnetDelegationArgs;
import com.pulumi.azure.network.inputs.SubnetDelegationServiceDelegationArgs;
import com.pulumi.azure.privatedns.Zone;
import com.pulumi.azure.privatedns.ZoneArgs;
import com.pulumi.azure.privatedns.ZoneVirtualNetworkLink;
import com.pulumi.azure.privatedns.ZoneVirtualNetworkLinkArgs;
import com.pulumi.azure.mysql.FlexibleServer;
import com.pulumi.azure.mysql.FlexibleServerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-vn")
            .location(example.location())
            .resourceGroupName(example.name())
            .addressSpaces("10.0.0.0/16")
            .build());
        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("example-sn")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .serviceEndpoints("Microsoft.Storage")
            .delegations(SubnetDelegationArgs.builder()
                .name("fs")
                .serviceDelegation(SubnetDelegationServiceDelegationArgs.builder()
                    .name("Microsoft.DBforMySQL/flexibleServers")
                    .actions("Microsoft.Network/virtualNetworks/subnets/join/action")
                    .build())
                .build())
            .build());
        var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
            .name("example.mysql.database.azure.com")
            .resourceGroupName(example.name())
            .build());
        var exampleZoneVirtualNetworkLink = new ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", ZoneVirtualNetworkLinkArgs.builder()
            .name("exampleVnetZone.com")
            .privateDnsZoneName(exampleZone.name())
            .virtualNetworkId(exampleVirtualNetwork.id())
            .resourceGroupName(example.name())
            .build());
        var exampleFlexibleServer = new FlexibleServer("exampleFlexibleServer", FlexibleServerArgs.builder()
            .name("example-fs")
            .resourceGroupName(example.name())
            .location(example.location())
            .administratorLogin("psqladmin")
            .administratorPassword("H@Sh1CoR3!")
            .backupRetentionDays(7)
            .delegatedSubnetId(exampleSubnet.id())
            .privateDnsZoneId(exampleZone.id())
            .skuName("GP_Standard_D2ds_v4")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleZoneVirtualNetworkLink)
                .build());
    }
}
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vn
      location: ${example.location}
      resourceGroupName: ${example.name}
      addressSpaces:
        - 10.0.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: example-sn
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
      serviceEndpoints:
        - Microsoft.Storage
      delegations:
        - name: fs
          serviceDelegation:
            name: Microsoft.DBforMySQL/flexibleServers
            actions:
              - Microsoft.Network/virtualNetworks/subnets/join/action
  exampleZone:
    type: azure:privatedns:Zone
    name: example
    properties:
      name: example.mysql.database.azure.com
      resourceGroupName: ${example.name}
  exampleZoneVirtualNetworkLink:
    type: azure:privatedns:ZoneVirtualNetworkLink
    name: example
    properties:
      name: exampleVnetZone.com
      privateDnsZoneName: ${exampleZone.name}
      virtualNetworkId: ${exampleVirtualNetwork.id}
      resourceGroupName: ${example.name}
  exampleFlexibleServer:
    type: azure:mysql:FlexibleServer
    name: example
    properties:
      name: example-fs
      resourceGroupName: ${example.name}
      location: ${example.location}
      administratorLogin: psqladmin
      administratorPassword: H@Sh1CoR3!
      backupRetentionDays: 7
      delegatedSubnetId: ${exampleSubnet.id}
      privateDnsZoneId: ${exampleZone.id}
      skuName: GP_Standard_D2ds_v4
    options:
      dependsOn:
        - ${exampleZoneVirtualNetworkLink}
Create FlexibleServer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FlexibleServer(name: string, args: FlexibleServerArgs, opts?: CustomResourceOptions);@overload
def FlexibleServer(resource_name: str,
                   args: FlexibleServerArgs,
                   opts: Optional[ResourceOptions] = None)
@overload
def FlexibleServer(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   location: Optional[str] = None,
                   backup_retention_days: Optional[int] = None,
                   name: Optional[str] = None,
                   create_mode: Optional[str] = None,
                   customer_managed_key: Optional[FlexibleServerCustomerManagedKeyArgs] = None,
                   delegated_subnet_id: Optional[str] = None,
                   geo_redundant_backup_enabled: Optional[bool] = None,
                   high_availability: Optional[FlexibleServerHighAvailabilityArgs] = None,
                   point_in_time_restore_time_in_utc: Optional[str] = None,
                   administrator_login: Optional[str] = None,
                   zone: Optional[str] = None,
                   administrator_password_wo_version: Optional[int] = None,
                   identity: Optional[FlexibleServerIdentityArgs] = None,
                   private_dns_zone_id: Optional[str] = None,
                   replication_role: Optional[str] = None,
                   administrator_password: Optional[str] = None,
                   sku_name: Optional[str] = None,
                   source_server_id: Optional[str] = None,
                   storage: Optional[FlexibleServerStorageArgs] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   version: Optional[str] = None,
                   maintenance_window: Optional[FlexibleServerMaintenanceWindowArgs] = None)func NewFlexibleServer(ctx *Context, name string, args FlexibleServerArgs, opts ...ResourceOption) (*FlexibleServer, error)public FlexibleServer(string name, FlexibleServerArgs args, CustomResourceOptions? opts = null)
public FlexibleServer(String name, FlexibleServerArgs args)
public FlexibleServer(String name, FlexibleServerArgs args, CustomResourceOptions options)
type: azure:mysql:FlexibleServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FlexibleServerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var flexibleServerResource = new Azure.MySql.FlexibleServer("flexibleServerResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    BackupRetentionDays = 0,
    Name = "string",
    CreateMode = "string",
    CustomerManagedKey = new Azure.MySql.Inputs.FlexibleServerCustomerManagedKeyArgs
    {
        GeoBackupKeyVaultKeyId = "string",
        GeoBackupUserAssignedIdentityId = "string",
        KeyVaultKeyId = "string",
        PrimaryUserAssignedIdentityId = "string",
    },
    DelegatedSubnetId = "string",
    GeoRedundantBackupEnabled = false,
    HighAvailability = new Azure.MySql.Inputs.FlexibleServerHighAvailabilityArgs
    {
        Mode = "string",
        StandbyAvailabilityZone = "string",
    },
    PointInTimeRestoreTimeInUtc = "string",
    AdministratorLogin = "string",
    Zone = "string",
    AdministratorPasswordWoVersion = 0,
    Identity = new Azure.MySql.Inputs.FlexibleServerIdentityArgs
    {
        IdentityIds = new[]
        {
            "string",
        },
        Type = "string",
    },
    PrivateDnsZoneId = "string",
    ReplicationRole = "string",
    AdministratorPassword = "string",
    SkuName = "string",
    SourceServerId = "string",
    Storage = new Azure.MySql.Inputs.FlexibleServerStorageArgs
    {
        AutoGrowEnabled = false,
        IoScalingEnabled = false,
        Iops = 0,
        SizeGb = 0,
    },
    Tags = 
    {
        { "string", "string" },
    },
    Version = "string",
    MaintenanceWindow = new Azure.MySql.Inputs.FlexibleServerMaintenanceWindowArgs
    {
        DayOfWeek = 0,
        StartHour = 0,
        StartMinute = 0,
    },
});
example, err := mysql.NewFlexibleServer(ctx, "flexibleServerResource", &mysql.FlexibleServerArgs{
	ResourceGroupName:   pulumi.String("string"),
	Location:            pulumi.String("string"),
	BackupRetentionDays: pulumi.Int(0),
	Name:                pulumi.String("string"),
	CreateMode:          pulumi.String("string"),
	CustomerManagedKey: &mysql.FlexibleServerCustomerManagedKeyArgs{
		GeoBackupKeyVaultKeyId:          pulumi.String("string"),
		GeoBackupUserAssignedIdentityId: pulumi.String("string"),
		KeyVaultKeyId:                   pulumi.String("string"),
		PrimaryUserAssignedIdentityId:   pulumi.String("string"),
	},
	DelegatedSubnetId:         pulumi.String("string"),
	GeoRedundantBackupEnabled: pulumi.Bool(false),
	HighAvailability: &mysql.FlexibleServerHighAvailabilityArgs{
		Mode:                    pulumi.String("string"),
		StandbyAvailabilityZone: pulumi.String("string"),
	},
	PointInTimeRestoreTimeInUtc:    pulumi.String("string"),
	AdministratorLogin:             pulumi.String("string"),
	Zone:                           pulumi.String("string"),
	AdministratorPasswordWoVersion: pulumi.Int(0),
	Identity: &mysql.FlexibleServerIdentityArgs{
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Type: pulumi.String("string"),
	},
	PrivateDnsZoneId:      pulumi.String("string"),
	ReplicationRole:       pulumi.String("string"),
	AdministratorPassword: pulumi.String("string"),
	SkuName:               pulumi.String("string"),
	SourceServerId:        pulumi.String("string"),
	Storage: &mysql.FlexibleServerStorageArgs{
		AutoGrowEnabled:  pulumi.Bool(false),
		IoScalingEnabled: pulumi.Bool(false),
		Iops:             pulumi.Int(0),
		SizeGb:           pulumi.Int(0),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Version: pulumi.String("string"),
	MaintenanceWindow: &mysql.FlexibleServerMaintenanceWindowArgs{
		DayOfWeek:   pulumi.Int(0),
		StartHour:   pulumi.Int(0),
		StartMinute: pulumi.Int(0),
	},
})
var flexibleServerResource = new FlexibleServer("flexibleServerResource", FlexibleServerArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .backupRetentionDays(0)
    .name("string")
    .createMode("string")
    .customerManagedKey(FlexibleServerCustomerManagedKeyArgs.builder()
        .geoBackupKeyVaultKeyId("string")
        .geoBackupUserAssignedIdentityId("string")
        .keyVaultKeyId("string")
        .primaryUserAssignedIdentityId("string")
        .build())
    .delegatedSubnetId("string")
    .geoRedundantBackupEnabled(false)
    .highAvailability(FlexibleServerHighAvailabilityArgs.builder()
        .mode("string")
        .standbyAvailabilityZone("string")
        .build())
    .pointInTimeRestoreTimeInUtc("string")
    .administratorLogin("string")
    .zone("string")
    .administratorPasswordWoVersion(0)
    .identity(FlexibleServerIdentityArgs.builder()
        .identityIds("string")
        .type("string")
        .build())
    .privateDnsZoneId("string")
    .replicationRole("string")
    .administratorPassword("string")
    .skuName("string")
    .sourceServerId("string")
    .storage(FlexibleServerStorageArgs.builder()
        .autoGrowEnabled(false)
        .ioScalingEnabled(false)
        .iops(0)
        .sizeGb(0)
        .build())
    .tags(Map.of("string", "string"))
    .version("string")
    .maintenanceWindow(FlexibleServerMaintenanceWindowArgs.builder()
        .dayOfWeek(0)
        .startHour(0)
        .startMinute(0)
        .build())
    .build());
flexible_server_resource = azure.mysql.FlexibleServer("flexibleServerResource",
    resource_group_name="string",
    location="string",
    backup_retention_days=0,
    name="string",
    create_mode="string",
    customer_managed_key={
        "geo_backup_key_vault_key_id": "string",
        "geo_backup_user_assigned_identity_id": "string",
        "key_vault_key_id": "string",
        "primary_user_assigned_identity_id": "string",
    },
    delegated_subnet_id="string",
    geo_redundant_backup_enabled=False,
    high_availability={
        "mode": "string",
        "standby_availability_zone": "string",
    },
    point_in_time_restore_time_in_utc="string",
    administrator_login="string",
    zone="string",
    administrator_password_wo_version=0,
    identity={
        "identity_ids": ["string"],
        "type": "string",
    },
    private_dns_zone_id="string",
    replication_role="string",
    administrator_password="string",
    sku_name="string",
    source_server_id="string",
    storage={
        "auto_grow_enabled": False,
        "io_scaling_enabled": False,
        "iops": 0,
        "size_gb": 0,
    },
    tags={
        "string": "string",
    },
    version="string",
    maintenance_window={
        "day_of_week": 0,
        "start_hour": 0,
        "start_minute": 0,
    })
const flexibleServerResource = new azure.mysql.FlexibleServer("flexibleServerResource", {
    resourceGroupName: "string",
    location: "string",
    backupRetentionDays: 0,
    name: "string",
    createMode: "string",
    customerManagedKey: {
        geoBackupKeyVaultKeyId: "string",
        geoBackupUserAssignedIdentityId: "string",
        keyVaultKeyId: "string",
        primaryUserAssignedIdentityId: "string",
    },
    delegatedSubnetId: "string",
    geoRedundantBackupEnabled: false,
    highAvailability: {
        mode: "string",
        standbyAvailabilityZone: "string",
    },
    pointInTimeRestoreTimeInUtc: "string",
    administratorLogin: "string",
    zone: "string",
    administratorPasswordWoVersion: 0,
    identity: {
        identityIds: ["string"],
        type: "string",
    },
    privateDnsZoneId: "string",
    replicationRole: "string",
    administratorPassword: "string",
    skuName: "string",
    sourceServerId: "string",
    storage: {
        autoGrowEnabled: false,
        ioScalingEnabled: false,
        iops: 0,
        sizeGb: 0,
    },
    tags: {
        string: "string",
    },
    version: "string",
    maintenanceWindow: {
        dayOfWeek: 0,
        startHour: 0,
        startMinute: 0,
    },
});
type: azure:mysql:FlexibleServer
properties:
    administratorLogin: string
    administratorPassword: string
    administratorPasswordWoVersion: 0
    backupRetentionDays: 0
    createMode: string
    customerManagedKey:
        geoBackupKeyVaultKeyId: string
        geoBackupUserAssignedIdentityId: string
        keyVaultKeyId: string
        primaryUserAssignedIdentityId: string
    delegatedSubnetId: string
    geoRedundantBackupEnabled: false
    highAvailability:
        mode: string
        standbyAvailabilityZone: string
    identity:
        identityIds:
            - string
        type: string
    location: string
    maintenanceWindow:
        dayOfWeek: 0
        startHour: 0
        startMinute: 0
    name: string
    pointInTimeRestoreTimeInUtc: string
    privateDnsZoneId: string
    replicationRole: string
    resourceGroupName: string
    skuName: string
    sourceServerId: string
    storage:
        autoGrowEnabled: false
        ioScalingEnabled: false
        iops: 0
        sizeGb: 0
    tags:
        string: string
    version: string
    zone: string
FlexibleServer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FlexibleServer resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- AdministratorLogin string
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- AdministratorPassword string
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- AdministratorPassword intWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- BackupRetention intDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- CreateMode string
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- CustomerManaged FlexibleKey Server Customer Managed Key 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- DelegatedSubnet stringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- GeoRedundant boolBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- HighAvailability FlexibleServer High Availability 
- A high_availabilityblock as defined below.
- Identity
FlexibleServer Identity 
- An identityblock as defined below.
- Location string
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- MaintenanceWindow FlexibleServer Maintenance Window 
- A maintenance_windowblock as defined below.
- Name string
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- PointIn stringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- PrivateDns stringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- ReplicationRole string
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- SkuName string
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- SourceServer stringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- Storage
FlexibleServer Storage 
- A storageblock as defined below.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- Version string
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- Zone string
- ResourceGroup stringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- AdministratorLogin string
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- AdministratorPassword string
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- AdministratorPassword intWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- BackupRetention intDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- CreateMode string
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- CustomerManaged FlexibleKey Server Customer Managed Key Args 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- DelegatedSubnet stringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- GeoRedundant boolBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- HighAvailability FlexibleServer High Availability Args 
- A high_availabilityblock as defined below.
- Identity
FlexibleServer Identity Args 
- An identityblock as defined below.
- Location string
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- MaintenanceWindow FlexibleServer Maintenance Window Args 
- A maintenance_windowblock as defined below.
- Name string
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- PointIn stringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- PrivateDns stringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- ReplicationRole string
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- SkuName string
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- SourceServer stringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- Storage
FlexibleServer Storage Args 
- A storageblock as defined below.
- map[string]string
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- Version string
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- Zone string
- resourceGroup StringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- administratorLogin String
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administratorPassword String
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administratorPassword IntegerWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backupRetention IntegerDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- createMode String
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customerManaged FlexibleKey Server Customer Managed Key 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegatedSubnet StringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- geoRedundant BooleanBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- highAvailability FlexibleServer High Availability 
- A high_availabilityblock as defined below.
- identity
FlexibleServer Identity 
- An identityblock as defined below.
- location String
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenanceWindow FlexibleServer Maintenance Window 
- A maintenance_windowblock as defined below.
- name String
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- pointIn StringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- privateDns StringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- replicationRole String
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- skuName String
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- sourceServer StringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage
FlexibleServer Storage 
- A storageblock as defined below.
- Map<String,String>
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version String
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone String
- resourceGroup stringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- administratorLogin string
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administratorPassword string
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administratorPassword numberWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backupRetention numberDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- createMode string
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customerManaged FlexibleKey Server Customer Managed Key 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegatedSubnet stringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- geoRedundant booleanBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- highAvailability FlexibleServer High Availability 
- A high_availabilityblock as defined below.
- identity
FlexibleServer Identity 
- An identityblock as defined below.
- location string
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenanceWindow FlexibleServer Maintenance Window 
- A maintenance_windowblock as defined below.
- name string
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- pointIn stringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- privateDns stringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- replicationRole string
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- skuName string
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- sourceServer stringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage
FlexibleServer Storage 
- A storageblock as defined below.
- {[key: string]: string}
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version string
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone string
- resource_group_ strname 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- administrator_login str
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administrator_password str
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administrator_password_ intwo_ version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backup_retention_ intdays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- create_mode str
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customer_managed_ Flexiblekey Server Customer Managed Key Args 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegated_subnet_ strid 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- geo_redundant_ boolbackup_ enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- high_availability FlexibleServer High Availability Args 
- A high_availabilityblock as defined below.
- identity
FlexibleServer Identity Args 
- An identityblock as defined below.
- location str
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenance_window FlexibleServer Maintenance Window Args 
- A maintenance_windowblock as defined below.
- name str
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- point_in_ strtime_ restore_ time_ in_ utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- private_dns_ strzone_ id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- replication_role str
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- sku_name str
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- source_server_ strid 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage
FlexibleServer Storage Args 
- A storageblock as defined below.
- Mapping[str, str]
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version str
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone str
- resourceGroup StringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- administratorLogin String
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administratorPassword String
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administratorPassword NumberWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backupRetention NumberDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- createMode String
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customerManaged Property MapKey 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegatedSubnet StringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- geoRedundant BooleanBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- highAvailability Property Map
- A high_availabilityblock as defined below.
- identity Property Map
- An identityblock as defined below.
- location String
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenanceWindow Property Map
- A maintenance_windowblock as defined below.
- name String
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- pointIn StringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- privateDns StringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- replicationRole String
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- skuName String
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- sourceServer StringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage Property Map
- A storageblock as defined below.
- Map<String>
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version String
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone String
Outputs
All input properties are implicitly available as output properties. Additionally, the FlexibleServer resource produces the following output properties:
- Fqdn string
- The fully qualified domain name of the MySQL Flexible Server.
- Id string
- The provider-assigned unique ID for this managed resource.
- PublicNetwork boolAccess Enabled 
- Is the public network access enabled?
- ReplicaCapacity int
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- Fqdn string
- The fully qualified domain name of the MySQL Flexible Server.
- Id string
- The provider-assigned unique ID for this managed resource.
- PublicNetwork boolAccess Enabled 
- Is the public network access enabled?
- ReplicaCapacity int
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- fqdn String
- The fully qualified domain name of the MySQL Flexible Server.
- id String
- The provider-assigned unique ID for this managed resource.
- publicNetwork BooleanAccess Enabled 
- Is the public network access enabled?
- replicaCapacity Integer
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- fqdn string
- The fully qualified domain name of the MySQL Flexible Server.
- id string
- The provider-assigned unique ID for this managed resource.
- publicNetwork booleanAccess Enabled 
- Is the public network access enabled?
- replicaCapacity number
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- fqdn str
- The fully qualified domain name of the MySQL Flexible Server.
- id str
- The provider-assigned unique ID for this managed resource.
- public_network_ boolaccess_ enabled 
- Is the public network access enabled?
- replica_capacity int
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- fqdn String
- The fully qualified domain name of the MySQL Flexible Server.
- id String
- The provider-assigned unique ID for this managed resource.
- publicNetwork BooleanAccess Enabled 
- Is the public network access enabled?
- replicaCapacity Number
- The maximum number of replicas that a primary MySQL Flexible Server can have.
Look up Existing FlexibleServer Resource
Get an existing FlexibleServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FlexibleServerState, opts?: CustomResourceOptions): FlexibleServer@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        administrator_login: Optional[str] = None,
        administrator_password: Optional[str] = None,
        administrator_password_wo_version: Optional[int] = None,
        backup_retention_days: Optional[int] = None,
        create_mode: Optional[str] = None,
        customer_managed_key: Optional[FlexibleServerCustomerManagedKeyArgs] = None,
        delegated_subnet_id: Optional[str] = None,
        fqdn: Optional[str] = None,
        geo_redundant_backup_enabled: Optional[bool] = None,
        high_availability: Optional[FlexibleServerHighAvailabilityArgs] = None,
        identity: Optional[FlexibleServerIdentityArgs] = None,
        location: Optional[str] = None,
        maintenance_window: Optional[FlexibleServerMaintenanceWindowArgs] = None,
        name: Optional[str] = None,
        point_in_time_restore_time_in_utc: Optional[str] = None,
        private_dns_zone_id: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        replica_capacity: Optional[int] = None,
        replication_role: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        source_server_id: Optional[str] = None,
        storage: Optional[FlexibleServerStorageArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        version: Optional[str] = None,
        zone: Optional[str] = None) -> FlexibleServerfunc GetFlexibleServer(ctx *Context, name string, id IDInput, state *FlexibleServerState, opts ...ResourceOption) (*FlexibleServer, error)public static FlexibleServer Get(string name, Input<string> id, FlexibleServerState? state, CustomResourceOptions? opts = null)public static FlexibleServer get(String name, Output<String> id, FlexibleServerState state, CustomResourceOptions options)resources:  _:    type: azure:mysql:FlexibleServer    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AdministratorLogin string
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- AdministratorPassword string
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- AdministratorPassword intWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- BackupRetention intDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- CreateMode string
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- CustomerManaged FlexibleKey Server Customer Managed Key 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- DelegatedSubnet stringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- Fqdn string
- The fully qualified domain name of the MySQL Flexible Server.
- GeoRedundant boolBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- HighAvailability FlexibleServer High Availability 
- A high_availabilityblock as defined below.
- Identity
FlexibleServer Identity 
- An identityblock as defined below.
- Location string
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- MaintenanceWindow FlexibleServer Maintenance Window 
- A maintenance_windowblock as defined below.
- Name string
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- PointIn stringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- PrivateDns stringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- PublicNetwork boolAccess Enabled 
- Is the public network access enabled?
- ReplicaCapacity int
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- ReplicationRole string
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- ResourceGroup stringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- SkuName string
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- SourceServer stringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- Storage
FlexibleServer Storage 
- A storageblock as defined below.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- Version string
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- Zone string
- AdministratorLogin string
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- AdministratorPassword string
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- AdministratorPassword intWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- BackupRetention intDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- CreateMode string
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- CustomerManaged FlexibleKey Server Customer Managed Key Args 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- DelegatedSubnet stringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- Fqdn string
- The fully qualified domain name of the MySQL Flexible Server.
- GeoRedundant boolBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- HighAvailability FlexibleServer High Availability Args 
- A high_availabilityblock as defined below.
- Identity
FlexibleServer Identity Args 
- An identityblock as defined below.
- Location string
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- MaintenanceWindow FlexibleServer Maintenance Window Args 
- A maintenance_windowblock as defined below.
- Name string
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- PointIn stringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- PrivateDns stringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- PublicNetwork boolAccess Enabled 
- Is the public network access enabled?
- ReplicaCapacity int
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- ReplicationRole string
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- ResourceGroup stringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- SkuName string
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- SourceServer stringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- Storage
FlexibleServer Storage Args 
- A storageblock as defined below.
- map[string]string
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- Version string
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- Zone string
- administratorLogin String
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administratorPassword String
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administratorPassword IntegerWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backupRetention IntegerDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- createMode String
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customerManaged FlexibleKey Server Customer Managed Key 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegatedSubnet StringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- fqdn String
- The fully qualified domain name of the MySQL Flexible Server.
- geoRedundant BooleanBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- highAvailability FlexibleServer High Availability 
- A high_availabilityblock as defined below.
- identity
FlexibleServer Identity 
- An identityblock as defined below.
- location String
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenanceWindow FlexibleServer Maintenance Window 
- A maintenance_windowblock as defined below.
- name String
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- pointIn StringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- privateDns StringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- publicNetwork BooleanAccess Enabled 
- Is the public network access enabled?
- replicaCapacity Integer
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- replicationRole String
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- resourceGroup StringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- skuName String
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- sourceServer StringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage
FlexibleServer Storage 
- A storageblock as defined below.
- Map<String,String>
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version String
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone String
- administratorLogin string
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administratorPassword string
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administratorPassword numberWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backupRetention numberDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- createMode string
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customerManaged FlexibleKey Server Customer Managed Key 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegatedSubnet stringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- fqdn string
- The fully qualified domain name of the MySQL Flexible Server.
- geoRedundant booleanBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- highAvailability FlexibleServer High Availability 
- A high_availabilityblock as defined below.
- identity
FlexibleServer Identity 
- An identityblock as defined below.
- location string
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenanceWindow FlexibleServer Maintenance Window 
- A maintenance_windowblock as defined below.
- name string
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- pointIn stringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- privateDns stringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- publicNetwork booleanAccess Enabled 
- Is the public network access enabled?
- replicaCapacity number
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- replicationRole string
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- resourceGroup stringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- skuName string
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- sourceServer stringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage
FlexibleServer Storage 
- A storageblock as defined below.
- {[key: string]: string}
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version string
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone string
- administrator_login str
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administrator_password str
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administrator_password_ intwo_ version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backup_retention_ intdays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- create_mode str
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customer_managed_ Flexiblekey Server Customer Managed Key Args 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegated_subnet_ strid 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- fqdn str
- The fully qualified domain name of the MySQL Flexible Server.
- geo_redundant_ boolbackup_ enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- high_availability FlexibleServer High Availability Args 
- A high_availabilityblock as defined below.
- identity
FlexibleServer Identity Args 
- An identityblock as defined below.
- location str
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenance_window FlexibleServer Maintenance Window Args 
- A maintenance_windowblock as defined below.
- name str
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- point_in_ strtime_ restore_ time_ in_ utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- private_dns_ strzone_ id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- public_network_ boolaccess_ enabled 
- Is the public network access enabled?
- replica_capacity int
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- replication_role str
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- resource_group_ strname 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- sku_name str
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- source_server_ strid 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage
FlexibleServer Storage Args 
- A storageblock as defined below.
- Mapping[str, str]
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version str
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone str
- administratorLogin String
- The Administrator login for the MySQL Flexible Server. Required when create_modeisDefault. Changing this forces a new MySQL Flexible Server to be created.
- administratorPassword String
- The Password associated with the administrator_loginfor the MySQL Flexible Server.
- administratorPassword NumberWo Version 
- An integer value used to trigger an update for - administrator_password_wo. This property should be incremented when updating- administrator_password_wo.- Note: Either - administrator_passwordor- administrator_password_wois required when- create_modeis- Default.
- backupRetention NumberDays 
- The backup retention days for the MySQL Flexible Server. Possible values are between 1and35days. Defaults to7.
- createMode String
- The creation mode which can be used to restore or replicate existing servers. Possible values are - Default,- PointInTimeRestore,- GeoRestore, and- Replica. Changing this forces a new MySQL Flexible Server to be created.- NOTE: Creating a - GeoRestoreserver requires the source server with- geo_redundant_backup_enabledenabled.- NOTE: When a server is first created it may not be immediately available for - geo restoreor- replica. It may take a few minutes to several hours for the necessary metadata to be populated. Please see the Geo Restore and the Replica for more information.
- customerManaged Property MapKey 
- A - customer_managed_keyblock as defined below.- NOTE: - identityis required when- customer_managed_keyis specified.
- delegatedSubnet StringId 
- The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- fqdn String
- The fully qualified domain name of the MySQL Flexible Server.
- geoRedundant BooleanBackup Enabled 
- Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.
- highAvailability Property Map
- A high_availabilityblock as defined below.
- identity Property Map
- An identityblock as defined below.
- location String
- The Azure Region where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- maintenanceWindow Property Map
- A maintenance_windowblock as defined below.
- name String
- The name which should be used for this MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.
- pointIn StringTime Restore Time In Utc 
- The point in time to restore from creation_source_server_idwhencreate_modeisPointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.
- privateDns StringZone Id 
- The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created. - NOTE: The - private_dns_zone_idis required when setting a- delegated_subnet_id. The- azure.privatedns.Zoneshould end with suffix- .mysql.database.azure.com.
- publicNetwork BooleanAccess Enabled 
- Is the public network access enabled?
- replicaCapacity Number
- The maximum number of replicas that a primary MySQL Flexible Server can have.
- replicationRole String
- The replication role. Possible value is - None.- NOTE: The - replication_rolecannot be set while creating and only can be updated from- Replicato- None.
- resourceGroup StringName 
- The name of the Resource Group where the MySQL Flexible Server should exist. Changing this forces a new MySQL Flexible Server to be created.
- skuName String
- The SKU Name for the MySQL Flexible Server. - NOTE: - sku_nameshould start with SKU tier- B (Burstable),- GP (General Purpose),- MO (Memory Optimized)like- B_Standard_B1s.
- sourceServer StringId 
- The resource ID of the source MySQL Flexible Server to be restored. Required when create_modeisPointInTimeRestore,GeoRestore, andReplica. Changing this forces a new MySQL Flexible Server to be created.
- storage Property Map
- A storageblock as defined below.
- Map<String>
- A mapping of tags which should be assigned to the MySQL Flexible Server.
- version String
- The version of the MySQL Flexible Server to use. Possible values are 5.7, and8.0.21. Changing this forces a new MySQL Flexible Server to be created.
- zone String
Supporting Types
FlexibleServerCustomerManagedKey, FlexibleServerCustomerManagedKeyArgs          
- GeoBackup stringKey Vault Key Id 
- The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- GeoBackup stringUser Assigned Identity Id 
- The geo backup user managed identity id for a Customer Managed Key. Should be added with - identity_ids. It can't cross region and need identity in same region as geo backup.- NOTE: - primary_user_assigned_identity_idor- geo_backup_user_assigned_identity_idis required when- typeis set to- UserAssignedor- SystemAssigned, UserAssigned.
- KeyVault stringKey Id 
- The ID of the Key Vault Key.
- PrimaryUser stringAssigned Identity Id 
- Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.
- GeoBackup stringKey Vault Key Id 
- The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- GeoBackup stringUser Assigned Identity Id 
- The geo backup user managed identity id for a Customer Managed Key. Should be added with - identity_ids. It can't cross region and need identity in same region as geo backup.- NOTE: - primary_user_assigned_identity_idor- geo_backup_user_assigned_identity_idis required when- typeis set to- UserAssignedor- SystemAssigned, UserAssigned.
- KeyVault stringKey Id 
- The ID of the Key Vault Key.
- PrimaryUser stringAssigned Identity Id 
- Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.
- geoBackup StringKey Vault Key Id 
- The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geoBackup StringUser Assigned Identity Id 
- The geo backup user managed identity id for a Customer Managed Key. Should be added with - identity_ids. It can't cross region and need identity in same region as geo backup.- NOTE: - primary_user_assigned_identity_idor- geo_backup_user_assigned_identity_idis required when- typeis set to- UserAssignedor- SystemAssigned, UserAssigned.
- keyVault StringKey Id 
- The ID of the Key Vault Key.
- primaryUser StringAssigned Identity Id 
- Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.
- geoBackup stringKey Vault Key Id 
- The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geoBackup stringUser Assigned Identity Id 
- The geo backup user managed identity id for a Customer Managed Key. Should be added with - identity_ids. It can't cross region and need identity in same region as geo backup.- NOTE: - primary_user_assigned_identity_idor- geo_backup_user_assigned_identity_idis required when- typeis set to- UserAssignedor- SystemAssigned, UserAssigned.
- keyVault stringKey Id 
- The ID of the Key Vault Key.
- primaryUser stringAssigned Identity Id 
- Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.
- geo_backup_ strkey_ vault_ key_ id 
- The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geo_backup_ struser_ assigned_ identity_ id 
- The geo backup user managed identity id for a Customer Managed Key. Should be added with - identity_ids. It can't cross region and need identity in same region as geo backup.- NOTE: - primary_user_assigned_identity_idor- geo_backup_user_assigned_identity_idis required when- typeis set to- UserAssignedor- SystemAssigned, UserAssigned.
- key_vault_ strkey_ id 
- The ID of the Key Vault Key.
- primary_user_ strassigned_ identity_ id 
- Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.
- geoBackup StringKey Vault Key Id 
- The ID of the geo backup Key Vault Key. It can't cross region and need Customer Managed Key in same region as geo backup.
- geoBackup StringUser Assigned Identity Id 
- The geo backup user managed identity id for a Customer Managed Key. Should be added with - identity_ids. It can't cross region and need identity in same region as geo backup.- NOTE: - primary_user_assigned_identity_idor- geo_backup_user_assigned_identity_idis required when- typeis set to- UserAssignedor- SystemAssigned, UserAssigned.
- keyVault StringKey Id 
- The ID of the Key Vault Key.
- primaryUser StringAssigned Identity Id 
- Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.
FlexibleServerHighAvailability, FlexibleServerHighAvailabilityArgs        
- Mode string
- The high availability mode for the MySQL Flexible Server. Possibles values are - SameZoneand- ZoneRedundant.- NOTE: - storage[0].auto_grow_enabledmust be enabled when- high_availabilityis enabled. To change the- high_availabilityfor a MySQL Flexible Server created with- high_availabilitydisabled during creation, the resource has to be recreated.
- StandbyAvailability stringZone 
- Mode string
- The high availability mode for the MySQL Flexible Server. Possibles values are - SameZoneand- ZoneRedundant.- NOTE: - storage[0].auto_grow_enabledmust be enabled when- high_availabilityis enabled. To change the- high_availabilityfor a MySQL Flexible Server created with- high_availabilitydisabled during creation, the resource has to be recreated.
- StandbyAvailability stringZone 
- mode String
- The high availability mode for the MySQL Flexible Server. Possibles values are - SameZoneand- ZoneRedundant.- NOTE: - storage[0].auto_grow_enabledmust be enabled when- high_availabilityis enabled. To change the- high_availabilityfor a MySQL Flexible Server created with- high_availabilitydisabled during creation, the resource has to be recreated.
- standbyAvailability StringZone 
- mode string
- The high availability mode for the MySQL Flexible Server. Possibles values are - SameZoneand- ZoneRedundant.- NOTE: - storage[0].auto_grow_enabledmust be enabled when- high_availabilityis enabled. To change the- high_availabilityfor a MySQL Flexible Server created with- high_availabilitydisabled during creation, the resource has to be recreated.
- standbyAvailability stringZone 
- mode str
- The high availability mode for the MySQL Flexible Server. Possibles values are - SameZoneand- ZoneRedundant.- NOTE: - storage[0].auto_grow_enabledmust be enabled when- high_availabilityis enabled. To change the- high_availabilityfor a MySQL Flexible Server created with- high_availabilitydisabled during creation, the resource has to be recreated.
- standby_availability_ strzone 
- mode String
- The high availability mode for the MySQL Flexible Server. Possibles values are - SameZoneand- ZoneRedundant.- NOTE: - storage[0].auto_grow_enabledmust be enabled when- high_availabilityis enabled. To change the- high_availabilityfor a MySQL Flexible Server created with- high_availabilitydisabled during creation, the resource has to be recreated.
- standbyAvailability StringZone 
FlexibleServerIdentity, FlexibleServerIdentityArgs      
- IdentityIds List<string>
- A list of User Assigned Managed Identity IDs to be assigned to this MySQL Flexible Server.
- Type string
- Specifies the type of Managed Service Identity that should be configured on this MySQL Flexible Server. The only possible value is UserAssigned.
- IdentityIds []string
- A list of User Assigned Managed Identity IDs to be assigned to this MySQL Flexible Server.
- Type string
- Specifies the type of Managed Service Identity that should be configured on this MySQL Flexible Server. The only possible value is UserAssigned.
- identityIds List<String>
- A list of User Assigned Managed Identity IDs to be assigned to this MySQL Flexible Server.
- type String
- Specifies the type of Managed Service Identity that should be configured on this MySQL Flexible Server. The only possible value is UserAssigned.
- identityIds string[]
- A list of User Assigned Managed Identity IDs to be assigned to this MySQL Flexible Server.
- type string
- Specifies the type of Managed Service Identity that should be configured on this MySQL Flexible Server. The only possible value is UserAssigned.
- identity_ids Sequence[str]
- A list of User Assigned Managed Identity IDs to be assigned to this MySQL Flexible Server.
- type str
- Specifies the type of Managed Service Identity that should be configured on this MySQL Flexible Server. The only possible value is UserAssigned.
- identityIds List<String>
- A list of User Assigned Managed Identity IDs to be assigned to this MySQL Flexible Server.
- type String
- Specifies the type of Managed Service Identity that should be configured on this MySQL Flexible Server. The only possible value is UserAssigned.
FlexibleServerMaintenanceWindow, FlexibleServerMaintenanceWindowArgs        
- DayOf intWeek 
- The day of week for maintenance window. Defaults to 0.
- StartHour int
- The start hour for maintenance window. Defaults to 0.
- StartMinute int
- The start minute for maintenance window. Defaults to 0.
- DayOf intWeek 
- The day of week for maintenance window. Defaults to 0.
- StartHour int
- The start hour for maintenance window. Defaults to 0.
- StartMinute int
- The start minute for maintenance window. Defaults to 0.
- dayOf IntegerWeek 
- The day of week for maintenance window. Defaults to 0.
- startHour Integer
- The start hour for maintenance window. Defaults to 0.
- startMinute Integer
- The start minute for maintenance window. Defaults to 0.
- dayOf numberWeek 
- The day of week for maintenance window. Defaults to 0.
- startHour number
- The start hour for maintenance window. Defaults to 0.
- startMinute number
- The start minute for maintenance window. Defaults to 0.
- day_of_ intweek 
- The day of week for maintenance window. Defaults to 0.
- start_hour int
- The start hour for maintenance window. Defaults to 0.
- start_minute int
- The start minute for maintenance window. Defaults to 0.
- dayOf NumberWeek 
- The day of week for maintenance window. Defaults to 0.
- startHour Number
- The start hour for maintenance window. Defaults to 0.
- startMinute Number
- The start minute for maintenance window. Defaults to 0.
FlexibleServerStorage, FlexibleServerStorageArgs      
- AutoGrow boolEnabled 
- Should Storage Auto Grow be enabled? Defaults to true.
- IoScaling boolEnabled 
- Should IOPS be scaled automatically? If true,iopscan not be set. Defaults tofalse.
- Iops int
- The storage IOPS for the MySQL Flexible Server. Possible values are between 360and20000.
- SizeGb int
- The max storage allowed for the MySQL Flexible Server. Possible values are between - 20and- 16384.- Note: Decreasing - size_gbforces a new resource to be created.
- AutoGrow boolEnabled 
- Should Storage Auto Grow be enabled? Defaults to true.
- IoScaling boolEnabled 
- Should IOPS be scaled automatically? If true,iopscan not be set. Defaults tofalse.
- Iops int
- The storage IOPS for the MySQL Flexible Server. Possible values are between 360and20000.
- SizeGb int
- The max storage allowed for the MySQL Flexible Server. Possible values are between - 20and- 16384.- Note: Decreasing - size_gbforces a new resource to be created.
- autoGrow BooleanEnabled 
- Should Storage Auto Grow be enabled? Defaults to true.
- ioScaling BooleanEnabled 
- Should IOPS be scaled automatically? If true,iopscan not be set. Defaults tofalse.
- iops Integer
- The storage IOPS for the MySQL Flexible Server. Possible values are between 360and20000.
- sizeGb Integer
- The max storage allowed for the MySQL Flexible Server. Possible values are between - 20and- 16384.- Note: Decreasing - size_gbforces a new resource to be created.
- autoGrow booleanEnabled 
- Should Storage Auto Grow be enabled? Defaults to true.
- ioScaling booleanEnabled 
- Should IOPS be scaled automatically? If true,iopscan not be set. Defaults tofalse.
- iops number
- The storage IOPS for the MySQL Flexible Server. Possible values are between 360and20000.
- sizeGb number
- The max storage allowed for the MySQL Flexible Server. Possible values are between - 20and- 16384.- Note: Decreasing - size_gbforces a new resource to be created.
- auto_grow_ boolenabled 
- Should Storage Auto Grow be enabled? Defaults to true.
- io_scaling_ boolenabled 
- Should IOPS be scaled automatically? If true,iopscan not be set. Defaults tofalse.
- iops int
- The storage IOPS for the MySQL Flexible Server. Possible values are between 360and20000.
- size_gb int
- The max storage allowed for the MySQL Flexible Server. Possible values are between - 20and- 16384.- Note: Decreasing - size_gbforces a new resource to be created.
- autoGrow BooleanEnabled 
- Should Storage Auto Grow be enabled? Defaults to true.
- ioScaling BooleanEnabled 
- Should IOPS be scaled automatically? If true,iopscan not be set. Defaults tofalse.
- iops Number
- The storage IOPS for the MySQL Flexible Server. Possible values are between 360and20000.
- sizeGb Number
- The max storage allowed for the MySQL Flexible Server. Possible values are between - 20and- 16384.- Note: Decreasing - size_gbforces a new resource to be created.
Import
MySQL Flexible Servers can be imported using the resource id, e.g.
$ pulumi import azure:mysql/flexibleServer:FlexibleServer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DBforMySQL/flexibleServers/flexibleServer1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.