Module mysql

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Configuration
Database
FirewallRule
Server
VirtualNetworkRule

Resources

Resource Configuration

class Configuration extends CustomResource

Sets a MySQL Configuration value on a MySQL Server.

Disclaimers

Note: Since this resource is provisioned by default, the Azure Provider will not check for the presence of an existing resource prior to attempting to create it.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServer = new azure.mysql.Server("exampleServer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "GP_Gen5_2",
    storage_profile: {
        storageMb: 5120,
        backupRetentionDays: 7,
        geoRedundantBackup: "Disabled",
    },
    administratorLogin: "psqladminun",
    administratorLoginPassword: "H@Sh1CoR3!",
    version: "5.7",
    sslEnforcement: "Enabled",
});
const exampleConfiguration = new azure.mysql.Configuration("exampleConfiguration", {
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleServer.name,
    value: "600",
});

constructor

new Configuration(name: string, args: ConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a Configuration 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?: ConfigurationState, opts?: pulumi.CustomResourceOptions): Configuration

Get an existing Configuration 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): obj is Configuration

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

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 MySQL Configuration, which needs to be a valid MySQL configuration name. 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 MySQL Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the MySQL 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.

property value

public value: pulumi.Output<string>;

Specifies the value of the MySQL Configuration. See the MySQL documentation for valid values.

Resource Database

class Database extends CustomResource

Manages a MySQL Database within a MySQL Server

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServer = new azure.mysql.Server("exampleServer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "B_Gen5_2",
    storage_profile: {
        storageMb: 5120,
        backupRetentionDays: 7,
        geoRedundantBackup: "Disabled",
    },
    administratorLogin: "mysqladminun",
    administratorLoginPassword: "H@Sh1CoR3!",
    version: "5.7",
    sslEnforcement: "Enabled",
});
const exampleDatabase = new azure.mysql.Database("exampleDatabase", {
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleServer.name,
    charset: "utf8",
    collation: "utf8_unicode_ci",
});

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): obj is Database

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 MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.

property collation

public collation: pulumi.Output<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.

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 MySQL Database, which needs to be a valid MySQL 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 MySQL Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the MySQL 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.

Resource FirewallRule

class FirewallRule extends CustomResource

Manages a Firewall Rule for a MySQL Server

Example Usage

Single IP Address)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServer = new azure.mysql.Server("exampleServer", {});
// ...
const exampleFirewallRule = new azure.mysql.FirewallRule("exampleFirewallRule", {
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleServer.name,
    startIpAddress: "40.112.8.12",
    endIpAddress: "40.112.8.12",
});

IP Range)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServer = new azure.mysql.Server("exampleServer", {});
// ...
const exampleFirewallRule = new azure.mysql.FirewallRule("exampleFirewallRule", {
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleServer.name,
    startIpAddress: "40.112.0.0",
    endIpAddress: "40.112.255.255",
});

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): obj is FirewallRule

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 MySQL 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 MySQL Server exists. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

Specifies the name of the MySQL 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.

Resource Server

class Server extends CustomResource

Manages a MySQL Server.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleServer = new azure.mysql.Server("exampleServer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    administratorLogin: "mysqladminun",
    administratorLoginPassword: "H@Sh1CoR3!",
    skuName: "B_Gen5_2",
    storageMb: 5120,
    version: "5.7",
    autoGrowEnabled: true,
    backupRetentionDays: 7,
    geoRedundantBackupEnabled: true,
    infrastructureEncryptionEnabled: true,
    publicNetworkAccessEnabled: false,
    sslEnforcementEnabled: true,
    sslMinimalTlsVersionEnforced: "TLS1_2",
});

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): obj is Server

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 MySQL Server. Required when createMode is Default. Changing this forces a new resource to be created.

property administratorLoginPassword

public administratorLoginPassword: pulumi.Output<string | undefined>;

The Password associated with the administratorLogin for the MySQL Server. Required when createMode is Default.

property autoGrowEnabled

public autoGrowEnabled: pulumi.Output<boolean>;

Enable/Disable auto-growing of the storage. Storage auto-grow prevents your server from running out of storage and becoming read-only. If storage auto grow is enabled, the storage automatically grows without impacting the workload. The default value if not explicitly specified is true.

property backupRetentionDays

public backupRetentionDays: pulumi.Output<number>;

Backup retention days for the server, supported values are between 7 and 35 days.

