← All packages

Azure Classic

Pulumi Official

Package maintained by Pulumi

v5.5.0 published on Wednesday, May 4, 2022 by Pulumi

Source code

Database

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

Coming soon!

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.getName())
            .location(exampleResourceGroup.getLocation())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleServer = new Server("exampleServer", ServerArgs.builder()        
            .resourceGroupName(exampleResourceGroup.getName())
            .location(exampleResourceGroup.getLocation())
            .version("12.0")
            .administratorLogin("4dm1n157r470r")
            .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
            .build());

        var test = new Database("test", DatabaseArgs.builder()        
            .serverId(exampleServer.getId())
            .collation("SQL_Latin1_General_CP1_CI_AS")
            .licenseType("LicenseIncluded")
            .maxSizeGb(4)
            .readScale(true)
            .skuName("S0")
            .zoneRedundant(true)
            .extendedAuditingPolicy(Map.ofEntries(
                Map.entry("storageEndpoint", exampleAccount.getPrimaryBlobEndpoint()),
                Map.entry("storageAccountAccessKey", exampleAccount.getPrimaryAccessKey()),
                Map.entry("storageAccountAccessKeyIsSecondary", true),
                Map.entry("retentionInDays", 6)
            ))
            .tags(Map.of("foo", "bar"))
            .build());

        }
}

Coming soon!

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleServer:
    type: azure:mssql:Server
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      version: 12.0
      administratorLogin: 4dm1n157r470r
      administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
  test:
    type: azure:mssql:Database
    properties:
      serverId: ${exampleServer.id}
      collation: SQL_Latin1_General_CP1_CI_AS
      licenseType: LicenseIncluded
      maxSizeGb: 4
      readScale: true
      skuName: S0
      zoneRedundant: true
      extendedAuditingPolicy:
        - storageEndpoint: ${exampleAccount.primaryBlobEndpoint}
          storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
          storageAccountAccessKeyIsSecondary: true
          retentionInDays: 6
      tags:
        foo: bar

Create a Database Resource

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

@overload
def Database(resource_name: 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,
             geo_backup_enabled: Optional[bool] = None,
             ledger_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,
             transparent_data_encryption_enabled: Optional[bool] = None,
             zone_redundant: Optional[bool] = None)
@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = 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.

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.

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

The Database resource accepts the following input properties:

ServerId string: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
AutoPauseDelayInMinutes int: Time in minutes after which database is automatically paused. A value of -1 means 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.
CreateMode string: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
ElasticPoolId string: Specifies the ID of the elastic pool containing this database.
GeoBackupEnabled bool: A boolean that specifies if the Geo Backup Policy is enabled.
LedgerEnabled bool: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
LongTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
MaxSizeGb int: The max size of the database in gigabytes.
MinCapacity 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.
ReadReplicaCount int: 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.
ReadScale 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.
RecoverDatabaseId string: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
RestoreDroppedDatabaseId string: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
RestorePointInTime string: 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= PointInTimeRestore databases.
SampleName string: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
ShortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
SkuName 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.
StorageAccountType string: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
ThreatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
TransparentDataEncryptionEnabled bool
ZoneRedundant 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.

ServerId string: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
AutoPauseDelayInMinutes int: Time in minutes after which database is automatically paused. A value of -1 means 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.
CreateMode string: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
ElasticPoolId string: Specifies the ID of the elastic pool containing this database.
GeoBackupEnabled bool: A boolean that specifies if the Geo Backup Policy is enabled.
LedgerEnabled bool: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
LongTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
MaxSizeGb int: The max size of the database in gigabytes.
MinCapacity 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.
ReadReplicaCount int: 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.
ReadScale 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.
RecoverDatabaseId string: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
RestoreDroppedDatabaseId string: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
RestorePointInTime string: 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= PointInTimeRestore databases.
SampleName string: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
ShortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
SkuName 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.
StorageAccountType string: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
Tags map[string]string: A mapping of tags to assign to the resource.
ThreatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
TransparentDataEncryptionEnabled bool
ZoneRedundant 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.

serverId String: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
autoPauseDelayInMinutes Integer: Time in minutes after which database is automatically paused. A value of -1 means 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.
createMode String: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId String: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elasticPoolId String: Specifies the ID of the elastic pool containing this database.
geoBackupEnabled Boolean: A boolean that specifies if the Geo Backup Policy is enabled.
ledgerEnabled Boolean: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
licenseType String: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
longTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
maxSizeGb Integer: The max size of the database in gigabytes.
minCapacity 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.
readReplicaCount Integer: 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.
readScale 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.
recoverDatabaseId String: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restoreDroppedDatabaseId String: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restorePointInTime String: 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= PointInTimeRestore databases.
sampleName String: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
shortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
skuName 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.
storageAccountType String: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags Map: A mapping of tags to assign to the resource.
threatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparentDataEncryptionEnabled Boolean
zoneRedundant 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.

