Module mariadb

@pulumi/azure > mariadb

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class Database

extends CustomResource

Manages a MariaDB Database within a MariaDB Server

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    location: "westeurope",
    name: "tfex-mariadb-database-RG",
});
const exampleServer = new azure.mariadb.Server("example", {
    administratorLogin: "acctestun",
    administratorLoginPassword: "H@Sh1CoR3!",
    location: exampleResourceGroup.location,
    name: "mariadb-svr",
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        capacity: 2,
        family: "Gen5",
        name: "B_Gen5_2",
        tier: "Basic",
    },
    sslEnforcement: "Enabled",
    storageProfile: {
        backupRetentionDays: 7,
        geoRedundantBackup: "Disabled",
        storageMb: 51200,
    },
    version: "10.2",
});
const exampleDatabase = new azure.mariadb.Database("example", {
    charset: "utf8",
    collation: "utf8GeneralCi",
    name: "mariadbDatabase",
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleServer.name,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/mariadb_database.html.markdown.

constructor

new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions)

Create a Database resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database

Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Database. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property charset

public charset: pulumi.Output<string>;

Specifies the Charset for the MariaDB Database, which needs to be a valid MariaDB Charset. Changing this forces a new resource to be created.

property collation

public collation: pulumi.Output<string>;

Specifies the Collation for the MariaDB Database, which needs to be a valid MariaDB Collation. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the MariaDB Database, which needs to be a valid MariaDB identifier. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the MariaDB Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class FirewallRule

extends CustomResource

Manages a Firewall Rule for a MariaDB Server

Example Usage (Single IP Address)

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

const test = new azure.mariadb.FirewallRule("test", {
    endIpAddress: "40.112.8.12",
    name: "test-rule",
    resourceGroupName: "test-rg",
    serverName: "test-server",
    startIpAddress: "40.112.8.12",
});

Example Usage (IP Range)

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

const test = new azure.mariadb.FirewallRule("test", {
    endIpAddress: "40.112.255.255",
    name: "test-rule",
    resourceGroupName: "test-rg",
    serverName: "test-server",
    startIpAddress: "40.112.0.0",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/mariadb_firewall_rule.html.markdown.

constructor

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallRuleState, opts?: pulumi.CustomResourceOptions): FirewallRule

Get an existing FirewallRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of FirewallRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endIpAddress

public endIpAddress: pulumi.Output<string>;

Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the MariaDB Firewall Rule. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the MariaDB Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property startIpAddress

public startIpAddress: pulumi.Output<string>;

Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Server

extends CustomResource

Manages a MariaDB Server.

NOTE MariaDB Server is currently in Public Preview. You can find more information, including how to register for the Public Preview here.

Example Usage

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

const testResourceGroup = new azure.core.ResourceGroup("test", {
    location: "West Europe",
    name: "api-rg-pro",
});
const testServer = new azure.mariadb.Server("test", {
    administratorLogin: "mariadbadmin",
    administratorLoginPassword: "H@Sh1CoR3!",
    location: testResourceGroup.location,
    name: "mariadb-server-1",
    resourceGroupName: testResourceGroup.name,
    sku: {
        capacity: 2,
        family: "Gen5",
        name: "B_Gen5_2",
        tier: "Basic",
    },
    sslEnforcement: "Enabled",
    storageProfile: {
        backupRetentionDays: 7,
        geoRedundantBackup: "Disabled",
        storageMb: 5120,
    },
    version: "10.2",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/mariadb_server.html.markdown.

constructor

new Server(name: string, args: ServerArgs, opts?: pulumi.CustomResourceOptions)

Create a Server resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServerState, opts?: pulumi.CustomResourceOptions): Server

Get an existing Server resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Server. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property administratorLogin

public administratorLogin: pulumi.Output<string>;

The Administrator Login for the MariaDB Server. Changing this forces a new resource to be created.

property administratorLoginPassword

public administratorLoginPassword: pulumi.Output<string>;

The Password associated with the administratorLogin for the MariaDB Server.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the MariaDB Server.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the MariaDB Server. Changing this forces a new resource to be created.

property sku

public sku: pulumi.Output<{
    capacity: number;
    family: string;
    name: string;
    tier: string;
}>;

A sku block as defined below.

property sslEnforcement

public sslEnforcement: pulumi.Output<string>;

Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

property storageProfile

public storageProfile: pulumi.Output<{
    backupRetentionDays: undefined | number;
    geoRedundantBackup: undefined | string;
    storageMb: number;
}>;

A storageProfile block as defined below.

property tags

public tags: pulumi.Output<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

Specifies the version of MariaDB to use. The valid value is 10.2. Changing this forces a new resource to be created.

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property charset

charset: pulumi.Input<string>;

Specifies the Charset for the MariaDB Database, which needs to be a valid MariaDB Charset. Changing this forces a new resource to be created.

property collation

collation: pulumi.Input<string>;

Specifies the Collation for the MariaDB Database, which needs to be a valid MariaDB Collation. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the MariaDB Database, which needs to be a valid MariaDB identifier. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the MariaDB Server exists. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property charset

charset?: pulumi.Input<string>;

Specifies the Charset for the MariaDB Database, which needs to be a valid MariaDB Charset. Changing this forces a new resource to be created.

property collation

collation?: pulumi.Input<string>;

Specifies the Collation for the MariaDB Database, which needs to be a valid MariaDB Collation. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the MariaDB Database, which needs to be a valid MariaDB identifier. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the MariaDB Server exists. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

interface FirewallRuleArgs

The set of arguments for constructing a FirewallRule resource.

property endIpAddress

endIpAddress: pulumi.Input<string>;

Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the MariaDB Firewall Rule. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the MariaDB Server exists. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property startIpAddress

startIpAddress: pulumi.Input<string>;

Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

interface FirewallRuleState

Input properties used for looking up and filtering FirewallRule resources.

property endIpAddress

endIpAddress?: pulumi.Input<string>;

Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the MariaDB Firewall Rule. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the MariaDB Server exists. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property startIpAddress

startIpAddress?: pulumi.Input<string>;

Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.

interface ServerArgs

The set of arguments for constructing a Server resource.

property administratorLogin

administratorLogin: pulumi.Input<string>;

The Administrator Login for the MariaDB Server. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword: pulumi.Input<string>;

The Password associated with the administratorLogin for the MariaDB Server.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the MariaDB Server. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<{
    capacity: pulumi.Input<number>;
    family: pulumi.Input<string>;
    name: pulumi.Input<string>;
    tier: pulumi.Input<string>;
}>;

A sku block as defined below.

property sslEnforcement

sslEnforcement: pulumi.Input<string>;

Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

property storageProfile

storageProfile: pulumi.Input<{
    backupRetentionDays: pulumi.Input<number>;
    geoRedundantBackup: pulumi.Input<string>;
    storageMb: pulumi.Input<number>;
}>;

A storageProfile block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property version

version: pulumi.Input<string>;

Specifies the version of MariaDB to use. The valid value is 10.2. Changing this forces a new resource to be created.

interface ServerState

Input properties used for looking up and filtering Server resources.

property administratorLogin

administratorLogin?: pulumi.Input<string>;

The Administrator Login for the MariaDB Server. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword?: pulumi.Input<string>;

The Password associated with the administratorLogin for the MariaDB Server.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the MariaDB Server.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the MariaDB Server. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the MariaDB Server. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<{
    capacity: pulumi.Input<number>;
    family: pulumi.Input<string>;
    name: pulumi.Input<string>;
    tier: pulumi.Input<string>;
}>;

A sku block as defined below.

property sslEnforcement

sslEnforcement?: pulumi.Input<string>;

Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

property storageProfile

storageProfile?: pulumi.Input<{
    backupRetentionDays: pulumi.Input<number>;
    geoRedundantBackup: pulumi.Input<string>;
    storageMb: pulumi.Input<number>;
}>;

A storageProfile block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

Specifies the version of MariaDB to use. The valid value is 10.2. Changing this forces a new resource to be created.