property createMode

public createMode: pulumi.Output<string | undefined>;

The creation mode. Can be used to restore or replicate existing servers. Possible values are Default, Replica, GeoRestore, and PointInTimeRestore. Defaults to Default.

property creationSourceServerId

public creationSourceServerId: pulumi.Output<string | undefined>;

For creation modes other than Default, the source server ID to use.

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the MySQL Server.

property geoRedundantBackupEnabled

public geoRedundantBackupEnabled: pulumi.Output<boolean>;

Turn Geo-redundant server backups on/off. This allows you to choose between locally redundant or geo-redundant backup storage in the General Purpose and Memory Optimized tiers. When the backups are stored in geo-redundant backup storage, they are not only stored within the region in which your server is hosted, but are also replicated to a paired data center. This provides better protection and ability to restore your server in a different region in the event of a disaster. This is not supported for the Basic tier.

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 infrastructureEncryptionEnabled

public infrastructureEncryptionEnabled: pulumi.Output<boolean | undefined>;

Whether or not infrastructure is encrypted for this server. Defaults to false. Changing this forces a new resource to be created.

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 MySQL Server. Changing this forces a new resource to be created. This needs to be globally unique within Azure.

property publicNetworkAccessEnabled

public publicNetworkAccessEnabled: pulumi.Output<boolean | undefined>;

Whether or not public network access is allowed for this server. Defaults to true.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property restorePointInTime

public restorePointInTime: pulumi.Output<string | undefined>;

When createMode is PointInTimeRestore, specifies the point in time to restore from creationSourceServerId.

property skuName

public skuName: pulumi.Output<string>;

Specifies the SKU Name for this MySQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

property sslEnforcement

DEPRECATED this has been moved to the boolean attribute ssl_enforcement_enabled and will be removed in version 3.0 of the provider.

public sslEnforcement: pulumi.Output<string>;

property sslEnforcementEnabled

public sslEnforcementEnabled: pulumi.Output<boolean>;

Specifies if SSL should be enforced on connections. Possible values are true and false.

property sslMinimalTlsVersionEnforced

public sslMinimalTlsVersionEnforced: pulumi.Output<string | undefined>;

The minimum TLS version to support on the sever. Possible values are TLSEnforcementDisabled, TLS1_0, TLS1_1, and TLS1_2. Defaults to TLSEnforcementDisabled.

property storageMb

public storageMb: pulumi.Output<number>;

Max storage allowed for a server. Possible values are between 5120 MB(5GB) and 1048576 MB(1TB) for the Basic SKU and between 5120 MB(5GB) and 4194304 MB(4TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation.

property storageProfile

DEPRECATED all storage_profile properties have been moved to the top level. This block will be removed in version 3.0 of the provider.

public storageProfile: pulumi.Output<ServerStorageProfile>;

property tags

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

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 MySQL to use. Valid values are 5.6, 5.7, and 8.0. Changing this forces a new resource to be created.

Resource VirtualNetworkRule

class VirtualNetworkRule extends CustomResource

Manages a MySQL Virtual Network Rule.

NOTE: MySQL Virtual Network Rules can only be used with SKU Tiers of GeneralPurpose or MemoryOptimized

Example Usage

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", {
    addressSpaces: ["10.7.29.0/29"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const internal = new azure.network.Subnet("internal", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.7.29.0/29",
    serviceEndpoints: ["Microsoft.Sql"],
});
const exampleServer = new azure.mysql.Server("exampleServer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    administratorLogin: "mysqladminun",
    administratorLoginPassword: "H@Sh1CoR3!",
    version: "5.7",
    sslEnforcement: "Enabled",
    skuName: "GP_Gen5_2",
    storage_profile: {
        storageMb: 5120,
        backupRetentionDays: 7,
        geoRedundantBackup: "Disabled",
    },
});
const exampleVirtualNetworkRule = new azure.mysql.VirtualNetworkRule("exampleVirtualNetworkRule", {
    resourceGroupName: exampleResourceGroup.name,
    serverName: exampleServer.name,
    subnetId: internal.id,
});

constructor

new VirtualNetworkRule(name: string, args: VirtualNetworkRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetworkRule 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?: VirtualNetworkRuleState, opts?: pulumi.CustomResourceOptions): VirtualNetworkRule

Get an existing VirtualNetworkRule 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): obj is VirtualNetworkRule

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

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>;

