Database

Manages a MS SQL Database.

Create a Database Resource

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

def Database(resource_name, opts=None, auto_pause_delay_in_minutes=None, collation=None, create_mode=None, creation_source_database_id=None, elastic_pool_id=None, extended_auditing_policy=None, license_type=None, max_size_gb=None, min_capacity=None, name=None, read_replica_count=None, read_scale=None, restore_point_in_time=None, sample_name=None, server_id=None, sku_name=None, tags=None, threat_detection_policy=None, zone_redundant=None, __props__=None);

func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)

public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Database Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The id of the source database to be referred 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. Changing this forces a new resource to be created.
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicyArgs: A extended_auditing_policy block as defined below.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
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.
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.
SkuName string: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
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.
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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The id of the source database to be referred 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. Changing this forces a new resource to be created.
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
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.
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.
SkuName string: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
Tags map[string]string: A mapping of tags to assign to the resource.
ThreatDetectionPolicy DatabaseThreatDetectionPolicy: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
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 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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId string: The id of the source database to be referred 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. Changing this forces a new resource to be created.
extendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
licenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
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.
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.
skuName string: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
threatDetectionPolicy DatabaseThreatDetectionPolicy: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
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 float: 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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creation_source_database_id str: The id of the source database to be referred 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. Changing this forces a new resource to be created.
extended_auditing_policy Dict[DatabaseExtendedAuditingPolicy]: A extended_auditing_policy block as defined below.
license_type str: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
max_size_gb float: 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 float: 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.
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.
sku_name str: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
tags Dict[str, str]: A mapping of tags to assign to the resource.
threat_detection_policy Dict[DatabaseThreatDetectionPolicy]: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
zone_redundant bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.

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 str: 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

static get(resource_name, id, opts=None, auto_pause_delay_in_minutes=None, collation=None, create_mode=None, creation_source_database_id=None, elastic_pool_id=None, extended_auditing_policy=None, license_type=None, max_size_gb=None, min_capacity=None, name=None, read_replica_count=None, read_scale=None, restore_point_in_time=None, sample_name=None, server_id=None, sku_name=None, tags=None, threat_detection_policy=None, zone_redundant=None, __props__=None);

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)

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.

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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The id of the source database to be referred 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. Changing this forces a new resource to be created.
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicyArgs: A extended_auditing_policy block as defined below.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
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.
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.
SkuName string: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
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.
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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
CreationSourceDatabaseId string: The id of the source database to be referred 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. Changing this forces a new resource to be created.
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
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.
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.
SkuName string: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
Tags map[string]string: A mapping of tags to assign to the resource.
ThreatDetectionPolicy DatabaseThreatDetectionPolicy: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
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 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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creationSourceDatabaseId string: The id of the source database to be referred 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. Changing this forces a new resource to be created.
extendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
licenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
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.
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.
skuName string: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
threatDetectionPolicy DatabaseThreatDetectionPolicy: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
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 float: 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, Restore, RestoreExternalBackup, RestoreExternalBackupSecondary, RestoreLongTermRetentionBackup and Secondary.
creation_source_database_id str: The id of the source database to be referred 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. Changing this forces a new resource to be created.
extended_auditing_policy Dict[DatabaseExtendedAuditingPolicy]: A extended_auditing_policy block as defined below.
license_type str: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
max_size_gb float: 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 float: 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.
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.
sku_name str: Specifies the name of the sku used by the database. Changing this forces a new resource to be created. For example, GP_S_Gen5_2,HS_Gen4_1,BC_Gen5_2, ElasticPool, Basic,S0, P2 ,DW100c, DS100.
tags Dict[str, str]: A mapping of tags to assign to the resource.
threat_detection_policy Dict[DatabaseThreatDetectionPolicy]: Threat detection policy configuration. The threat_detection_policy block supports fields documented below.
zone_redundant bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. This property is only settable for Premium and Business Critical databases.

Supporting Types

DatabaseExtendedAuditingPolicy

See the input and output API doc for this type.

StorageAccountAccessKey string: Specifies the access key to use for the auditing storage account.
StorageEndpoint string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
RetentionInDays int: Specifies the number of days to retain logs for in the storage account.
StorageAccountAccessKeyIsSecondary bool: Specifies whether storage_account_access_key value is the storage’s secondary key.

StorageAccountAccessKey string: Specifies the access key to use for the auditing storage account.
StorageEndpoint string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
RetentionInDays int: Specifies the number of days to retain logs for in the storage account.
StorageAccountAccessKeyIsSecondary bool: Specifies whether storage_account_access_key value is the storage’s secondary key.

storageAccountAccessKey string: Specifies the access key to use for the auditing storage account.
storageEndpoint string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
retentionInDays number: Specifies the number of days to retain logs for in the storage account.
storageAccountAccessKeyIsSecondary boolean: Specifies whether storage_account_access_key value is the storage’s secondary key.

storage_account_access_key str: Specifies the access key to use for the auditing storage account.
storage_endpoint str: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).
retention_in_days float: Specifies the number of days to retain logs for in the storage account.
storageAccountAccessKeyIsSecondary bool: Specifies whether storage_account_access_key value is the storage’s secondary key.

DatabaseThreatDetectionPolicy

See the input and output API doc for this type.

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.
UseServerDefault string: Should the default server policy be used? Defaults to Disabled.

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.
UseServerDefault string: Should the default server policy be used? Defaults to Disabled.

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.
useServerDefault string: Should the default server policy be used? Defaults to Disabled.

disabled_alerts List[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 List[str]: A list of email addresses which alerts should be sent to.
retention_days float: 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.
useServerDefault str: Should the default server policy be used? Defaults to Disabled.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud