We recommend using Azure Native.
azure.mysql.Server
Explore with Pulumi AI
Manages a MySQL Server.
Note: Azure Database for MySQL Single Server and its sub resources are scheduled for retirement by 2024-09-16 and will migrate to using Azure Database for MySQL Flexible Server: https://go.microsoft.com/fwlink/?linkid=2216041. The
azure.mysql.Server
resource is deprecated and will be removed in v4.0 of the AzureRM Provider. Please use theazure.mysql.FlexibleServer
resource instead.
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 exampleServer = new azure.mysql.Server("example", {
name: "example-mysqlserver",
location: example.location,
resourceGroupName: example.name,
administratorLogin: "mysqladminun",
administratorLoginPassword: "H@Sh1CoR3!",
skuName: "B_Gen5_2",
storageMb: 5120,
version: "5.7",
autoGrowEnabled: true,
backupRetentionDays: 7,
geoRedundantBackupEnabled: false,
infrastructureEncryptionEnabled: false,
publicNetworkAccessEnabled: true,
sslEnforcementEnabled: true,
sslMinimalTlsVersionEnforced: "TLS1_2",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_server = azure.mysql.Server("example",
name="example-mysqlserver",
location=example.location,
resource_group_name=example.name,
administrator_login="mysqladminun",
administrator_login_password="H@Sh1CoR3!",
sku_name="B_Gen5_2",
storage_mb=5120,
version="5.7",
auto_grow_enabled=True,
backup_retention_days=7,
geo_redundant_backup_enabled=False,
infrastructure_encryption_enabled=False,
public_network_access_enabled=True,
ssl_enforcement_enabled=True,
ssl_minimal_tls_version_enforced="TLS1_2")
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/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
}
_, err = mysql.NewServer(ctx, "example", &mysql.ServerArgs{
Name: pulumi.String("example-mysqlserver"),
Location: example.Location,
ResourceGroupName: example.Name,
AdministratorLogin: pulumi.String("mysqladminun"),
AdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
SkuName: pulumi.String("B_Gen5_2"),
StorageMb: pulumi.Int(5120),
Version: pulumi.String("5.7"),
AutoGrowEnabled: pulumi.Bool(true),
BackupRetentionDays: pulumi.Int(7),
GeoRedundantBackupEnabled: pulumi.Bool(false),
InfrastructureEncryptionEnabled: pulumi.Bool(false),
PublicNetworkAccessEnabled: pulumi.Bool(true),
SslEnforcementEnabled: pulumi.Bool(true),
SslMinimalTlsVersionEnforced: pulumi.String("TLS1_2"),
})
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 exampleServer = new Azure.MySql.Server("example", new()
{
Name = "example-mysqlserver",
Location = example.Location,
ResourceGroupName = example.Name,
AdministratorLogin = "mysqladminun",
AdministratorLoginPassword = "H@Sh1CoR3!",
SkuName = "B_Gen5_2",
StorageMb = 5120,
Version = "5.7",
AutoGrowEnabled = true,
BackupRetentionDays = 7,
GeoRedundantBackupEnabled = false,
InfrastructureEncryptionEnabled = false,
PublicNetworkAccessEnabled = true,
SslEnforcementEnabled = true,
SslMinimalTlsVersionEnforced = "TLS1_2",
});
});
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.Server;
import com.pulumi.azure.mysql.ServerArgs;
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 exampleServer = new Server("exampleServer", ServerArgs.builder()
.name("example-mysqlserver")
.location(example.location())
.resourceGroupName(example.name())
.administratorLogin("mysqladminun")
.administratorLoginPassword("H@Sh1CoR3!")
.skuName("B_Gen5_2")
.storageMb(5120)
.version("5.7")
.autoGrowEnabled(true)
.backupRetentionDays(7)
.geoRedundantBackupEnabled(false)
.infrastructureEncryptionEnabled(false)
.publicNetworkAccessEnabled(true)
.sslEnforcementEnabled(true)
.sslMinimalTlsVersionEnforced("TLS1_2")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleServer:
type: azure:mysql:Server
name: example
properties:
name: example-mysqlserver
location: ${example.location}
resourceGroupName: ${example.name}
administratorLogin: mysqladminun
administratorLoginPassword: H@Sh1CoR3!
skuName: B_Gen5_2
storageMb: 5120
version: '5.7'
autoGrowEnabled: true
backupRetentionDays: 7
geoRedundantBackupEnabled: false
infrastructureEncryptionEnabled: false
publicNetworkAccessEnabled: true
sslEnforcementEnabled: true
sslMinimalTlsVersionEnforced: TLS1_2
Create Server Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);
@overload
def Server(resource_name: str,
args: ServerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Server(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
version: Optional[str] = None,
ssl_enforcement_enabled: Optional[bool] = None,
sku_name: Optional[str] = None,
creation_source_server_id: Optional[str] = None,
restore_point_in_time: Optional[str] = None,
geo_redundant_backup_enabled: Optional[bool] = None,
identity: Optional[ServerIdentityArgs] = None,
infrastructure_encryption_enabled: Optional[bool] = None,
location: Optional[str] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
create_mode: Optional[str] = None,
administrator_login: Optional[str] = None,
backup_retention_days: Optional[int] = None,
auto_grow_enabled: Optional[bool] = None,
ssl_minimal_tls_version_enforced: Optional[str] = None,
storage_mb: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
threat_detection_policy: Optional[ServerThreatDetectionPolicyArgs] = None,
administrator_login_password: Optional[str] = None)
func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)
public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)
type: azure:mysql:Server
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 ServerArgs
- 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 ServerArgs
- 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 ServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServerArgs
- 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 exampleserverResourceResourceFromMysqlserver = new Azure.MySql.Server("exampleserverResourceResourceFromMysqlserver", new()
{
ResourceGroupName = "string",
Version = "string",
SslEnforcementEnabled = false,
SkuName = "string",
CreationSourceServerId = "string",
RestorePointInTime = "string",
GeoRedundantBackupEnabled = false,
Identity = new Azure.MySql.Inputs.ServerIdentityArgs
{
Type = "string",
PrincipalId = "string",
TenantId = "string",
},
InfrastructureEncryptionEnabled = false,
Location = "string",
Name = "string",
PublicNetworkAccessEnabled = false,
CreateMode = "string",
AdministratorLogin = "string",
BackupRetentionDays = 0,
AutoGrowEnabled = false,
SslMinimalTlsVersionEnforced = "string",
StorageMb = 0,
Tags =
{
{ "string", "string" },
},
ThreatDetectionPolicy = new Azure.MySql.Inputs.ServerThreatDetectionPolicyArgs
{
DisabledAlerts = new[]
{
"string",
},
EmailAccountAdmins = false,
EmailAddresses = new[]
{
"string",
},
Enabled = false,
RetentionDays = 0,
StorageAccountAccessKey = "string",
StorageEndpoint = "string",
},
AdministratorLoginPassword = "string",
});
example, err := mysql.NewServer(ctx, "exampleserverResourceResourceFromMysqlserver", &mysql.ServerArgs{
ResourceGroupName: pulumi.String("string"),
Version: pulumi.String("string"),
SslEnforcementEnabled: pulumi.Bool(false),
SkuName: pulumi.String("string"),
CreationSourceServerId: pulumi.String("string"),
RestorePointInTime: pulumi.String("string"),
GeoRedundantBackupEnabled: pulumi.Bool(false),
Identity: &mysql.ServerIdentityArgs{
Type: pulumi.String("string"),
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
InfrastructureEncryptionEnabled: pulumi.Bool(false),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
PublicNetworkAccessEnabled: pulumi.Bool(false),
CreateMode: pulumi.String("string"),
AdministratorLogin: pulumi.String("string"),
BackupRetentionDays: pulumi.Int(0),
AutoGrowEnabled: pulumi.Bool(false),
SslMinimalTlsVersionEnforced: pulumi.String("string"),
StorageMb: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ThreatDetectionPolicy: &mysql.ServerThreatDetectionPolicyArgs{
DisabledAlerts: pulumi.StringArray{
pulumi.String("string"),
},
EmailAccountAdmins: pulumi.Bool(false),
EmailAddresses: pulumi.StringArray{
pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
RetentionDays: pulumi.Int(0),
StorageAccountAccessKey: pulumi.String("string"),
StorageEndpoint: pulumi.String("string"),
},
AdministratorLoginPassword: pulumi.String("string"),
})
var exampleserverResourceResourceFromMysqlserver = new Server("exampleserverResourceResourceFromMysqlserver", ServerArgs.builder()
.resourceGroupName("string")
.version("string")
.sslEnforcementEnabled(false)
.skuName("string")
.creationSourceServerId("string")
.restorePointInTime("string")
.geoRedundantBackupEnabled(false)
.identity(ServerIdentityArgs.builder()
.type("string")
.principalId("string")
.tenantId("string")
.build())
.infrastructureEncryptionEnabled(false)
.location("string")
.name("string")
.publicNetworkAccessEnabled(false)
.createMode("string")
.administratorLogin("string")
.backupRetentionDays(0)
.autoGrowEnabled(false)
.sslMinimalTlsVersionEnforced("string")
.storageMb(0)
.tags(Map.of("string", "string"))
.threatDetectionPolicy(ServerThreatDetectionPolicyArgs.builder()
.disabledAlerts("string")
.emailAccountAdmins(false)
.emailAddresses("string")
.enabled(false)
.retentionDays(0)
.storageAccountAccessKey("string")
.storageEndpoint("string")
.build())
.administratorLoginPassword("string")
.build());
exampleserver_resource_resource_from_mysqlserver = azure.mysql.Server("exampleserverResourceResourceFromMysqlserver",
resource_group_name="string",
version="string",
ssl_enforcement_enabled=False,
sku_name="string",
creation_source_server_id="string",
restore_point_in_time="string",
geo_redundant_backup_enabled=False,
identity=azure.mysql.ServerIdentityArgs(
type="string",
principal_id="string",
tenant_id="string",
),
infrastructure_encryption_enabled=False,
location="string",
name="string",
public_network_access_enabled=False,
create_mode="string",
administrator_login="string",
backup_retention_days=0,
auto_grow_enabled=False,
ssl_minimal_tls_version_enforced="string",
storage_mb=0,
tags={
"string": "string",
},
threat_detection_policy=azure.mysql.ServerThreatDetectionPolicyArgs(
disabled_alerts=["string"],
email_account_admins=False,
email_addresses=["string"],
enabled=False,
retention_days=0,
storage_account_access_key="string",
storage_endpoint="string",
),
administrator_login_password="string")
const exampleserverResourceResourceFromMysqlserver = new azure.mysql.Server("exampleserverResourceResourceFromMysqlserver", {
resourceGroupName: "string",
version: "string",
sslEnforcementEnabled: false,
skuName: "string",
creationSourceServerId: "string",
restorePointInTime: "string",
geoRedundantBackupEnabled: false,
identity: {
type: "string",
principalId: "string",
tenantId: "string",
},
infrastructureEncryptionEnabled: false,
location: "string",
name: "string",
publicNetworkAccessEnabled: false,
createMode: "string",
administratorLogin: "string",
backupRetentionDays: 0,
autoGrowEnabled: false,
sslMinimalTlsVersionEnforced: "string",
storageMb: 0,
tags: {
string: "string",
},
threatDetectionPolicy: {
disabledAlerts: ["string"],
emailAccountAdmins: false,
emailAddresses: ["string"],
enabled: false,
retentionDays: 0,
storageAccountAccessKey: "string",
storageEndpoint: "string",
},
administratorLoginPassword: "string",
});
type: azure:mysql:Server
properties:
administratorLogin: string
administratorLoginPassword: string
autoGrowEnabled: false
backupRetentionDays: 0
createMode: string
creationSourceServerId: string
geoRedundantBackupEnabled: false
identity:
principalId: string
tenantId: string
type: string
infrastructureEncryptionEnabled: false
location: string
name: string
publicNetworkAccessEnabled: false
resourceGroupName: string
restorePointInTime: string
skuName: string
sslEnforcementEnabled: false
sslMinimalTlsVersionEnforced: string
storageMb: 0
tags:
string: string
threatDetectionPolicy:
disabledAlerts:
- string
emailAccountAdmins: false
emailAddresses:
- string
enabled: false
retentionDays: 0
storageAccountAccessKey: string
storageEndpoint: string
version: string
Server 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 Server resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- Sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - Ssl
Enforcement boolEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - Version string
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created. - Administrator
Login string - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - Administrator
Login stringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - Auto
Grow boolEnabled - 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. Defaults to
true
. - Backup
Retention intDays - Backup retention days for the server, supported values are between
7
and35
days. - Create
Mode string - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - Creation
Source stringServer Id - For creation modes other than
Default
, the source server ID to use. - Geo
Redundant boolBackup Enabled - 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.
- Identity
Server
Identity - An
identity
block as defined below. - Infrastructure
Encryption boolEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name 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.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Restore
Point stringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - Ssl
Minimal stringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - Storage
Mb int - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Threat
Detection ServerPolicy Threat Detection Policy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below.
- Resource
Group stringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- Sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - Ssl
Enforcement boolEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - Version string
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created. - Administrator
Login string - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - Administrator
Login stringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - Auto
Grow boolEnabled - 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. Defaults to
true
. - Backup
Retention intDays - Backup retention days for the server, supported values are between
7
and35
days. - Create
Mode string - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - Creation
Source stringServer Id - For creation modes other than
Default
, the source server ID to use. - Geo
Redundant boolBackup Enabled - 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.
- Identity
Server
Identity Args - An
identity
block as defined below. - Infrastructure
Encryption boolEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name 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.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Restore
Point stringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - Ssl
Minimal stringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - Storage
Mb int - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - map[string]string
- A mapping of tags to assign to the resource.
- Threat
Detection ServerPolicy Threat Detection Policy Args - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below.
- resource
Group StringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl
Enforcement BooleanEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - version String
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created. - administrator
Login String - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator
Login StringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto
Grow BooleanEnabled - 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. Defaults to
true
. - backup
Retention IntegerDays - Backup retention days for the server, supported values are between
7
and35
days. - create
Mode String - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation
Source StringServer Id - For creation modes other than
Default
, the source server ID to use. - geo
Redundant BooleanBackup Enabled - 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.
- identity
Server
Identity - An
identity
block as defined below. - infrastructure
Encryption BooleanEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name 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.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - restore
Point StringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - ssl
Minimal StringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage
Mb Integer - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Map<String,String>
- A mapping of tags to assign to the resource.
- threat
Detection ServerPolicy Threat Detection Policy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below.
- resource
Group stringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl
Enforcement booleanEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - version string
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created. - administrator
Login string - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator
Login stringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto
Grow booleanEnabled - 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. Defaults to
true
. - backup
Retention numberDays - Backup retention days for the server, supported values are between
7
and35
days. - create
Mode string - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation
Source stringServer Id - For creation modes other than
Default
, the source server ID to use. - geo
Redundant booleanBackup Enabled - 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.
- identity
Server
Identity - An
identity
block as defined below. - infrastructure
Encryption booleanEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name 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.
- public
Network booleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - restore
Point stringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - ssl
Minimal stringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage
Mb number - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- threat
Detection ServerPolicy Threat Detection Policy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below.
- resource_
group_ strname - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- sku_
name str - 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl_
enforcement_ boolenabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - version str
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created. - administrator_
login str - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator_
login_ strpassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto_
grow_ boolenabled - 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. Defaults to
true
. - backup_
retention_ intdays - Backup retention days for the server, supported values are between
7
and35
days. - create_
mode str - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation_
source_ strserver_ id - For creation modes other than
Default
, the source server ID to use. - geo_
redundant_ boolbackup_ enabled - 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.
- identity
Server
Identity Args - An
identity
block as defined below. - infrastructure_
encryption_ boolenabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the MySQL Server. Changing this forces a new resource to be created. This needs to be globally unique within Azure.
- public_
network_ boolaccess_ enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - restore_
point_ strin_ time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - ssl_
minimal_ strtls_ version_ enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage_
mb int - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- threat_
detection_ Serverpolicy Threat Detection Policy Args - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below.
- resource
Group StringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl
Enforcement BooleanEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - version String
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created. - administrator
Login String - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator
Login StringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto
Grow BooleanEnabled - 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. Defaults to
true
. - backup
Retention NumberDays - Backup retention days for the server, supported values are between
7
and35
days. - create
Mode String - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation
Source StringServer Id - For creation modes other than
Default
, the source server ID to use. - geo
Redundant BooleanBackup Enabled - 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.
- identity Property Map
- An
identity
block as defined below. - infrastructure
Encryption BooleanEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name 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.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - restore
Point StringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - ssl
Minimal StringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage
Mb Number - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Map<String>
- A mapping of tags to assign to the resource.
- threat
Detection Property MapPolicy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Server resource produces the following output properties:
Look up Existing Server Resource
Get an existing Server 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?: ServerState, opts?: CustomResourceOptions): Server
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
administrator_login: Optional[str] = None,
administrator_login_password: Optional[str] = None,
auto_grow_enabled: Optional[bool] = None,
backup_retention_days: Optional[int] = None,
create_mode: Optional[str] = None,
creation_source_server_id: Optional[str] = None,
fqdn: Optional[str] = None,
geo_redundant_backup_enabled: Optional[bool] = None,
identity: Optional[ServerIdentityArgs] = None,
infrastructure_encryption_enabled: Optional[bool] = None,
location: Optional[str] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
restore_point_in_time: Optional[str] = None,
sku_name: Optional[str] = None,
ssl_enforcement_enabled: Optional[bool] = None,
ssl_minimal_tls_version_enforced: Optional[str] = None,
storage_mb: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
threat_detection_policy: Optional[ServerThreatDetectionPolicyArgs] = None,
version: Optional[str] = None) -> Server
func GetServer(ctx *Context, name string, id IDInput, state *ServerState, opts ...ResourceOption) (*Server, error)
public static Server Get(string name, Input<string> id, ServerState? state, CustomResourceOptions? opts = null)
public static Server get(String name, Output<String> id, ServerState 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.
- Administrator
Login string - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - Administrator
Login stringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - Auto
Grow boolEnabled - 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. Defaults to
true
. - Backup
Retention intDays - Backup retention days for the server, supported values are between
7
and35
days. - Create
Mode string - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - Creation
Source stringServer Id - For creation modes other than
Default
, the source server ID to use. - Fqdn string
- The FQDN of the MySQL Server.
- Geo
Redundant boolBackup Enabled - 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.
- Identity
Server
Identity - An
identity
block as defined below. - Infrastructure
Encryption boolEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name 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.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Resource
Group stringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- Restore
Point stringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - Sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - Ssl
Enforcement boolEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - Ssl
Minimal stringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - Storage
Mb int - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Threat
Detection ServerPolicy Threat Detection Policy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below. - Version string
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created.
- Administrator
Login string - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - Administrator
Login stringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - Auto
Grow boolEnabled - 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. Defaults to
true
. - Backup
Retention intDays - Backup retention days for the server, supported values are between
7
and35
days. - Create
Mode string - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - Creation
Source stringServer Id - For creation modes other than
Default
, the source server ID to use. - Fqdn string
- The FQDN of the MySQL Server.
- Geo
Redundant boolBackup Enabled - 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.
- Identity
Server
Identity Args - An
identity
block as defined below. - Infrastructure
Encryption boolEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name 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.
- Public
Network boolAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - Resource
Group stringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- Restore
Point stringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - Sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - Ssl
Enforcement boolEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - Ssl
Minimal stringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - Storage
Mb int - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - map[string]string
- A mapping of tags to assign to the resource.
- Threat
Detection ServerPolicy Threat Detection Policy Args - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below. - Version string
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created.
- administrator
Login String - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator
Login StringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto
Grow BooleanEnabled - 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. Defaults to
true
. - backup
Retention IntegerDays - Backup retention days for the server, supported values are between
7
and35
days. - create
Mode String - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation
Source StringServer Id - For creation modes other than
Default
, the source server ID to use. - fqdn String
- The FQDN of the MySQL Server.
- geo
Redundant BooleanBackup Enabled - 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.
- identity
Server
Identity - An
identity
block as defined below. - infrastructure
Encryption BooleanEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name 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.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource
Group StringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- restore
Point StringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl
Enforcement BooleanEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - ssl
Minimal StringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage
Mb Integer - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Map<String,String>
- A mapping of tags to assign to the resource.
- threat
Detection ServerPolicy Threat Detection Policy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below. - version String
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created.
- administrator
Login string - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator
Login stringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto
Grow booleanEnabled - 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. Defaults to
true
. - backup
Retention numberDays - Backup retention days for the server, supported values are between
7
and35
days. - create
Mode string - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation
Source stringServer Id - For creation modes other than
Default
, the source server ID to use. - fqdn string
- The FQDN of the MySQL Server.
- geo
Redundant booleanBackup Enabled - 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.
- identity
Server
Identity - An
identity
block as defined below. - infrastructure
Encryption booleanEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name 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.
- public
Network booleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource
Group stringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- restore
Point stringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl
Enforcement booleanEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - ssl
Minimal stringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage
Mb number - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- threat
Detection ServerPolicy Threat Detection Policy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below. - version string
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created.
- administrator_
login str - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator_
login_ strpassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto_
grow_ boolenabled - 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. Defaults to
true
. - backup_
retention_ intdays - Backup retention days for the server, supported values are between
7
and35
days. - create_
mode str - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation_
source_ strserver_ id - For creation modes other than
Default
, the source server ID to use. - fqdn str
- The FQDN of the MySQL Server.
- geo_
redundant_ boolbackup_ enabled - 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.
- identity
Server
Identity Args - An
identity
block as defined below. - infrastructure_
encryption_ boolenabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the MySQL Server. Changing this forces a new resource to be created. This needs to be globally unique within Azure.
- public_
network_ boolaccess_ enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource_
group_ strname - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- restore_
point_ strin_ time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - sku_
name str - 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl_
enforcement_ boolenabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - ssl_
minimal_ strtls_ version_ enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage_
mb int - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- threat_
detection_ Serverpolicy Threat Detection Policy Args - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below. - version str
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created.
- administrator
Login String - The Administrator login for the MySQL Server. Required when
create_mode
isDefault
. Changing this forces a new resource to be created. - administrator
Login StringPassword - The Password associated with the
administrator_login
for the MySQL Server. Required whencreate_mode
isDefault
. - auto
Grow BooleanEnabled - 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. Defaults to
true
. - backup
Retention NumberDays - Backup retention days for the server, supported values are between
7
and35
days. - create
Mode String - The creation mode. Can be used to restore or replicate existing servers. Possible values are
Default
,Replica
,GeoRestore
, andPointInTimeRestore
. Defaults toDefault
. - creation
Source StringServer Id - For creation modes other than
Default
, the source server ID to use. - fqdn String
- The FQDN of the MySQL Server.
- geo
Redundant BooleanBackup Enabled - 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.
- identity Property Map
- An
identity
block as defined below. - infrastructure
Encryption BooleanEnabled - Whether or not infrastructure is encrypted for this server. Changing this forces a new resource to be created.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name 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.
- public
Network BooleanAccess Enabled - Whether or not public network access is allowed for this server. Defaults to
true
. - resource
Group StringName - The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.
- restore
Point StringIn Time - When
create_mode
isPointInTimeRestore
, specifies the point in time to restore fromcreation_source_server_id
. It should be provided in RFC3339 format, e.g.2013-11-08T22:00:40Z
. - sku
Name 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. Possible values areB_Gen4_1
,B_Gen4_2
,B_Gen5_1
,B_Gen5_2
,GP_Gen4_2
,GP_Gen4_4
,GP_Gen4_8
,GP_Gen4_16
,GP_Gen4_32
,GP_Gen5_2
,GP_Gen5_4
,GP_Gen5_8
,GP_Gen5_16
,GP_Gen5_32
,GP_Gen5_64
,MO_Gen5_2
,MO_Gen5_4
,MO_Gen5_8
,MO_Gen5_16
andMO_Gen5_32
. - ssl
Enforcement BooleanEnabled - Specifies if SSL should be enforced on connections. Possible values are
true
andfalse
. - ssl
Minimal StringTls Version Enforced - The minimum TLS version to support on the sever. Possible values are
TLSEnforcementDisabled
,TLS1_0
,TLS1_1
, andTLS1_2
. Defaults toTLS1_2
. - storage
Mb Number - Max storage allowed for a server. Possible values are between
5120
MB(5GB) and1048576
MB(1TB) for the Basic SKU and between5120
MB(5GB) and16777216
MB(16TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation. - Map<String>
- A mapping of tags to assign to the resource.
- threat
Detection Property MapPolicy - Threat detection policy configuration, known in the API as Server Security Alerts Policy. The
threat_detection_policy
block supports fields documented below. - version String
- Specifies the version of MySQL to use. Valid values are
5.7
, or8.0
. Changing this forces a new resource to be created.
Supporting Types
ServerIdentity, ServerIdentityArgs
- Type string
- Specifies the type of Managed Service Identity that should be configured on this MySQL Server. The only possible value is
SystemAssigned
. - Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- Type string
- Specifies the type of Managed Service Identity that should be configured on this MySQL Server. The only possible value is
SystemAssigned
. - Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this MySQL Server. The only possible value is
SystemAssigned
. - principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
- type string
- Specifies the type of Managed Service Identity that should be configured on this MySQL Server. The only possible value is
SystemAssigned
. - principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type str
- Specifies the type of Managed Service Identity that should be configured on this MySQL Server. The only possible value is
SystemAssigned
. - principal_
id str - The Principal ID associated with this Managed Service Identity.
- tenant_
id str - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this MySQL Server. The only possible value is
SystemAssigned
. - principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
ServerThreatDetectionPolicy, ServerThreatDetectionPolicyArgs
- Disabled
Alerts List<string> - Specifies a list of alerts which should be disabled. Possible values are
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
andUnsafe_Action
. - Email
Account boolAdmins - Should the account administrators be emailed when this alert is triggered?
- Email
Addresses List<string> - A list of email addresses which alerts should be sent to.
- Enabled bool
- Is the policy enabled?
- Retention
Days int - Specifies the number of days to keep in the Threat Detection audit logs.
- Storage
Account stringAccess Key - Specifies the identifier key of the Threat Detection audit storage account.
- Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
- Disabled
Alerts []string - Specifies a list of alerts which should be disabled. Possible values are
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
andUnsafe_Action
. - Email
Account boolAdmins - Should the account administrators be emailed when this alert is triggered?
- Email
Addresses []string - A list of email addresses which alerts should be sent to.
- Enabled bool
- Is the policy enabled?
- Retention
Days int - Specifies the number of days to keep in the Threat Detection audit logs.
- Storage
Account stringAccess Key - Specifies the identifier key of the Threat Detection audit storage account.
- Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
- disabled
Alerts List<String> - Specifies a list of alerts which should be disabled. Possible values are
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
andUnsafe_Action
. - email
Account BooleanAdmins - Should the account administrators be emailed when this alert is triggered?
- email
Addresses List<String> - A list of email addresses which alerts should be sent to.
- enabled Boolean
- Is the policy enabled?
- retention
Days Integer - Specifies the number of days to keep in the Threat Detection audit logs.
- storage
Account StringAccess Key - Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
- disabled
Alerts string[] - Specifies a list of alerts which should be disabled. Possible values are
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
andUnsafe_Action
. - email
Account booleanAdmins - Should the account administrators be emailed when this alert is triggered?
- email
Addresses string[] - A list of email addresses which alerts should be sent to.
- enabled boolean
- Is the policy enabled?
- retention
Days number - Specifies the number of days to keep in the Threat Detection audit logs.
- storage
Account stringAccess Key - Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
- disabled_
alerts Sequence[str] - Specifies a list of alerts which should be disabled. Possible values are
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
andUnsafe_Action
. - email_
account_ booladmins - Should the account administrators be emailed when this alert is triggered?
- email_
addresses Sequence[str] - A list of email addresses which alerts should be sent to.
- enabled bool
- Is the policy enabled?
- retention_
days int - Specifies the number of days to keep in the Threat Detection audit logs.
- storage_
account_ straccess_ key - Specifies the identifier key of the Threat Detection audit storage account.
- storage_
endpoint str - Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
- disabled
Alerts List<String> - Specifies a list of alerts which should be disabled. Possible values are
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
andUnsafe_Action
. - email
Account BooleanAdmins - Should the account administrators be emailed when this alert is triggered?
- email
Addresses List<String> - A list of email addresses which alerts should be sent to.
- enabled Boolean
- Is the policy enabled?
- retention
Days Number - Specifies the number of days to keep in the Threat Detection audit logs.
- storage
Account StringAccess Key - Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
Import
MySQL Server’s can be imported using the resource id
, e.g.
$ pulumi import azure:mysql/server:Server server1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DBforMySQL/servers/server1
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.