We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages a MS SQL Database.
Note: The Database Extended Auditing Policy can be set inline here, as well as with the mssql_database_extended_auditing_policy resource resource. You can only use one or the other and using both will cause a conflict.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var exampleServer = new Azure.MSSql.Server("exampleServer", new Azure.MSSql.ServerArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
Version = "12.0",
AdministratorLogin = "4dm1n157r470r",
AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
});
var test = new Azure.MSSql.Database("test", new Azure.MSSql.DatabaseArgs
{
ServerId = exampleServer.Id,
Collation = "SQL_Latin1_General_CP1_CI_AS",
LicenseType = "LicenseIncluded",
MaxSizeGb = 4,
ReadScale = true,
SkuName = "BC_Gen5_2",
ZoneRedundant = true,
ExtendedAuditingPolicy = new Azure.MSSql.Inputs.DatabaseExtendedAuditingPolicyArgs
{
StorageEndpoint = exampleAccount.PrimaryBlobEndpoint,
StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
StorageAccountAccessKeyIsSecondary = true,
RetentionInDays = 6,
},
Tags =
{
{ "foo", "bar" },
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/mssql"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
exampleServer, err := mssql.NewServer(ctx, "exampleServer", &mssql.ServerArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
Version: pulumi.String("12.0"),
AdministratorLogin: pulumi.String("4dm1n157r470r"),
AdministratorLoginPassword: pulumi.String("4-v3ry-53cr37-p455w0rd"),
})
if err != nil {
return err
}
_, err = mssql.NewDatabase(ctx, "test", &mssql.DatabaseArgs{
ServerId: exampleServer.ID(),
Collation: pulumi.String("SQL_Latin1_General_CP1_CI_AS"),
LicenseType: pulumi.String("LicenseIncluded"),
MaxSizeGb: pulumi.Int(4),
ReadScale: pulumi.Bool(true),
SkuName: pulumi.String("BC_Gen5_2"),
ZoneRedundant: pulumi.Bool(true),
ExtendedAuditingPolicy: &mssql.DatabaseExtendedAuditingPolicyArgs{
StorageEndpoint: exampleAccount.PrimaryBlobEndpoint,
StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
StorageAccountAccessKeyIsSecondary: pulumi.Bool(true),
RetentionInDays: pulumi.Int(6),
},
Tags: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const exampleServer = new azure.mssql.Server("exampleServer", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
version: "12.0",
administratorLogin: "4dm1n157r470r",
administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const test = new azure.mssql.Database("test", {
serverId: exampleServer.id,
collation: "SQL_Latin1_General_CP1_CI_AS",
licenseType: "LicenseIncluded",
maxSizeGb: 4,
readScale: true,
skuName: "BC_Gen5_2",
zoneRedundant: true,
extendedAuditingPolicy: {
storageEndpoint: exampleAccount.primaryBlobEndpoint,
storageAccountAccessKey: exampleAccount.primaryAccessKey,
storageAccountAccessKeyIsSecondary: true,
retentionInDays: 6,
},
tags: {
foo: "bar",
},
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS")
example_server = azure.mssql.Server("exampleServer",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
version="12.0",
administrator_login="4dm1n157r470r",
administrator_login_password="4-v3ry-53cr37-p455w0rd")
test = azure.mssql.Database("test",
server_id=example_server.id,
collation="SQL_Latin1_General_CP1_CI_AS",
license_type="LicenseIncluded",
max_size_gb=4,
read_scale=True,
sku_name="BC_Gen5_2",
zone_redundant=True,
extended_auditing_policy=azure.mssql.DatabaseExtendedAuditingPolicyArgs(
storage_endpoint=example_account.primary_blob_endpoint,
storage_account_access_key=example_account.primary_access_key,
storage_account_access_key_is_secondary=True,
retention_in_days=6,
),
tags={
"foo": "bar",
})
Example coming soon!
Create Database Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);@overload
def Database(resource_name: str,
args: DatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Database(resource_name: str,
opts: Optional[ResourceOptions] = None,
server_id: Optional[str] = None,
geo_backup_enabled: Optional[bool] = None,
license_type: Optional[str] = None,
creation_source_database_id: Optional[str] = None,
elastic_pool_id: Optional[str] = None,
extended_auditing_policy: Optional[DatabaseExtendedAuditingPolicyArgs] = None,
auto_pause_delay_in_minutes: Optional[int] = None,
read_replica_count: Optional[int] = None,
long_term_retention_policy: Optional[DatabaseLongTermRetentionPolicyArgs] = None,
max_size_gb: Optional[int] = None,
min_capacity: Optional[float] = None,
create_mode: Optional[str] = None,
name: Optional[str] = None,
sample_name: Optional[str] = None,
recover_database_id: Optional[str] = None,
restore_dropped_database_id: Optional[str] = None,
restore_point_in_time: Optional[str] = None,
read_scale: Optional[bool] = None,
collation: Optional[str] = None,
short_term_retention_policy: Optional[DatabaseShortTermRetentionPolicyArgs] = None,
sku_name: Optional[str] = None,
storage_account_type: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
threat_detection_policy: Optional[DatabaseThreatDetectionPolicyArgs] = None,
zone_redundant: Optional[bool] = None)func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)
type: azure:mssql:Database
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 DatabaseArgs
- 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 DatabaseArgs
- 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 DatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabaseArgs
- 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 exampledatabaseResourceResourceFromMssqldatabase = new Azure.MSSql.Database("exampledatabaseResourceResourceFromMssqldatabase", new()
{
ServerId = "string",
GeoBackupEnabled = false,
LicenseType = "string",
CreationSourceDatabaseId = "string",
ElasticPoolId = "string",
AutoPauseDelayInMinutes = 0,
ReadReplicaCount = 0,
LongTermRetentionPolicy = new Azure.MSSql.Inputs.DatabaseLongTermRetentionPolicyArgs
{
MonthlyRetention = "string",
WeekOfYear = 0,
WeeklyRetention = "string",
YearlyRetention = "string",
},
MaxSizeGb = 0,
MinCapacity = 0,
CreateMode = "string",
Name = "string",
SampleName = "string",
RecoverDatabaseId = "string",
RestoreDroppedDatabaseId = "string",
RestorePointInTime = "string",
ReadScale = false,
Collation = "string",
ShortTermRetentionPolicy = new Azure.MSSql.Inputs.DatabaseShortTermRetentionPolicyArgs
{
RetentionDays = 0,
},
SkuName = "string",
StorageAccountType = "string",
Tags =
{
{ "string", "string" },
},
ThreatDetectionPolicy = new Azure.MSSql.Inputs.DatabaseThreatDetectionPolicyArgs
{
DisabledAlerts = new[]
{
"string",
},
EmailAccountAdmins = "string",
EmailAddresses = new[]
{
"string",
},
RetentionDays = 0,
State = "string",
StorageAccountAccessKey = "string",
StorageEndpoint = "string",
},
ZoneRedundant = false,
});
example, err := mssql.NewDatabase(ctx, "exampledatabaseResourceResourceFromMssqldatabase", &mssql.DatabaseArgs{
ServerId: pulumi.String("string"),
GeoBackupEnabled: pulumi.Bool(false),
LicenseType: pulumi.String("string"),
CreationSourceDatabaseId: pulumi.String("string"),
ElasticPoolId: pulumi.String("string"),
AutoPauseDelayInMinutes: pulumi.Int(0),
ReadReplicaCount: pulumi.Int(0),
LongTermRetentionPolicy: &mssql.DatabaseLongTermRetentionPolicyArgs{
MonthlyRetention: pulumi.String("string"),
WeekOfYear: pulumi.Int(0),
WeeklyRetention: pulumi.String("string"),
YearlyRetention: pulumi.String("string"),
},
MaxSizeGb: pulumi.Int(0),
MinCapacity: pulumi.Float64(0),
CreateMode: pulumi.String("string"),
Name: pulumi.String("string"),
SampleName: pulumi.String("string"),
RecoverDatabaseId: pulumi.String("string"),
RestoreDroppedDatabaseId: pulumi.String("string"),
RestorePointInTime: pulumi.String("string"),
ReadScale: pulumi.Bool(false),
Collation: pulumi.String("string"),
ShortTermRetentionPolicy: &mssql.DatabaseShortTermRetentionPolicyArgs{
RetentionDays: pulumi.Int(0),
},
SkuName: pulumi.String("string"),
StorageAccountType: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ThreatDetectionPolicy: &mssql.DatabaseThreatDetectionPolicyArgs{
DisabledAlerts: pulumi.StringArray{
pulumi.String("string"),
},
EmailAccountAdmins: pulumi.String("string"),
EmailAddresses: pulumi.StringArray{
pulumi.String("string"),
},
RetentionDays: pulumi.Int(0),
State: pulumi.String("string"),
StorageAccountAccessKey: pulumi.String("string"),
StorageEndpoint: pulumi.String("string"),
},
ZoneRedundant: pulumi.Bool(false),
})
var exampledatabaseResourceResourceFromMssqldatabase = new com.pulumi.azure.mssql.Database("exampledatabaseResourceResourceFromMssqldatabase", com.pulumi.azure.mssql.DatabaseArgs.builder()
.serverId("string")
.geoBackupEnabled(false)
.licenseType("string")
.creationSourceDatabaseId("string")
.elasticPoolId("string")
.autoPauseDelayInMinutes(0)
.readReplicaCount(0)
.longTermRetentionPolicy(DatabaseLongTermRetentionPolicyArgs.builder()
.monthlyRetention("string")
.weekOfYear(0)
.weeklyRetention("string")
.yearlyRetention("string")
.build())
.maxSizeGb(0)
.minCapacity(0.0)
.createMode("string")
.name("string")
.sampleName("string")
.recoverDatabaseId("string")
.restoreDroppedDatabaseId("string")
.restorePointInTime("string")
.readScale(false)
.collation("string")
.shortTermRetentionPolicy(DatabaseShortTermRetentionPolicyArgs.builder()
.retentionDays(0)
.build())
.skuName("string")
.storageAccountType("string")
.tags(Map.of("string", "string"))
.threatDetectionPolicy(DatabaseThreatDetectionPolicyArgs.builder()
.disabledAlerts("string")
.emailAccountAdmins("string")
.emailAddresses("string")
.retentionDays(0)
.state("string")
.storageAccountAccessKey("string")
.storageEndpoint("string")
.build())
.zoneRedundant(false)
.build());
exampledatabase_resource_resource_from_mssqldatabase = azure.mssql.Database("exampledatabaseResourceResourceFromMssqldatabase",
server_id="string",
geo_backup_enabled=False,
license_type="string",
creation_source_database_id="string",
elastic_pool_id="string",
auto_pause_delay_in_minutes=0,
read_replica_count=0,
long_term_retention_policy={
"monthly_retention": "string",
"week_of_year": 0,
"weekly_retention": "string",
"yearly_retention": "string",
},
max_size_gb=0,
min_capacity=0,
create_mode="string",
name="string",
sample_name="string",
recover_database_id="string",
restore_dropped_database_id="string",
restore_point_in_time="string",
read_scale=False,
collation="string",
short_term_retention_policy={
"retention_days": 0,
},
sku_name="string",
storage_account_type="string",
tags={
"string": "string",
},
threat_detection_policy={
"disabled_alerts": ["string"],
"email_account_admins": "string",
"email_addresses": ["string"],
"retention_days": 0,
"state": "string",
"storage_account_access_key": "string",
"storage_endpoint": "string",
},
zone_redundant=False)
const exampledatabaseResourceResourceFromMssqldatabase = new azure.mssql.Database("exampledatabaseResourceResourceFromMssqldatabase", {
serverId: "string",
geoBackupEnabled: false,
licenseType: "string",
creationSourceDatabaseId: "string",
elasticPoolId: "string",
autoPauseDelayInMinutes: 0,
readReplicaCount: 0,
longTermRetentionPolicy: {
monthlyRetention: "string",
weekOfYear: 0,
weeklyRetention: "string",
yearlyRetention: "string",
},
maxSizeGb: 0,
minCapacity: 0,
createMode: "string",
name: "string",
sampleName: "string",
recoverDatabaseId: "string",
restoreDroppedDatabaseId: "string",
restorePointInTime: "string",
readScale: false,
collation: "string",
shortTermRetentionPolicy: {
retentionDays: 0,
},
skuName: "string",
storageAccountType: "string",
tags: {
string: "string",
},
threatDetectionPolicy: {
disabledAlerts: ["string"],
emailAccountAdmins: "string",
emailAddresses: ["string"],
retentionDays: 0,
state: "string",
storageAccountAccessKey: "string",
storageEndpoint: "string",
},
zoneRedundant: false,
});
type: azure:mssql:Database
properties:
autoPauseDelayInMinutes: 0
collation: string
createMode: string
creationSourceDatabaseId: string
elasticPoolId: string
geoBackupEnabled: false
licenseType: string
longTermRetentionPolicy:
monthlyRetention: string
weekOfYear: 0
weeklyRetention: string
yearlyRetention: string
maxSizeGb: 0
minCapacity: 0
name: string
readReplicaCount: 0
readScale: false
recoverDatabaseId: string
restoreDroppedDatabaseId: string
restorePointInTime: string
sampleName: string
serverId: string
shortTermRetentionPolicy:
retentionDays: 0
skuName: string
storageAccountType: string
tags:
string: string
threatDetectionPolicy:
disabledAlerts:
- string
emailAccountAdmins: string
emailAddresses:
- string
retentionDays: 0
state: string
storageAccountAccessKey: string
storageEndpoint: string
zoneRedundant: false
Database Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Database resource accepts the following input properties:
- Server
Id string - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- Auto
Pause intDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - Collation string
- Specifies the collation of the database. Changing this forces a new resource to be created.
- Create
Mode string - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - Creation
Source stringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - Elastic
Pool stringId - Specifies the ID of the elastic pool containing this database.
- Extended
Auditing DatabasePolicy Extended Auditing Policy - A
extended_auditing_policyblock as defined below. - Geo
Backup boolEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- License
Type string - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - Long
Term DatabaseRetention Policy Long Term Retention Policy - A
long_term_retention_policyblock as defined below. - Max
Size intGb - The max size of the database in gigabytes.
- Min
Capacity double - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- Name string
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- Read
Replica intCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- Read
Scale bool - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- Recover
Database stringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - Restore
Dropped stringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - Restore
Point stringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - Sample
Name string - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - Short
Term DatabaseRetention Policy Short Term Retention Policy - A
short_term_retention_policyblock as defined below. - Sku
Name string - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - Storage
Account stringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Threat
Detection DatabasePolicy Threat Detection Policy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - Zone
Redundant bool - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- Server
Id string - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- Auto
Pause intDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - Collation string
- Specifies the collation of the database. Changing this forces a new resource to be created.
- Create
Mode string - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - Creation
Source stringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - Elastic
Pool stringId - Specifies the ID of the elastic pool containing this database.
- Extended
Auditing DatabasePolicy Extended Auditing Policy Type Args - A
extended_auditing_policyblock as defined below. - Geo
Backup boolEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- License
Type string - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - Long
Term DatabaseRetention Policy Long Term Retention Policy Args - A
long_term_retention_policyblock as defined below. - Max
Size intGb - The max size of the database in gigabytes.
- Min
Capacity float64 - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- Name string
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- Read
Replica intCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- Read
Scale bool - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- Recover
Database stringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - Restore
Dropped stringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - Restore
Point stringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - Sample
Name string - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - Short
Term DatabaseRetention Policy Short Term Retention Policy Args - A
short_term_retention_policyblock as defined below. - Sku
Name string - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - Storage
Account stringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - map[string]string
- A mapping of tags to assign to the resource.
- Threat
Detection DatabasePolicy Threat Detection Policy Args - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - Zone
Redundant bool - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- server
Id String - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- auto
Pause IntegerDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation String
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create
Mode String - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation
Source StringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic
Pool StringId - Specifies the ID of the elastic pool containing this database.
- extended
Auditing DatabasePolicy Extended Auditing Policy - A
extended_auditing_policyblock as defined below. - geo
Backup BooleanEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license
Type String - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long
Term DatabaseRetention Policy Long Term Retention Policy - A
long_term_retention_policyblock as defined below. - max
Size IntegerGb - The max size of the database in gigabytes.
- min
Capacity Double - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name String
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read
Replica IntegerCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read
Scale Boolean - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover
Database StringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore
Dropped StringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore
Point StringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample
Name String - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - short
Term DatabaseRetention Policy Short Term Retention Policy - A
short_term_retention_policyblock as defined below. - sku
Name String - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage
Account StringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Map<String,String>
- A mapping of tags to assign to the resource.
- threat
Detection DatabasePolicy Threat Detection Policy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone
Redundant Boolean - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- server
Id string - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- auto
Pause numberDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation string
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create
Mode string - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation
Source stringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic
Pool stringId - Specifies the ID of the elastic pool containing this database.
- extended
Auditing DatabasePolicy Extended Auditing Policy - A
extended_auditing_policyblock as defined below. - geo
Backup booleanEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license
Type string - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long
Term DatabaseRetention Policy Long Term Retention Policy - A
long_term_retention_policyblock as defined below. - max
Size numberGb - The max size of the database in gigabytes.
- min
Capacity number - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name string
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read
Replica numberCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read
Scale boolean - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover
Database stringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore
Dropped stringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore
Point stringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample
Name string - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - short
Term DatabaseRetention Policy Short Term Retention Policy - A
short_term_retention_policyblock as defined below. - sku
Name string - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage
Account stringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- threat
Detection DatabasePolicy Threat Detection Policy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone
Redundant boolean - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- server_
id str - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- auto_
pause_ intdelay_ in_ minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation str
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create_
mode str - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation_
source_ strdatabase_ id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic_
pool_ strid - Specifies the ID of the elastic pool containing this database.
- extended_
auditing_ Databasepolicy Extended Auditing Policy Args - A
extended_auditing_policyblock as defined below. - geo_
backup_ boolenabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license_
type str - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long_
term_ Databaseretention_ policy Long Term Retention Policy Args - A
long_term_retention_policyblock as defined below. - max_
size_ intgb - The max size of the database in gigabytes.
- min_
capacity float - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name str
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read_
replica_ intcount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read_
scale bool - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover_
database_ strid - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore_
dropped_ strdatabase_ id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore_
point_ strin_ time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample_
name str - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - short_
term_ Databaseretention_ policy Short Term Retention Policy Args - A
short_term_retention_policyblock as defined below. - sku_
name str - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage_
account_ strtype - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- threat_
detection_ Databasepolicy Threat Detection Policy Args - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone_
redundant bool - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- server
Id String - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- auto
Pause NumberDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation String
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create
Mode String - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation
Source StringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic
Pool StringId - Specifies the ID of the elastic pool containing this database.
- extended
Auditing Property MapPolicy - A
extended_auditing_policyblock as defined below. - geo
Backup BooleanEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license
Type String - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long
Term Property MapRetention Policy - A
long_term_retention_policyblock as defined below. - max
Size NumberGb - The max size of the database in gigabytes.
- min
Capacity Number - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name String
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read
Replica NumberCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read
Scale Boolean - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover
Database StringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore
Dropped StringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore
Point StringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample
Name String - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - short
Term Property MapRetention Policy - A
short_term_retention_policyblock as defined below. - sku
Name String - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage
Account StringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Map<String>
- A mapping of tags to assign to the resource.
- threat
Detection Property MapPolicy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone
Redundant Boolean - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
Outputs
All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Database Resource
Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_pause_delay_in_minutes: Optional[int] = None,
collation: Optional[str] = None,
create_mode: Optional[str] = None,
creation_source_database_id: Optional[str] = None,
elastic_pool_id: Optional[str] = None,
extended_auditing_policy: Optional[DatabaseExtendedAuditingPolicyArgs] = None,
geo_backup_enabled: Optional[bool] = None,
license_type: Optional[str] = None,
long_term_retention_policy: Optional[DatabaseLongTermRetentionPolicyArgs] = None,
max_size_gb: Optional[int] = None,
min_capacity: Optional[float] = None,
name: Optional[str] = None,
read_replica_count: Optional[int] = None,
read_scale: Optional[bool] = None,
recover_database_id: Optional[str] = None,
restore_dropped_database_id: Optional[str] = None,
restore_point_in_time: Optional[str] = None,
sample_name: Optional[str] = None,
server_id: Optional[str] = None,
short_term_retention_policy: Optional[DatabaseShortTermRetentionPolicyArgs] = None,
sku_name: Optional[str] = None,
storage_account_type: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
threat_detection_policy: Optional[DatabaseThreatDetectionPolicyArgs] = None,
zone_redundant: Optional[bool] = None) -> Databasefunc GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)resources: _: type: azure:mssql:Database get: id: ${id}- 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.
- Auto
Pause intDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - Collation string
- Specifies the collation of the database. Changing this forces a new resource to be created.
- Create
Mode string - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - Creation
Source stringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - Elastic
Pool stringId - Specifies the ID of the elastic pool containing this database.
- Extended
Auditing DatabasePolicy Extended Auditing Policy - A
extended_auditing_policyblock as defined below. - Geo
Backup boolEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- License
Type string - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - Long
Term DatabaseRetention Policy Long Term Retention Policy - A
long_term_retention_policyblock as defined below. - Max
Size intGb - The max size of the database in gigabytes.
- Min
Capacity double - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- Name string
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- Read
Replica intCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- Read
Scale bool - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- Recover
Database stringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - Restore
Dropped stringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - Restore
Point stringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - Sample
Name string - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - Server
Id string - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- Short
Term DatabaseRetention Policy Short Term Retention Policy - A
short_term_retention_policyblock as defined below. - Sku
Name string - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - Storage
Account stringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Threat
Detection DatabasePolicy Threat Detection Policy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - Zone
Redundant bool - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- Auto
Pause intDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - Collation string
- Specifies the collation of the database. Changing this forces a new resource to be created.
- Create
Mode string - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - Creation
Source stringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - Elastic
Pool stringId - Specifies the ID of the elastic pool containing this database.
- Extended
Auditing DatabasePolicy Extended Auditing Policy Type Args - A
extended_auditing_policyblock as defined below. - Geo
Backup boolEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- License
Type string - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - Long
Term DatabaseRetention Policy Long Term Retention Policy Args - A
long_term_retention_policyblock as defined below. - Max
Size intGb - The max size of the database in gigabytes.
- Min
Capacity float64 - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- Name string
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- Read
Replica intCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- Read
Scale bool - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- Recover
Database stringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - Restore
Dropped stringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - Restore
Point stringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - Sample
Name string - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - Server
Id string - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- Short
Term DatabaseRetention Policy Short Term Retention Policy Args - A
short_term_retention_policyblock as defined below. - Sku
Name string - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - Storage
Account stringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - map[string]string
- A mapping of tags to assign to the resource.
- Threat
Detection DatabasePolicy Threat Detection Policy Args - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - Zone
Redundant bool - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- auto
Pause IntegerDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation String
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create
Mode String - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation
Source StringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic
Pool StringId - Specifies the ID of the elastic pool containing this database.
- extended
Auditing DatabasePolicy Extended Auditing Policy - A
extended_auditing_policyblock as defined below. - geo
Backup BooleanEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license
Type String - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long
Term DatabaseRetention Policy Long Term Retention Policy - A
long_term_retention_policyblock as defined below. - max
Size IntegerGb - The max size of the database in gigabytes.
- min
Capacity Double - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name String
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read
Replica IntegerCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read
Scale Boolean - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover
Database StringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore
Dropped StringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore
Point StringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample
Name String - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - server
Id String - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- short
Term DatabaseRetention Policy Short Term Retention Policy - A
short_term_retention_policyblock as defined below. - sku
Name String - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage
Account StringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Map<String,String>
- A mapping of tags to assign to the resource.
- threat
Detection DatabasePolicy Threat Detection Policy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone
Redundant Boolean - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- auto
Pause numberDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation string
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create
Mode string - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation
Source stringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic
Pool stringId - Specifies the ID of the elastic pool containing this database.
- extended
Auditing DatabasePolicy Extended Auditing Policy - A
extended_auditing_policyblock as defined below. - geo
Backup booleanEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license
Type string - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long
Term DatabaseRetention Policy Long Term Retention Policy - A
long_term_retention_policyblock as defined below. - max
Size numberGb - The max size of the database in gigabytes.
- min
Capacity number - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name string
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read
Replica numberCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read
Scale boolean - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover
Database stringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore
Dropped stringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore
Point stringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample
Name string - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - server
Id string - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- short
Term DatabaseRetention Policy Short Term Retention Policy - A
short_term_retention_policyblock as defined below. - sku
Name string - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage
Account stringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- threat
Detection DatabasePolicy Threat Detection Policy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone
Redundant boolean - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- auto_
pause_ intdelay_ in_ minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation str
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create_
mode str - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation_
source_ strdatabase_ id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic_
pool_ strid - Specifies the ID of the elastic pool containing this database.
- extended_
auditing_ Databasepolicy Extended Auditing Policy Args - A
extended_auditing_policyblock as defined below. - geo_
backup_ boolenabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license_
type str - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long_
term_ Databaseretention_ policy Long Term Retention Policy Args - A
long_term_retention_policyblock as defined below. - max_
size_ intgb - The max size of the database in gigabytes.
- min_
capacity float - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name str
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read_
replica_ intcount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read_
scale bool - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover_
database_ strid - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore_
dropped_ strdatabase_ id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore_
point_ strin_ time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample_
name str - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - server_
id str - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- short_
term_ Databaseretention_ policy Short Term Retention Policy Args - A
short_term_retention_policyblock as defined below. - sku_
name str - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage_
account_ strtype - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- threat_
detection_ Databasepolicy Threat Detection Policy Args - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone_
redundant bool - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
- auto
Pause NumberDelay In Minutes - Time in minutes after which database is automatically paused. A value of
-1means that automatic pause is disabled. This property is only settable for General Purpose Serverless databases. - collation String
- Specifies the collation of the database. Changing this forces a new resource to be created.
- create
Mode String - The create mode of the database. Possible values are
Copy,Default,OnlineSecondary,PointInTimeRestore,Recovery,Restore,RestoreExternalBackup,RestoreExternalBackupSecondary,RestoreLongTermRetentionBackupandSecondary. - creation
Source StringDatabase Id - The ID of the source database from which to create the new database. This should only be used for databases with
create_modevalues that use another database as reference. Changing this forces a new resource to be created. - elastic
Pool StringId - Specifies the ID of the elastic pool containing this database.
- extended
Auditing Property MapPolicy - A
extended_auditing_policyblock as defined below. - geo
Backup BooleanEnabled - A boolean that specifies if the Geo Backup Policy is enabled.
- license
Type String - Specifies the license type applied to this database. Possible values are
LicenseIncludedandBasePrice. - long
Term Property MapRetention Policy - A
long_term_retention_policyblock as defined below. - max
Size NumberGb - The max size of the database in gigabytes.
- min
Capacity Number - Minimal capacity that database will always have allocated, if not paused. This property is only settable for General Purpose Serverless databases.
- name String
- The name of the Ms SQL Database. Changing this forces a new resource to be created.
- read
Replica NumberCount - The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
- read
Scale Boolean - If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.
- recover
Database StringId - The ID of the database to be recovered. This property is only applicable when the
create_modeisRecovery. - restore
Dropped StringDatabase Id - The ID of the database to be restored. This property is only applicable when the
create_modeisRestore. - restore
Point StringIn Time - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. This property is only settable for
create_mode=PointInTimeRestoredatabases. - sample
Name String - Specifies the name of the sample schema to apply when creating this database. Possible value is
AdventureWorksLT. - server
Id String - The id of the Ms SQL Server on which to create the database. Changing this forces a new resource to be created.
- short
Term Property MapRetention Policy - A
short_term_retention_policyblock as defined below. - sku
Name String - Specifies the name of the SKU used by the database. For example,
GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2,ElasticPool,Basic,S0,P2,DW100c,DS100. Changing this from the HyperScale service tier to another service tier will force a new resource to be created. - storage
Account StringType - Specifies the storage account type used to store backups for this database. Changing this forces a new resource to be created. Possible values are
GRS,LRSandZRS. The default value isGRS. - Map<String>
- A mapping of tags to assign to the resource.
- threat
Detection Property MapPolicy - Threat detection policy configuration. The
threat_detection_policyblock supports fields documented below. - zone
Redundant Boolean - Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.
Supporting Types
DatabaseExtendedAuditingPolicy, DatabaseExtendedAuditingPolicyArgs
- Log
Monitoring boolEnabled - Retention
In intDays - Specifies the number of days to retain logs for in the storage account.
- Storage
Account stringAccess Key - Specifies the access key to use for the auditing storage account.
- Storage
Account boolAccess Key Is Secondary - Specifies whether
storage_account_access_keyvalue is the storage's secondary key. - Storage
Account stringSubscription Id - Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
- Log
Monitoring boolEnabled - Retention
In intDays - Specifies the number of days to retain logs for in the storage account.
- Storage
Account stringAccess Key - Specifies the access key to use for the auditing storage account.
- Storage
Account boolAccess Key Is Secondary - Specifies whether
storage_account_access_keyvalue is the storage's secondary key. - Storage
Account stringSubscription Id - Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
- log
Monitoring BooleanEnabled - retention
In IntegerDays - Specifies the number of days to retain logs for in the storage account.
- storage
Account StringAccess Key - Specifies the access key to use for the auditing storage account.
- storage
Account BooleanAccess Key Is Secondary - Specifies whether
storage_account_access_keyvalue is the storage's secondary key. - storage
Account StringSubscription Id - storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
- log
Monitoring booleanEnabled - retention
In numberDays - Specifies the number of days to retain logs for in the storage account.
- storage
Account stringAccess Key - Specifies the access key to use for the auditing storage account.
- storage
Account booleanAccess Key Is Secondary - Specifies whether
storage_account_access_keyvalue is the storage's secondary key. - storage
Account stringSubscription Id - storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
- log_
monitoring_ boolenabled - retention_
in_ intdays - Specifies the number of days to retain logs for in the storage account.
- storage_
account_ straccess_ key - Specifies the access key to use for the auditing storage account.
- storage_
account_ boolaccess_ key_ is_ secondary - Specifies whether
storage_account_access_keyvalue is the storage's secondary key. - storage_
account_ strsubscription_ id - storage_
endpoint str - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
- log
Monitoring BooleanEnabled - retention
In NumberDays - Specifies the number of days to retain logs for in the storage account.
- storage
Account StringAccess Key - Specifies the access key to use for the auditing storage account.
- storage
Account BooleanAccess Key Is Secondary - Specifies whether
storage_account_access_keyvalue is the storage's secondary key. - storage
Account StringSubscription Id - storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
DatabaseLongTermRetentionPolicy, DatabaseLongTermRetentionPolicyArgs
- Monthly
Retention string - The monthly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 120 months. e.g.
P1Y,P1M,P4WorP30D. - Week
Of intYear - The week of year to take the yearly backup in an ISO 8601 format. Value has to be between
1and52. - Weekly
Retention string - The weekly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 520 weeks. e.g.
P1Y,P1M,P1WorP7D. - Yearly
Retention string - The yearly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 10 years. e.g.
P1Y,P12M,P52WorP365D.
- Monthly
Retention string - The monthly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 120 months. e.g.
P1Y,P1M,P4WorP30D. - Week
Of intYear - The week of year to take the yearly backup in an ISO 8601 format. Value has to be between
1and52. - Weekly
Retention string - The weekly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 520 weeks. e.g.
P1Y,P1M,P1WorP7D. - Yearly
Retention string - The yearly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 10 years. e.g.
P1Y,P12M,P52WorP365D.
- monthly
Retention String - The monthly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 120 months. e.g.
P1Y,P1M,P4WorP30D. - week
Of IntegerYear - The week of year to take the yearly backup in an ISO 8601 format. Value has to be between
1and52. - weekly
Retention String - The weekly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 520 weeks. e.g.
P1Y,P1M,P1WorP7D. - yearly
Retention String - The yearly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 10 years. e.g.
P1Y,P12M,P52WorP365D.
- monthly
Retention string - The monthly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 120 months. e.g.
P1Y,P1M,P4WorP30D. - week
Of numberYear - The week of year to take the yearly backup in an ISO 8601 format. Value has to be between
1and52. - weekly
Retention string - The weekly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 520 weeks. e.g.
P1Y,P1M,P1WorP7D. - yearly
Retention string - The yearly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 10 years. e.g.
P1Y,P12M,P52WorP365D.
- monthly_
retention str - The monthly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 120 months. e.g.
P1Y,P1M,P4WorP30D. - week_
of_ intyear - The week of year to take the yearly backup in an ISO 8601 format. Value has to be between
1and52. - weekly_
retention str - The weekly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 520 weeks. e.g.
P1Y,P1M,P1WorP7D. - yearly_
retention str - The yearly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 10 years. e.g.
P1Y,P12M,P52WorP365D.
- monthly
Retention String - The monthly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 120 months. e.g.
P1Y,P1M,P4WorP30D. - week
Of NumberYear - The week of year to take the yearly backup in an ISO 8601 format. Value has to be between
1and52. - weekly
Retention String - The weekly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 520 weeks. e.g.
P1Y,P1M,P1WorP7D. - yearly
Retention String - The yearly retention policy for an LTR backup in an ISO 8601 format. Valid value is between 1 to 10 years. e.g.
P1Y,P12M,P52WorP365D.
DatabaseShortTermRetentionPolicy, DatabaseShortTermRetentionPolicyArgs
- Retention
Days int - Point In Time Restore configuration. Value has to be between
7and35.
- Retention
Days int - Point In Time Restore configuration. Value has to be between
7and35.
- retention
Days Integer - Point In Time Restore configuration. Value has to be between
7and35.
- retention
Days number - Point In Time Restore configuration. Value has to be between
7and35.
- retention_
days int - Point In Time Restore configuration. Value has to be between
7and35.
- retention
Days Number - Point In Time Restore configuration. Value has to be between
7and35.
DatabaseThreatDetectionPolicy, DatabaseThreatDetectionPolicyArgs
- Disabled
Alerts List<string> - Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly,Sql_InjectionandSql_Injection_Vulnerability. - Email
Account stringAdmins - 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.
- Retention
Days int - Specifies the number of days to keep in the Threat Detection audit logs.
- State string
- The State of the Policy. Possible values are
Enabled,DisabledorNew. - Storage
Account stringAccess Key - Specifies the identifier key of the Threat Detection audit storage account. Required if
stateisEnabled. - Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if
stateisEnabled. - Use
Server stringDefault
- Disabled
Alerts []string - Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly,Sql_InjectionandSql_Injection_Vulnerability. - Email
Account stringAdmins - 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.
- Retention
Days int - Specifies the number of days to keep in the Threat Detection audit logs.
- State string
- The State of the Policy. Possible values are
Enabled,DisabledorNew. - Storage
Account stringAccess Key - Specifies the identifier key of the Threat Detection audit storage account. Required if
stateisEnabled. - Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if
stateisEnabled. - Use
Server stringDefault
- disabled
Alerts List<String> - Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly,Sql_InjectionandSql_Injection_Vulnerability. - email
Account StringAdmins - 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.
- retention
Days Integer - Specifies the number of days to keep in the Threat Detection audit logs.
- state String
- The State of the Policy. Possible values are
Enabled,DisabledorNew. - storage
Account StringAccess Key - Specifies the identifier key of the Threat Detection audit storage account. Required if
stateisEnabled. - storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if
stateisEnabled. - use
Server StringDefault
- disabled
Alerts string[] - Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly,Sql_InjectionandSql_Injection_Vulnerability. - email
Account stringAdmins - 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.
- retention
Days number - Specifies the number of days to keep in the Threat Detection audit logs.
- state string
- The State of the Policy. Possible values are
Enabled,DisabledorNew. - storage
Account stringAccess Key - Specifies the identifier key of the Threat Detection audit storage account. Required if
stateisEnabled. - storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if
stateisEnabled. - use
Server stringDefault
- disabled_
alerts Sequence[str] - Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly,Sql_InjectionandSql_Injection_Vulnerability. - email_
account_ stradmins - 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.
- retention_
days int - Specifies the number of days to keep in the Threat Detection audit logs.
- state str
- The State of the Policy. Possible values are
Enabled,DisabledorNew. - storage_
account_ straccess_ key - Specifies the identifier key of the Threat Detection audit storage account. Required if
stateisEnabled. - storage_
endpoint str - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if
stateisEnabled. - use_
server_ strdefault
- disabled
Alerts List<String> - Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly,Sql_InjectionandSql_Injection_Vulnerability. - email
Account StringAdmins - 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.
- retention
Days Number - Specifies the number of days to keep in the Threat Detection audit logs.
- state String
- The State of the Policy. Possible values are
Enabled,DisabledorNew. - storage
Account StringAccess Key - Specifies the identifier key of the Threat Detection audit storage account. Required if
stateisEnabled. - storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if
stateisEnabled. - use
Server StringDefault
Import
SQL Database can be imported using the resource id, e.g.
$ pulumi import azure:mssql/database:Database example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/example1
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
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi