1. Packages
  2. Azure Classic
  3. API Docs
  4. mysql
  5. FlexibleDatabase

We recommend using Azure Native.

Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi

azure.mysql.FlexibleDatabase

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi

    Manages a MySQL Database within 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 exampleFlexibleServer = new azure.mysql.FlexibleServer("example", {
        name: "example-mysql-flexible-server",
        resourceGroupName: example.name,
        location: example.location,
        administratorLogin: "mysqladminun",
        administratorPassword: "H@Sh1CoR3!",
        skuName: "B_Standard_B1s",
    });
    const exampleFlexibleDatabase = new azure.mysql.FlexibleDatabase("example", {
        name: "exampledb",
        resourceGroupName: example.name,
        serverName: exampleFlexibleServer.name,
        charset: "utf8",
        collation: "utf8_unicode_ci",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_flexible_server = azure.mysql.FlexibleServer("example",
        name="example-mysql-flexible-server",
        resource_group_name=example.name,
        location=example.location,
        administrator_login="mysqladminun",
        administrator_password="H@Sh1CoR3!",
        sku_name="B_Standard_B1s")
    example_flexible_database = azure.mysql.FlexibleDatabase("example",
        name="exampledb",
        resource_group_name=example.name,
        server_name=example_flexible_server.name,
        charset="utf8",
        collation="utf8_unicode_ci")
    
    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/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
    		}
    		exampleFlexibleServer, err := mysql.NewFlexibleServer(ctx, "example", &mysql.FlexibleServerArgs{
    			Name:                  pulumi.String("example-mysql-flexible-server"),
    			ResourceGroupName:     example.Name,
    			Location:              example.Location,
    			AdministratorLogin:    pulumi.String("mysqladminun"),
    			AdministratorPassword: pulumi.String("H@Sh1CoR3!"),
    			SkuName:               pulumi.String("B_Standard_B1s"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mysql.NewFlexibleDatabase(ctx, "example", &mysql.FlexibleDatabaseArgs{
    			Name:              pulumi.String("exampledb"),
    			ResourceGroupName: example.Name,
    			ServerName:        exampleFlexibleServer.Name,
    			Charset:           pulumi.String("utf8"),
    			Collation:         pulumi.String("utf8_unicode_ci"),
    		})
    		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 exampleFlexibleServer = new Azure.MySql.FlexibleServer("example", new()
        {
            Name = "example-mysql-flexible-server",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AdministratorLogin = "mysqladminun",
            AdministratorPassword = "H@Sh1CoR3!",
            SkuName = "B_Standard_B1s",
        });
    
        var exampleFlexibleDatabase = new Azure.MySql.FlexibleDatabase("example", new()
        {
            Name = "exampledb",
            ResourceGroupName = example.Name,
            ServerName = exampleFlexibleServer.Name,
            Charset = "utf8",
            Collation = "utf8_unicode_ci",
        });
    
    });
    
    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.mysql.FlexibleServer;
    import com.pulumi.azure.mysql.FlexibleServerArgs;
    import com.pulumi.azure.mysql.FlexibleDatabase;
    import com.pulumi.azure.mysql.FlexibleDatabaseArgs;
    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 exampleFlexibleServer = new FlexibleServer("exampleFlexibleServer", FlexibleServerArgs.builder()
                .name("example-mysql-flexible-server")
                .resourceGroupName(example.name())
                .location(example.location())
                .administratorLogin("mysqladminun")
                .administratorPassword("H@Sh1CoR3!")
                .skuName("B_Standard_B1s")
                .build());
    
            var exampleFlexibleDatabase = new FlexibleDatabase("exampleFlexibleDatabase", FlexibleDatabaseArgs.builder()
                .name("exampledb")
                .resourceGroupName(example.name())
                .serverName(exampleFlexibleServer.name())
                .charset("utf8")
                .collation("utf8_unicode_ci")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleFlexibleServer:
        type: azure:mysql:FlexibleServer
        name: example
        properties:
          name: example-mysql-flexible-server
          resourceGroupName: ${example.name}
          location: ${example.location}
          administratorLogin: mysqladminun
          administratorPassword: H@Sh1CoR3!
          skuName: B_Standard_B1s
      exampleFlexibleDatabase:
        type: azure:mysql:FlexibleDatabase
        name: example
        properties:
          name: exampledb
          resourceGroupName: ${example.name}
          serverName: ${exampleFlexibleServer.name}
          charset: utf8
          collation: utf8_unicode_ci
    

    Create FlexibleDatabase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FlexibleDatabase(name: string, args: FlexibleDatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def FlexibleDatabase(resource_name: str,
                         args: FlexibleDatabaseArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def FlexibleDatabase(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         charset: Optional[str] = None,
                         collation: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         server_name: Optional[str] = None,
                         name: Optional[str] = None)
    func NewFlexibleDatabase(ctx *Context, name string, args FlexibleDatabaseArgs, opts ...ResourceOption) (*FlexibleDatabase, error)
    public FlexibleDatabase(string name, FlexibleDatabaseArgs args, CustomResourceOptions? opts = null)
    public FlexibleDatabase(String name, FlexibleDatabaseArgs args)
    public FlexibleDatabase(String name, FlexibleDatabaseArgs args, CustomResourceOptions options)
    
    type: azure:mysql:FlexibleDatabase
    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 FlexibleDatabaseArgs
    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 FlexibleDatabaseArgs
    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 FlexibleDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlexibleDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlexibleDatabaseArgs
    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 flexibleDatabaseResource = new Azure.MySql.FlexibleDatabase("flexibleDatabaseResource", new()
    {
        Charset = "string",
        Collation = "string",
        ResourceGroupName = "string",
        ServerName = "string",
        Name = "string",
    });
    
    example, err := mysql.NewFlexibleDatabase(ctx, "flexibleDatabaseResource", &mysql.FlexibleDatabaseArgs{
    	Charset:           pulumi.String("string"),
    	Collation:         pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	ServerName:        pulumi.String("string"),
    	Name:              pulumi.String("string"),
    })
    
    var flexibleDatabaseResource = new FlexibleDatabase("flexibleDatabaseResource", FlexibleDatabaseArgs.builder()
        .charset("string")
        .collation("string")
        .resourceGroupName("string")
        .serverName("string")
        .name("string")
        .build());
    
    flexible_database_resource = azure.mysql.FlexibleDatabase("flexibleDatabaseResource",
        charset="string",
        collation="string",
        resource_group_name="string",
        server_name="string",
        name="string")
    
    const flexibleDatabaseResource = new azure.mysql.FlexibleDatabase("flexibleDatabaseResource", {
        charset: "string",
        collation: "string",
        resourceGroupName: "string",
        serverName: "string",
        name: "string",
    });
    
    type: azure:mysql:FlexibleDatabase
    properties:
        charset: string
        collation: string
        name: string
        resourceGroupName: string
        serverName: string
    

    FlexibleDatabase 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 FlexibleDatabase resource accepts the following input properties:

    Charset string
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    Collation string
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    ServerName string
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    Charset string
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    Collation string
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    ServerName string
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    charset String
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation String
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    serverName String
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    name String
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    charset string
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation string
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    serverName string
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    name string
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    charset str
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation str
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    server_name str
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    name str
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    charset String
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation String
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    serverName String
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    name String
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FlexibleDatabase resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FlexibleDatabase Resource

    Get an existing FlexibleDatabase 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?: FlexibleDatabaseState, opts?: CustomResourceOptions): FlexibleDatabase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            charset: Optional[str] = None,
            collation: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            server_name: Optional[str] = None) -> FlexibleDatabase
    func GetFlexibleDatabase(ctx *Context, name string, id IDInput, state *FlexibleDatabaseState, opts ...ResourceOption) (*FlexibleDatabase, error)
    public static FlexibleDatabase Get(string name, Input<string> id, FlexibleDatabaseState? state, CustomResourceOptions? opts = null)
    public static FlexibleDatabase get(String name, Output<String> id, FlexibleDatabaseState 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:
    Charset string
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    Collation string
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    ServerName string
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    Charset string
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    Collation string
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    ServerName string
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    charset String
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation String
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    name String
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    serverName String
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    charset string
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation string
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    name string
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    serverName string
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    charset str
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation str
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    name str
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    server_name str
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.
    charset String
    Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.
    collation String
    Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.
    name String
    Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.
    serverName String
    Specifies the name of the MySQL Flexible Server. Changing this forces a new resource to be created.

    Import

    MySQL Database’s can be imported using the resource id, e.g.

    $ pulumi import azure:mysql/flexibleDatabase:FlexibleDatabase database1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DBforMySQL/flexibleServers/flexibleserver1/databases/database1
    

    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 azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.12.0 published on Monday, Dec 2, 2024 by Pulumi