serverId string: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
autoPauseDelayInMinutes number: Time in minutes after which database is automatically paused. A value of -1 means 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.
createMode string: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId string: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elasticPoolId string: Specifies the ID of the elastic pool containing this database.
geoBackupEnabled boolean: A boolean that specifies if the Geo Backup Policy is enabled.
ledgerEnabled boolean: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
licenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
longTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
maxSizeGb number: The max size of the database in gigabytes.
minCapacity 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.
readReplicaCount number: 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.
readScale 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.
recoverDatabaseId string: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restoreDroppedDatabaseId string: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restorePointInTime string: 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= PointInTimeRestore databases.
sampleName string: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
shortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
skuName 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.
storageAccountType string: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
threatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparentDataEncryptionEnabled boolean
zoneRedundant 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_delay_in_minutes int: Time in minutes after which database is automatically paused. A value of -1 means 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, RestoreLongTermRetentionBackup and Secondary.
creation_source_database_id str: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elastic_pool_id str: Specifies the ID of the elastic pool containing this database.
geo_backup_enabled bool: A boolean that specifies if the Geo Backup Policy is enabled.
ledger_enabled bool: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
license_type str: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
long_term_retention_policy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
max_size_gb int: 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_count int: 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_id str: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restore_dropped_database_id str: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restore_point_in_time str: 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= PointInTimeRestore databases.
sample_name str: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
short_term_retention_policy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block 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_type str: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
threat_detection_policy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparent_data_encryption_enabled bool
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.

serverId String: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
autoPauseDelayInMinutes Number: Time in minutes after which database is automatically paused. A value of -1 means 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.
createMode String: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId String: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elasticPoolId String: Specifies the ID of the elastic pool containing this database.
geoBackupEnabled Boolean: A boolean that specifies if the Geo Backup Policy is enabled.
ledgerEnabled Boolean: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
licenseType String: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
longTermRetentionPolicy Property Map: A long_term_retention_policy block as defined below.
maxSizeGb Number: The max size of the database in gigabytes.
minCapacity 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.
readReplicaCount Number: 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.
readScale 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.
recoverDatabaseId String: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restoreDroppedDatabaseId String: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restorePointInTime String: 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= PointInTimeRestore databases.
sampleName String: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
shortTermRetentionPolicy Property Map: A short_term_retention_policy block as defined below.
skuName 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.
storageAccountType String: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags Map: A mapping of tags to assign to the resource.
threatDetectionPolicy Property Map: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparentDataEncryptionEnabled Boolean
zoneRedundant 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 an 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,
        geo_backup_enabled: Optional[bool] = None,
        ledger_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,
        transparent_data_encryption_enabled: Optional[bool] = None,
        zone_redundant: Optional[bool] = None) -> Database

func 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)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoPauseDelayInMinutes int: Time in minutes after which database is automatically paused. A value of -1 means 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.
CreateMode string: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
ElasticPoolId string: Specifies the ID of the elastic pool containing this database.
GeoBackupEnabled bool: A boolean that specifies if the Geo Backup Policy is enabled.
LedgerEnabled bool: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
LongTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
MaxSizeGb int: The max size of the database in gigabytes.
MinCapacity 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.
ReadReplicaCount int: 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.
ReadScale 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.
RecoverDatabaseId string: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
RestoreDroppedDatabaseId string: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
RestorePointInTime string: 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= PointInTimeRestore databases.
SampleName string: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
ServerId string: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
ShortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
SkuName 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.
StorageAccountType string: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
ThreatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
TransparentDataEncryptionEnabled bool
ZoneRedundant 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.

AutoPauseDelayInMinutes int: Time in minutes after which database is automatically paused. A value of -1 means 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.
CreateMode string: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
ElasticPoolId string: Specifies the ID of the elastic pool containing this database.
GeoBackupEnabled bool: A boolean that specifies if the Geo Backup Policy is enabled.
LedgerEnabled bool: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
LongTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
MaxSizeGb int: The max size of the database in gigabytes.
MinCapacity 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.
ReadReplicaCount int: 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.
ReadScale 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.
RecoverDatabaseId string: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
RestoreDroppedDatabaseId string: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
RestorePointInTime string: 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= PointInTimeRestore databases.
SampleName string: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
ServerId string: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
ShortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
SkuName 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.
StorageAccountType string: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
Tags map[string]string: A mapping of tags to assign to the resource.
ThreatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
TransparentDataEncryptionEnabled bool
ZoneRedundant 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.

