Docs Packages
  1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. mysql
  5. FlexibleServer
azure logo
Azure Classic v5.43.0, May 6 23

azure.mysql.FlexibleServer

Explore with Pulumi AI

Manages a MySQL Flexible Server.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
    });

    var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new()
    {
        ResourceGroupName = exampleResourceGroup.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("exampleZone", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleZoneVirtualNetworkLink = new Azure.PrivateDns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", new()
    {
        PrivateDnsZoneName = exampleZone.Name,
        VirtualNetworkId = exampleVirtualNetwork.Id,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleFlexibleServer = new Azure.MySql.FlexibleServer("exampleFlexibleServer", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        AdministratorLogin = "psqladmin",
        AdministratorPassword = "H@Sh1CoR3!",
        BackupRetentionDays = 7,
        DelegatedSubnetId = exampleSubnet.Id,
        PrivateDnsZoneId = exampleZone.Id,
        SkuName = "GP_Standard_D2ds_v4",
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            exampleZoneVirtualNetworkLink,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mysql"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/privatedns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
			ResourceGroupName:  exampleResourceGroup.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, "exampleZone", &privatedns.ZoneArgs{
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleZoneVirtualNetworkLink, err := privatedns.NewZoneVirtualNetworkLink(ctx, "exampleZoneVirtualNetworkLink", &privatedns.ZoneVirtualNetworkLinkArgs{
			PrivateDnsZoneName: exampleZone.Name,
			VirtualNetworkId:   exampleVirtualNetwork.ID(),
			ResourceGroupName:  exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = mysql.NewFlexibleServer(ctx, "exampleFlexibleServer", &mysql.FlexibleServerArgs{
			ResourceGroupName:     exampleResourceGroup.Name,
			Location:              exampleResourceGroup.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
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .addressSpaces("10.0.0.0/16")
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()        
            .resourceGroupName(exampleResourceGroup.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()        
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleZoneVirtualNetworkLink = new ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", ZoneVirtualNetworkLinkArgs.builder()        
            .privateDnsZoneName(exampleZone.name())
            .virtualNetworkId(exampleVirtualNetwork.id())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleFlexibleServer = new FlexibleServer("exampleFlexibleServer", FlexibleServerArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.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());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"],
    service_endpoints=["Microsoft.Storage"],
    delegations=[azure.network.SubnetDelegationArgs(
        name="fs",
        service_delegation=azure.network.SubnetDelegationServiceDelegationArgs(
            name="Microsoft.DBforMySQL/flexibleServers",
            actions=["Microsoft.Network/virtualNetworks/subnets/join/action"],
        ),
    )])
example_zone = azure.privatedns.Zone("exampleZone", resource_group_name=example_resource_group.name)
example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink",
    private_dns_zone_name=example_zone.name,
    virtual_network_id=example_virtual_network.id,
    resource_group_name=example_resource_group.name)
example_flexible_server = azure.mysql.FlexibleServer("exampleFlexibleServer",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.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]))

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.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("exampleZone", {resourceGroupName: exampleResourceGroup.name});
const exampleZoneVirtualNetworkLink = new azure.privatedns.ZoneVirtualNetworkLink("exampleZoneVirtualNetworkLink", {
    privateDnsZoneName: exampleZone.name,
    virtualNetworkId: exampleVirtualNetwork.id,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleFlexibleServer = new azure.mysql.FlexibleServer("exampleFlexibleServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    administratorLogin: "psqladmin",
    administratorPassword: "H@Sh1CoR3!",
    backupRetentionDays: 7,
    delegatedSubnetId: exampleSubnet.id,
    privateDnsZoneId: exampleZone.id,
    skuName: "GP_Standard_D2ds_v4",
}, {
    dependsOn: [exampleZoneVirtualNetworkLink],
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      addressSpaces:
        - 10.0.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.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
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
  exampleZoneVirtualNetworkLink:
    type: azure:privatedns:ZoneVirtualNetworkLink
    properties:
      privateDnsZoneName: ${exampleZone.name}
      virtualNetworkId: ${exampleVirtualNetwork.id}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleFlexibleServer:
    type: azure:mysql:FlexibleServer
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.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

new FlexibleServer(name: string, args: FlexibleServerArgs, opts?: CustomResourceOptions);
@overload
def FlexibleServer(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   administrator_login: Optional[str] = None,
                   administrator_password: Optional[str] = None,
                   backup_retention_days: Optional[int] = 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,
                   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,
                   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)
@overload
def FlexibleServer(resource_name: str,
                   args: FlexibleServerArgs,
                   opts: Optional[ResourceOptions] = 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.
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.

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

The FlexibleServer resource accepts the following input properties:

ResourceGroupName string

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_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

AdministratorPassword string

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

BackupRetentionDays int

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

CustomerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

DelegatedSubnetId string

The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

GeoRedundantBackupEnabled bool

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

HighAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

Identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

PointInTimeRestoreTimeInUtc string

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

PrivateDnsZoneId string

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

ReplicationRole string

The replication role. Possible value is None.

SkuName string

The SKU Name for the MySQL Flexible Server.

SourceServerId string

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

Storage FlexibleServerStorageArgs

A storage block as defined below.

Tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

Zone string

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

ResourceGroupName string

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_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

AdministratorPassword string

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

BackupRetentionDays int

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

CustomerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

DelegatedSubnetId string

The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

GeoRedundantBackupEnabled bool

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

HighAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

Identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

PointInTimeRestoreTimeInUtc string

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

PrivateDnsZoneId string

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

ReplicationRole string

The replication role. Possible value is None.

SkuName string

The SKU Name for the MySQL Flexible Server.

SourceServerId string

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

Storage FlexibleServerStorageArgs

A storage block as defined below.

Tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

Zone string

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

resourceGroupName String

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_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administratorPassword String

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backupRetentionDays Integer

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

delegatedSubnetId String

The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

geoRedundantBackupEnabled Boolean

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

highAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

pointInTimeRestoreTimeInUtc String

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

privateDnsZoneId String

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

replicationRole String

The replication role. Possible value is None.

skuName String

The SKU Name for the MySQL Flexible Server.

sourceServerId String

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage FlexibleServerStorageArgs

A storage block as defined below.

tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone String

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

resourceGroupName string

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_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administratorPassword string

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backupRetentionDays number

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

delegatedSubnetId string

The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

geoRedundantBackupEnabled boolean

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

highAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

pointInTimeRestoreTimeInUtc string

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

privateDnsZoneId string

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

replicationRole string

The replication role. Possible value is None.

skuName string

The SKU Name for the MySQL Flexible Server.

sourceServerId string

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage FlexibleServerStorageArgs

A storage block as defined below.

tags {[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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone string

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

resource_group_name str

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_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administrator_password str

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backup_retention_days int

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customer_managed_key FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

delegated_subnet_id str

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_backup_enabled bool

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

high_availability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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_time_restore_time_in_utc str

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

private_dns_zone_id str

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

replication_role str

The replication role. Possible value is None.

sku_name str

The SKU Name for the MySQL Flexible Server.

source_server_id str

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage FlexibleServerStorageArgs

A storage block as defined below.

tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone str

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

resourceGroupName String

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_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administratorPassword String

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backupRetentionDays Number

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customerManagedKey Property Map

A customer_managed_key block as defined below.

delegatedSubnetId String

The ID of the virtual network subnet to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

geoRedundantBackupEnabled Boolean

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

highAvailability Property Map

A high_availability block as defined below.

identity Property Map

An identity block 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_window block 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.

pointInTimeRestoreTimeInUtc String

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

privateDnsZoneId String

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

replicationRole String

The replication role. Possible value is None.

skuName String

The SKU Name for the MySQL Flexible Server.

sourceServerId String

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage Property Map

A storage block as defined below.

tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone String

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

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.

PublicNetworkAccessEnabled bool

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.

PublicNetworkAccessEnabled bool

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.

publicNetworkAccessEnabled Boolean

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.

publicNetworkAccessEnabled boolean

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_access_enabled bool

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.

publicNetworkAccessEnabled Boolean

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,
        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) -> FlexibleServer
func 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)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
AdministratorLogin string

The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

AdministratorPassword string

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

BackupRetentionDays int

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

CustomerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

DelegatedSubnetId string

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.

GeoRedundantBackupEnabled bool

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

HighAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

Identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

PointInTimeRestoreTimeInUtc string

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

PrivateDnsZoneId string

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

PublicNetworkAccessEnabled bool

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.

ResourceGroupName string

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.

SourceServerId string

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

Storage FlexibleServerStorageArgs

A storage block as defined below.

Tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

Zone string

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

AdministratorLogin string

The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

AdministratorPassword string

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

BackupRetentionDays int

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

CustomerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

DelegatedSubnetId string

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.

GeoRedundantBackupEnabled bool

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

HighAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

Identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

PointInTimeRestoreTimeInUtc string

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

PrivateDnsZoneId string

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

PublicNetworkAccessEnabled bool

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.

ResourceGroupName string

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.

SourceServerId string

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

Storage FlexibleServerStorageArgs

A storage block as defined below.

Tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

Zone string

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

administratorLogin String

The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administratorPassword String

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backupRetentionDays Integer

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

delegatedSubnetId String

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.

geoRedundantBackupEnabled Boolean

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

highAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

pointInTimeRestoreTimeInUtc String

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

privateDnsZoneId String

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

publicNetworkAccessEnabled Boolean

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.

resourceGroupName String

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.

sourceServerId String

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage FlexibleServerStorageArgs

A storage block as defined below.

tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone String

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

administratorLogin string

The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administratorPassword string

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backupRetentionDays number

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customerManagedKey FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

delegatedSubnetId string

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.

geoRedundantBackupEnabled boolean

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

highAvailability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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.

pointInTimeRestoreTimeInUtc string

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

privateDnsZoneId string

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

publicNetworkAccessEnabled boolean

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.

resourceGroupName string

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.

sourceServerId string

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage FlexibleServerStorageArgs

A storage block as defined below.

tags {[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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone string

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

administrator_login str

The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administrator_password str

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backup_retention_days int

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customer_managed_key FlexibleServerCustomerManagedKeyArgs

A customer_managed_key block as defined below.

delegated_subnet_id str

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_backup_enabled bool

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

high_availability FlexibleServerHighAvailabilityArgs

A high_availability block as defined below.

identity FlexibleServerIdentityArgs

An identity block 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 FlexibleServerMaintenanceWindowArgs

A maintenance_window block 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_time_restore_time_in_utc str

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

private_dns_zone_id str

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

public_network_access_enabled bool

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.

resource_group_name str

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.

source_server_id str

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage FlexibleServerStorageArgs

A storage block as defined below.

tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone str

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

administratorLogin String

The Administrator login for the MySQL Flexible Server. Required when create_mode is Default. Changing this forces a new MySQL Flexible Server to be created.

administratorPassword String

The Password associated with the administrator_login for the MySQL Flexible Server. Required when create_mode is Default.

backupRetentionDays Number

The backup retention days for the MySQL Flexible Server. Possible values are between 1 and 35 days. Defaults to 7.

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.

customerManagedKey Property Map

A customer_managed_key block as defined below.

delegatedSubnetId String

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.

geoRedundantBackupEnabled Boolean

Should geo redundant backup enabled? Defaults to false. Changing this forces a new MySQL Flexible Server to be created.

highAvailability Property Map

A high_availability block as defined below.

identity Property Map

An identity block 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_window block 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.

pointInTimeRestoreTimeInUtc String

The point in time to restore from creation_source_server_id when create_mode is PointInTimeRestore. Changing this forces a new MySQL Flexible Server to be created.

privateDnsZoneId String

The ID of the private DNS zone to create the MySQL Flexible Server. Changing this forces a new MySQL Flexible Server to be created.

publicNetworkAccessEnabled Boolean

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.

resourceGroupName String

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.

sourceServerId String

The resource ID of the source MySQL Flexible Server to be restored. Required when create_mode is PointInTimeRestore, GeoRestore, and Replica. Changing this forces a new MySQL Flexible Server to be created.

storage Property Map

A storage block as defined below.

tags 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, and 8.0.21. Changing this forces a new MySQL Flexible Server to be created.

zone String

Specifies the Availability Zone in which this MySQL Flexible Server should be located. Possible values are 1, 2 and 3.

Supporting Types

FlexibleServerCustomerManagedKey

GeoBackupKeyVaultKeyId string

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.

GeoBackupUserAssignedIdentityId string

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.

KeyVaultKeyId string

The ID of the Key Vault Key.

PrimaryUserAssignedIdentityId string

Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.

GeoBackupKeyVaultKeyId string

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.

GeoBackupUserAssignedIdentityId string

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.

KeyVaultKeyId string

The ID of the Key Vault Key.

PrimaryUserAssignedIdentityId string

Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.

geoBackupKeyVaultKeyId String

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.

geoBackupUserAssignedIdentityId String

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.

keyVaultKeyId String

The ID of the Key Vault Key.

primaryUserAssignedIdentityId String

Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.

geoBackupKeyVaultKeyId string

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.

geoBackupUserAssignedIdentityId string

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.

keyVaultKeyId string

The ID of the Key Vault Key.

primaryUserAssignedIdentityId string

Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.

geo_backup_key_vault_key_id str

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_user_assigned_identity_id str

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.

key_vault_key_id str

The ID of the Key Vault Key.

primary_user_assigned_identity_id str

Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.

geoBackupKeyVaultKeyId String

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.

geoBackupUserAssignedIdentityId String

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.

keyVaultKeyId String

The ID of the Key Vault Key.

primaryUserAssignedIdentityId String

Specifies the primary user managed identity id for a Customer Managed Key. Should be added with identity_ids.

FlexibleServerHighAvailability

Mode string

The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.

StandbyAvailabilityZone string

Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are 1, 2 and 3.

Mode string

The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.

StandbyAvailabilityZone string

Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are 1, 2 and 3.

mode String

The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.

standbyAvailabilityZone String

Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are 1, 2 and 3.

mode string

The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.

standbyAvailabilityZone string

Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are 1, 2 and 3.

mode str

The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.

standby_availability_zone str

Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are 1, 2 and 3.

mode String

The high availability mode for the MySQL Flexible Server. Possibles values are SameZone and ZoneRedundant.

standbyAvailabilityZone String

Specifies the Availability Zone in which the standby Flexible Server should be located. Possible values are 1, 2 and 3.

FlexibleServerIdentity

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

DayOfWeek int

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.

DayOfWeek int

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.

dayOfWeek Integer

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.

dayOfWeek number

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_week int

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.

dayOfWeek Number

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

AutoGrowEnabled bool

Should Storage Auto Grow be enabled? Defaults to true.

Iops int

The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000.

SizeGb int

The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384.

AutoGrowEnabled bool

Should Storage Auto Grow be enabled? Defaults to true.

Iops int

The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000.

SizeGb int

The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384.

autoGrowEnabled Boolean

Should Storage Auto Grow be enabled? Defaults to true.

iops Integer

The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000.

sizeGb Integer

The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384.

autoGrowEnabled boolean

Should Storage Auto Grow be enabled? Defaults to true.

iops number

The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000.

sizeGb number

The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384.

auto_grow_enabled bool

Should Storage Auto Grow be enabled? Defaults to true.

iops int

The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000.

size_gb int

The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384.

autoGrowEnabled Boolean

Should Storage Auto Grow be enabled? Defaults to true.

iops Number

The storage IOPS for the MySQL Flexible Server. Possible values are between 360 and 20000.

sizeGb Number

The max storage allowed for the MySQL Flexible Server. Possible values are between 20 and 16384.

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.