Azure Classic
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!
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!
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:
- 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
-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.
- Create
Mode string The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- Geo
Backup boolEnabled 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 string Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- Long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- Restore
Dropped stringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- Dictionary<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_policy
block supports fields documented below.- Transparent
Data boolEncryption Enabled - 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
-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.
- Create
Mode string The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- Geo
Backup boolEnabled 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 string Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- Long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- Restore
Dropped stringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- 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_policy
block supports fields documented below.- Transparent
Data boolEncryption Enabled - 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
-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.
- create
Mode String The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- geo
Backup BooleanEnabled A boolean that specifies if the Geo Backup Policy is enabled.
- ledger
Enabled Boolean A boolean that specifies if this is a ledger database. Defaults to
false
. Changing this forces a new resource to be created.- license
Type String Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- restore
Dropped StringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- Map
A mapping of tags to assign to the resource.
- threat
Detection DatabasePolicy Threat Detection Policy Args Threat detection policy configuration. The
threat_detection_policy
block supports fields documented below.- transparent
Data BooleanEncryption Enabled - 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
-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.
- create
Mode string The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- geo
Backup booleanEnabled A boolean that specifies if the Geo Backup Policy is enabled.
- ledger
Enabled boolean A boolean that specifies if this is a ledger database. Defaults to
false
. Changing this forces a new resource to be created.- license
Type string Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- restore
Dropped stringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- {[key: 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_policy
block supports fields documented below.- transparent
Data booleanEncryption Enabled - 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
-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
andSecondary
.- 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_mode
values 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.
- geo_
backup_ boolenabled 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
andBasePrice
.- long_
term_ Databaseretention_ policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- restore_
dropped_ strdatabase_ id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_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_ strtype Specifies the storage account type used to store backups for this database. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- 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_policy
block supports fields documented below.- transparent_
data_ boolencryption_ enabled - 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
-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.
- create
Mode String The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- geo
Backup BooleanEnabled A boolean that specifies if the Geo Backup Policy is enabled.
- ledger
Enabled Boolean A boolean that specifies if this is a ledger database. Defaults to
false
. Changing this forces a new resource to be created.- license
Type String Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- long
Term Property MapRetention Policy A
long_term_retention_policy
block 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_mode
isRecovery
.- restore
Dropped StringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- Map
A mapping of tags to assign to the resource.
- threat
Detection Property MapPolicy Threat detection policy configuration. The
threat_detection_policy
block supports fields documented below.- transparent
Data BooleanEncryption Enabled - 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 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.
- Auto
Pause intDelay In Minutes 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.
- Create
Mode string The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- Geo
Backup boolEnabled 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 string Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- Long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- Restore
Dropped stringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- Dictionary<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_policy
block supports fields documented below.- Transparent
Data boolEncryption Enabled - 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
-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.
- Create
Mode string The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- Geo
Backup boolEnabled 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 string Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- Long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- Restore
Dropped stringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- 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_policy
block supports fields documented below.- Transparent
Data boolEncryption Enabled - 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
-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.
- create
Mode String The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- geo
Backup BooleanEnabled A boolean that specifies if the Geo Backup Policy is enabled.
- ledger
Enabled Boolean A boolean that specifies if this is a ledger database. Defaults to
false
. Changing this forces a new resource to be created.- license
Type String Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- restore
Dropped StringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- Map
A mapping of tags to assign to the resource.
- threat
Detection DatabasePolicy Threat Detection Policy Args Threat detection policy configuration. The
threat_detection_policy
block supports fields documented below.- transparent
Data BooleanEncryption Enabled - 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
-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.
- create
Mode string The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- geo
Backup booleanEnabled A boolean that specifies if the Geo Backup Policy is enabled.
- ledger
Enabled boolean A boolean that specifies if this is a ledger database. Defaults to
false
. Changing this forces a new resource to be created.- license
Type string Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- long
Term DatabaseRetention Policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- restore
Dropped stringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- {[key: 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_policy
block supports fields documented below.- transparent
Data booleanEncryption Enabled - 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
-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
andSecondary
.- 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_mode
values 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.
- geo_
backup_ boolenabled 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
andBasePrice
.- long_
term_ Databaseretention_ policy Long Term Retention Policy Args A
long_term_retention_policy
block 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_mode
isRecovery
.- restore_
dropped_ strdatabase_ id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=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_ Databaseretention_ policy Short Term Retention Policy Args 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_ strtype Specifies the storage account type used to store backups for this database. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- 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_policy
block supports fields documented below.- transparent_
data_ boolencryption_ enabled - 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
-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.
- create
Mode String The create mode of the database. Possible values are
Copy
,Default
,OnlineSecondary
,PointInTimeRestore
,Recovery
,Restore
,RestoreExternalBackup
,RestoreExternalBackupSecondary
,RestoreLongTermRetentionBackup
andSecondary
.- 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_mode
values 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.
- geo
Backup BooleanEnabled A boolean that specifies if the Geo Backup Policy is enabled.
- ledger
Enabled Boolean A boolean that specifies if this is a ledger database. Defaults to
false
. Changing this forces a new resource to be created.- license
Type String Specifies the license type applied to this database. Possible values are
LicenseIncluded
andBasePrice
.- long
Term Property MapRetention Policy A
long_term_retention_policy
block 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_mode
isRecovery
.- restore
Dropped StringDatabase Id The ID of the database to be restored. This property is only applicable when the
create_mode
isRestore
.- 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
=PointInTimeRestore
databases.- 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_policy
block 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. Possible values are
Geo
,GeoZone
,Local
andZone
. The default value isGeo
.- Map
A mapping of tags to assign to the resource.
- threat
Detection Property MapPolicy Threat detection policy configuration. The
threat_detection_policy
block supports fields documented below.- transparent
Data BooleanEncryption Enabled - 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
DatabaseLongTermRetentionPolicy
- 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
,P4W
orP30D
.- Week
Of intYear The week of year to take the yearly backup. Value has to be between
1
and52
.- 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
,P1W
orP7D
.- 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
,P52W
orP365D
.
- 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
,P4W
orP30D
.- Week
Of intYear The week of year to take the yearly backup. Value has to be between
1
and52
.- 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
,P1W
orP7D
.- 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
,P52W
orP365D
.
- 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
,P4W
orP30D
.- week
Of IntegerYear The week of year to take the yearly backup. Value has to be between
1
and52
.- 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
,P1W
orP7D
.- 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
,P52W
orP365D
.
- 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
,P4W
orP30D
.- week
Of numberYear The week of year to take the yearly backup. Value has to be between
1
and52
.- 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
,P1W
orP7D
.- 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
,P52W
orP365D
.
- 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
orP30D
.- week_
of_ intyear The week of year to take the yearly backup. Value has to be between
1
and52
.- 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
orP7D
.- 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
orP365D
.
- 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
,P4W
orP30D
.- week
Of NumberYear The week of year to take the yearly backup. Value has to be between
1
and52
.- 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
,P1W
orP7D
.- 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
,P52W
orP365D
.
DatabaseShortTermRetentionPolicy
- Retention
Days int Point In Time Restore configuration. Value has to be between
7
and35
.- Backup
Interval intIn Hours The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be
12
or24
. Defaults to12
hours.
- Retention
Days int Point In Time Restore configuration. Value has to be between
7
and35
.- Backup
Interval intIn Hours The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be
12
or24
. Defaults to12
hours.
- retention
Days Integer Point In Time Restore configuration. Value has to be between
7
and35
.- backup
Interval IntegerIn Hours The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be
12
or24
. Defaults to12
hours.
- retention
Days number Point In Time Restore configuration. Value has to be between
7
and35
.- backup
Interval numberIn Hours The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be
12
or24
. Defaults to12
hours.
- retention_
days int Point In Time Restore configuration. Value has to be between
7
and35
.- backup_
interval_ intin_ hours The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be
12
or24
. Defaults to12
hours.
- retention
Days Number Point In Time Restore configuration. Value has to be between
7
and35
.- backup
Interval NumberIn Hours The hours between each differential backup. This is only applicable to live databases but not dropped databases. Value has to be
12
or24
. Defaults to12
hours.
DatabaseThreatDetectionPolicy
- Disabled
Alerts List<string> Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly
,Sql_Injection
andSql_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
,Disabled
orNew
.- Storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account. Required if
state
isEnabled
.- 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
state
isEnabled
.
- Disabled
Alerts []string Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly
,Sql_Injection
andSql_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
,Disabled
orNew
.- Storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account. Required if
state
isEnabled
.- 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
state
isEnabled
.
- disabled
Alerts List Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly
,Sql_Injection
andSql_Injection_Vulnerability
.- email
Account StringAdmins Should the account administrators be emailed when this alert is triggered?
- email
Addresses List 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
,Disabled
orNew
.- storage
Account StringAccess Key Specifies the identifier key of the Threat Detection audit storage account. Required if
state
isEnabled
.- 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
state
isEnabled
.
- disabled
Alerts string[] Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly
,Sql_Injection
andSql_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
,Disabled
orNew
.- storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account. Required if
state
isEnabled
.- 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
state
isEnabled
.
- disabled_
alerts Sequence[str] Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly
,Sql_Injection
andSql_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
,Disabled
orNew
.- storage_
account_ straccess_ key Specifies the identifier key of the Threat Detection audit storage account. Required if
state
isEnabled
.- 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
isEnabled
.
- disabled
Alerts List Specifies a list of alerts which should be disabled. Possible values include
Access_Anomaly
,Sql_Injection
andSql_Injection_Vulnerability
.- email
Account StringAdmins Should the account administrators be emailed when this alert is triggered?
- email
Addresses List 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
,Disabled
orNew
.- storage
Account StringAccess Key Specifies the identifier key of the Threat Detection audit storage account. Required if
state
isEnabled
.- 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
state
isEnabled
.
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.