autoPauseDelayInMinutes Integer: Time in minutes after which database is automatically paused. A value of -1 means 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.
createMode String: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId String: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elasticPoolId String: Specifies the ID of the elastic pool containing this database.
geoBackupEnabled Boolean: A boolean that specifies if the Geo Backup Policy is enabled.
ledgerEnabled Boolean: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
licenseType String: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
longTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
maxSizeGb Integer: The max size of the database in gigabytes.
minCapacity 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.
readReplicaCount Integer: 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.
readScale 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.
recoverDatabaseId String: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restoreDroppedDatabaseId String: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restorePointInTime String: 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= PointInTimeRestore databases.
sampleName String: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
serverId String: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
shortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
skuName 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.
storageAccountType String: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags Map: A mapping of tags to assign to the resource.
threatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparentDataEncryptionEnabled Boolean
zoneRedundant 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.

autoPauseDelayInMinutes number: Time in minutes after which database is automatically paused. A value of -1 means 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.
createMode string: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId string: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elasticPoolId string: Specifies the ID of the elastic pool containing this database.
geoBackupEnabled boolean: A boolean that specifies if the Geo Backup Policy is enabled.
ledgerEnabled boolean: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
licenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
longTermRetentionPolicy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
maxSizeGb number: The max size of the database in gigabytes.
minCapacity 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.
readReplicaCount number: 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.
readScale 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.
recoverDatabaseId string: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restoreDroppedDatabaseId string: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restorePointInTime string: 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= PointInTimeRestore databases.
sampleName string: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
serverId string: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
shortTermRetentionPolicy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block as defined below.
skuName 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.
storageAccountType string: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
threatDetectionPolicy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparentDataEncryptionEnabled boolean
zoneRedundant 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_delay_in_minutes int: Time in minutes after which database is automatically paused. A value of -1 means 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, RestoreLongTermRetentionBackup and Secondary.
creation_source_database_id str: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elastic_pool_id str: Specifies the ID of the elastic pool containing this database.
geo_backup_enabled bool: A boolean that specifies if the Geo Backup Policy is enabled.
ledger_enabled bool: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
license_type str: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
long_term_retention_policy DatabaseLongTermRetentionPolicyArgs: A long_term_retention_policy block as defined below.
max_size_gb int: 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_count int: 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_id str: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restore_dropped_database_id str: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restore_point_in_time str: 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= PointInTimeRestore databases.
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_retention_policy DatabaseShortTermRetentionPolicyArgs: A short_term_retention_policy block 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_type str: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
threat_detection_policy DatabaseThreatDetectionPolicyArgs: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparent_data_encryption_enabled bool
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.

autoPauseDelayInMinutes Number: Time in minutes after which database is automatically paused. A value of -1 means 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.
createMode String: The create mode of the database. Possible values are Copy, Default, OnlineSecondary, PointInTimeRestore, Recovery, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId String: The ID of the source database from which to create the new database. This should only be used for databases with create_mode values that use another database as reference. Changing this forces a new resource to be created.
elasticPoolId String: Specifies the ID of the elastic pool containing this database.
geoBackupEnabled Boolean: A boolean that specifies if the Geo Backup Policy is enabled.
ledgerEnabled Boolean: A boolean that specifies if this is a ledger database. Defaults to false. Changing this forces a new resource to be created.
licenseType String: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
longTermRetentionPolicy Property Map: A long_term_retention_policy block as defined below.
maxSizeGb Number: The max size of the database in gigabytes.
minCapacity 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.
readReplicaCount Number: 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.
readScale 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.
recoverDatabaseId String: The ID of the database to be recovered. This property is only applicable when the create_mode is Recovery.
restoreDroppedDatabaseId String: The ID of the database to be restored. This property is only applicable when the create_mode is Restore.
restorePointInTime String: 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= PointInTimeRestore databases.
sampleName String: Specifies the name of the sample schema to apply when creating this database. Possible value is AdventureWorksLT.
serverId String: The id of the MS SQL Server on which to create the database. Changing this forces a new resource to be created.
shortTermRetentionPolicy Property Map: A short_term_retention_policy block as defined below.
skuName 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.
storageAccountType String: Specifies the storage account type used to store backups for this database. Possible values are Geo, GeoZone, Local and Zone. The default value is Geo.
tags Map: A mapping of tags to assign to the resource.
threatDetectionPolicy Property Map: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
transparentDataEncryptionEnabled Boolean
zoneRedundant 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