The name of the MySQL Virtual Network Rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group where the MySQL server resides. Changing this forces a new resource to be created.

property serverName

public serverName: pulumi.Output<string>;

The name of the SQL Server to which this MySQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

public subnetId: pulumi.Output<string>;

The ID of the subnet that the MySQL server will be connected to.

property urn

urn: Output<URN>;

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

Others

interface ConfigurationArgs

interface ConfigurationArgs

The set of arguments for constructing a Configuration resource.

property name

name?: pulumi.Input<string>;

Specifies the name of the MySQL Configuration, which needs to be a valid MySQL configuration name. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property serverName

serverName: pulumi.Input<string>;

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

property value

value: pulumi.Input<string>;

Specifies the value of the MySQL Configuration. See the MySQL documentation for valid values.

interface ConfigurationState

interface ConfigurationState

Input properties used for looking up and filtering Configuration resources.

property name

name?: pulumi.Input<string>;

Specifies the name of the MySQL Configuration, which needs to be a valid MySQL configuration name. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property serverName

serverName?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

Specifies the value of the MySQL Configuration. See the MySQL documentation for valid values.

interface DatabaseArgs

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property charset

charset: pulumi.Input<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.

property collation

collation: pulumi.Input<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.

property name

name?: pulumi.Input<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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property serverName

serverName: pulumi.Input<string>;

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

interface DatabaseState

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property charset

charset?: pulumi.Input<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.

property collation

collation?: pulumi.Input<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.

property name

name?: pulumi.Input<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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property serverName

serverName?: pulumi.Input<string>;

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

interface FirewallRuleArgs

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 MySQL 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 MySQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

Specifies the name of the MySQL 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

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 MySQL 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 MySQL Server exists. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

Specifies the name of the MySQL 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

interface ServerArgs

The set of arguments for constructing a Server resource.

property administratorLogin

administratorLogin?: pulumi.Input<string>;

The Administrator Login for the MySQL Server. Required when createMode is Default. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword?: pulumi.Input<string>;

The Password associated with the administratorLogin for the MySQL Server. Required when createMode is Default.

property autoGrowEnabled

autoGrowEnabled?: pulumi.Input<boolean>;

property backupRetentionDays

backupRetentionDays?: pulumi.Input<number>;

Backup retention days for the server, supported values are between 7 and 35 days.

property createMode

createMode?: pulumi.Input<string>;

The creation mode. Can be used to restore or replicate existing servers. Possible values are Default, Replica, GeoRestore, and PointInTimeRestore. Defaults to Default.

property creationSourceServerId

creationSourceServerId?: pulumi.Input<string>;

For creation modes other than Default, the source server ID to use.

property geoRedundantBackupEnabled

geoRedundantBackupEnabled?: pulumi.Input<boolean>;

property infrastructureEncryptionEnabled

infrastructureEncryptionEnabled?: pulumi.Input<boolean>;

Whether or not infrastructure is encrypted for this server. Defaults to false. Changing this forces a new resource to be created.

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 MySQL Server. Changing this forces a new resource to be created. This needs to be globally unique within Azure.

property publicNetworkAccessEnabled

publicNetworkAccessEnabled?: pulumi.Input<boolean>;

Whether or not public network access is allowed for this server. Defaults to true.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property restorePointInTime

restorePointInTime?: pulumi.Input<string>;

When createMode is PointInTimeRestore, specifies the point in time to restore from creationSourceServerId.

property skuName

skuName: pulumi.Input<string>;

Specifies the SKU Name for this MySQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

property sslEnforcement

DEPRECATED this has been moved to the boolean attribute ssl_enforcement_enabled and will be removed in version 3.0 of the provider.

sslEnforcement?: pulumi.Input<string>;

property sslEnforcementEnabled

sslEnforcementEnabled?: pulumi.Input<boolean>;

Specifies if SSL should be enforced on connections. Possible values are true and false.

property sslMinimalTlsVersionEnforced

sslMinimalTlsVersionEnforced?: pulumi.Input<string>;

The minimum TLS version to support on the sever. Possible values are TLSEnforcementDisabled, TLS1_0, TLS1_1, and TLS1_2. Defaults to TLSEnforcementDisabled.

property storageMb

storageMb?: pulumi.Input<number>;

property storageProfile

DEPRECATED all storage_profile properties have been moved to the top level. This block will be removed in version 3.0 of the provider.