DatabaseLongTermRetentionPolicy

MonthlyRetention 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, P4W or P30D.
WeekOfYear int: The week of year to take the yearly backup. Value has to be between 1 and 52.
WeeklyRetention 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, P1W or P7D.
YearlyRetention 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, P52W or P365D.

MonthlyRetention 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, P4W or P30D.
WeekOfYear int: The week of year to take the yearly backup. Value has to be between 1 and 52.
WeeklyRetention 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, P1W or P7D.
YearlyRetention 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, P52W or P365D.

monthlyRetention 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, P4W or P30D.
weekOfYear Integer: The week of year to take the yearly backup. Value has to be between 1 and 52.
weeklyRetention 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, P1W or P7D.
yearlyRetention 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, P52W or P365D.

monthlyRetention 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, P4W or P30D.
weekOfYear number: The week of year to take the yearly backup. Value has to be between 1 and 52.
weeklyRetention 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, P1W or P7D.
yearlyRetention 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, P52W or P365D.

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, P4W or P30D.
week_of_year int: The week of year to take the yearly backup. Value has to be between 1 and 52.
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, P1W or P7D.
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, P52W or P365D.

monthlyRetention 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, P4W or P30D.
weekOfYear Number: The week of year to take the yearly backup. Value has to be between 1 and 52.
weeklyRetention 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, P1W or P7D.
yearlyRetention 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, P52W or P365D.

DatabaseShortTermRetentionPolicy

RetentionDays int: Point In Time Restore configuration. Value has to be between 7 and 35.
BackupIntervalInHours int: The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be 12 or 24. Defaults to 12 hours.

RetentionDays int: Point In Time Restore configuration. Value has to be between 7 and 35.
BackupIntervalInHours int: The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be 12 or 24. Defaults to 12 hours.

retentionDays Integer: Point In Time Restore configuration. Value has to be between 7 and 35.
backupIntervalInHours Integer: The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be 12 or 24. Defaults to 12 hours.

retentionDays number: Point In Time Restore configuration. Value has to be between 7 and 35.
backupIntervalInHours number: The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be 12 or 24. Defaults to 12 hours.

retention_days int: Point In Time Restore configuration. Value has to be between 7 and 35.
backup_interval_in_hours int: The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be 12 or 24. Defaults to 12 hours.

retentionDays Number: Point In Time Restore configuration. Value has to be between 7 and 35.
backupIntervalInHours Number: The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be 12 or 24. Defaults to 12 hours.

DatabaseThreatDetectionPolicy

DisabledAlerts List<string>: Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.
EmailAccountAdmins string: Should the account administrators be emailed when this alert is triggered?
EmailAddresses List<string>: A list of email addresses which alerts should be sent to.
RetentionDays 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, Disabled or New.
StorageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.
StorageEndpoint 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 state is Enabled.

DisabledAlerts []string: Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.
EmailAccountAdmins string: Should the account administrators be emailed when this alert is triggered?
EmailAddresses []string: A list of email addresses which alerts should be sent to.
RetentionDays 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, Disabled or New.
StorageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.
StorageEndpoint 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 state is Enabled.

disabledAlerts List: Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.
emailAccountAdmins String: Should the account administrators be emailed when this alert is triggered?
emailAddresses List: A list of email addresses which alerts should be sent to.
retentionDays 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, Disabled or New.
storageAccountAccessKey String: Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.
storageEndpoint 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 state is Enabled.

disabledAlerts string[]: Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.
emailAccountAdmins string: Should the account administrators be emailed when this alert is triggered?
emailAddresses string[]: A list of email addresses which alerts should be sent to.
retentionDays 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, Disabled or New.
storageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.
storageEndpoint 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 state is Enabled.

disabled_alerts Sequence[str]: Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.
email_account_admins str: 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, Disabled or New.
storage_account_access_key str: Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.
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 state is Enabled.

disabledAlerts List: Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.
emailAccountAdmins String: Should the account administrators be emailed when this alert is triggered?
emailAddresses List: A list of email addresses which alerts should be sent to.
retentionDays 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, Disabled or New.
storageAccountAccessKey String: Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.
storageEndpoint 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 state is Enabled.

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

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.