storageProfile?: pulumi.Input<ServerStorageProfile>;

property tags

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

A mapping of tags to assign to the resource.

property version

version: pulumi.Input<string>;

Specifies the version of MySQL to use. Valid values are 5.6, 5.7, and 8.0. Changing this forces a new resource to be created.

interface ServerState

interface ServerState

Input properties used for looking up and filtering Server resources.

property administratorLogin

administratorLogin?: pulumi.Input<string>;

The Administrator Login for the MySQL Server. Required when createMode is Default. Changing this forces a new resource to be created.

property administratorLoginPassword

administratorLoginPassword?: pulumi.Input<string>;

The Password associated with the administratorLogin for the MySQL Server. Required when createMode is Default.

property autoGrowEnabled

autoGrowEnabled?: pulumi.Input<boolean>;

property backupRetentionDays

backupRetentionDays?: pulumi.Input<number>;

Backup retention days for the server, supported values are between 7 and 35 days.

property createMode

createMode?: pulumi.Input<string>;

The creation mode. Can be used to restore or replicate existing servers. Possible values are Default, Replica, GeoRestore, and PointInTimeRestore. Defaults to Default.

property creationSourceServerId

creationSourceServerId?: pulumi.Input<string>;

For creation modes other than Default, the source server ID to use.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the MySQL Server.

property geoRedundantBackupEnabled

geoRedundantBackupEnabled?: pulumi.Input<boolean>;

property infrastructureEncryptionEnabled

infrastructureEncryptionEnabled?: pulumi.Input<boolean>;

Whether or not infrastructure is encrypted for this server. Defaults to false. Changing this forces a new resource to be created.

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 MySQL Server. Changing this forces a new resource to be created. This needs to be globally unique within Azure.

property publicNetworkAccessEnabled

publicNetworkAccessEnabled?: pulumi.Input<boolean>;

Whether or not public network access is allowed for this server. Defaults to true.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property restorePointInTime

restorePointInTime?: pulumi.Input<string>;

When createMode is PointInTimeRestore, specifies the point in time to restore from creationSourceServerId.

property skuName

skuName?: pulumi.Input<string>;

Specifies the SKU Name for this MySQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

property sslEnforcement

DEPRECATED this has been moved to the boolean attribute ssl_enforcement_enabled and will be removed in version 3.0 of the provider.

sslEnforcement?: pulumi.Input<string>;

property sslEnforcementEnabled

sslEnforcementEnabled?: pulumi.Input<boolean>;

Specifies if SSL should be enforced on connections. Possible values are true and false.

property sslMinimalTlsVersionEnforced

sslMinimalTlsVersionEnforced?: pulumi.Input<string>;

The minimum TLS version to support on the sever. Possible values are TLSEnforcementDisabled, TLS1_0, TLS1_1, and TLS1_2. Defaults to TLSEnforcementDisabled.

property storageMb

storageMb?: pulumi.Input<number>;

property storageProfile

DEPRECATED all storage_profile properties have been moved to the top level. This block will be removed in version 3.0 of the provider.

storageProfile?: pulumi.Input<ServerStorageProfile>;

property tags

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

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

Specifies the version of MySQL to use. Valid values are 5.6, 5.7, and 8.0. Changing this forces a new resource to be created.

interface VirtualNetworkRuleArgs

interface VirtualNetworkRuleArgs

The set of arguments for constructing a VirtualNetworkRule resource.

property name

name?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group where the MySQL server resides. Changing this forces a new resource to be created.

property serverName

serverName: pulumi.Input<string>;

The name of the SQL Server to which this MySQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

subnetId: pulumi.Input<string>;

The ID of the subnet that the MySQL server will be connected to.

interface VirtualNetworkRuleState

interface VirtualNetworkRuleState

Input properties used for looking up and filtering VirtualNetworkRule resources.

property name

name?: pulumi.Input<string>;

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group where the MySQL server resides. Changing this forces a new resource to be created.

property serverName

serverName?: pulumi.Input<string>;

The name of the SQL Server to which this MySQL virtual network rule will be applied to. Changing this forces a new resource to be created.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the subnet that the MySQL server will be connected to.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module mysql

Resources

Others

Resources

Disclaimers

Example Usage

Example Usage

Example Usage

Single IP Address)

IP Range)

Example Usage

Example Usage

Others