Database

Allows you to manage an Azure SQL Database

Create a Database Resource

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

def Database(resource_name, opts=None, collation=None, create_mode=None, edition=None, elastic_pool_name=None, extended_auditing_policy=None, import_=None, location=None, max_size_bytes=None, max_size_gb=None, name=None, read_scale=None, requested_service_objective_id=None, requested_service_objective_name=None, resource_group_name=None, restore_point_in_time=None, server_name=None, source_database_deletion_date=None, source_database_id=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:

ResourceGroupName string: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
ServerName string: The name of the SQL Server on which to create the database.
Collation string: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
CreateMode string: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
Edition string: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
ElasticPoolName string: The name of the elastic database pool.
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicyArgs: A extended_auditing_policy block as defined below.
Import DatabaseImportArgs: A Database Import block as documented below. create_mode must be set to Default.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes string: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
MaxSizeGb string
Name string: The name of the database.
ReadScale bool: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
RequestedServiceObjectiveId string: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
RequestedServiceObjectiveName string: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
RestorePointInTime string: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
SourceDatabaseDeletionDate string: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
SourceDatabaseId string: The URI of the source database if create_mode value is not Default.
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.

ResourceGroupName string: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
ServerName string: The name of the SQL Server on which to create the database.
Collation string: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
CreateMode string: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
Edition string: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
ElasticPoolName string: The name of the elastic database pool.
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
Import DatabaseImport: A Database Import block as documented below. create_mode must be set to Default.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes string: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
MaxSizeGb string
Name string: The name of the database.
ReadScale bool: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
RequestedServiceObjectiveId string: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
RequestedServiceObjectiveName string: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
RestorePointInTime string: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
SourceDatabaseDeletionDate string: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
SourceDatabaseId string: The URI of the source database if create_mode value is not Default.
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.

resourceGroupName string: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
serverName string: The name of the SQL Server on which to create the database.
collation string: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
createMode string: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
edition string: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
elasticPoolName string: The name of the elastic database pool.
extendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
import DatabaseImport: A Database Import block as documented below. create_mode must be set to Default.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maxSizeBytes string: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
maxSizeGb string
name string: The name of the database.
readScale boolean: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
requestedServiceObjectiveId string: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
requestedServiceObjectiveName string: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
restorePointInTime string: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
sourceDatabaseDeletionDate string: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
sourceDatabaseId string: The URI of the source database if create_mode value is not Default.
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.

resource_group_name str: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
server_name str: The name of the SQL Server on which to create the database.
collation str: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
create_mode str: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
edition str: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
elastic_pool_name str: The name of the elastic database pool.
extended_auditing_policy Dict[DatabaseExtendedAuditingPolicy]: A extended_auditing_policy block as defined below.
import_ Dict[DatabaseImport]: A Database Import block as documented below. create_mode must be set to Default.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
max_size_bytes str: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
max_size_gb str
name str: The name of the database.
read_scale bool: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
requested_service_objective_id str: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
requested_service_objective_name str: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
restore_point_in_time str: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
source_database_deletion_date str: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
source_database_id str: The URI of the source database if create_mode value is not Default.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

CreationDate string: The creation date of the SQL Database.
DefaultSecondaryLocation string: The default secondary location of the SQL Database.
Encryption string
Id string: The provider-assigned unique ID for this managed resource.

CreationDate string: The creation date of the SQL Database.
DefaultSecondaryLocation string: The default secondary location of the SQL Database.
Encryption string
Id string: The provider-assigned unique ID for this managed resource.

creationDate string: The creation date of the SQL Database.
defaultSecondaryLocation string: The default secondary location of the SQL Database.
encryption string
id string: The provider-assigned unique ID for this managed resource.

creation_date str: The creation date of the SQL Database.
default_secondary_location str: The default secondary location of the SQL Database.
encryption str
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, collation=None, create_mode=None, creation_date=None, default_secondary_location=None, edition=None, elastic_pool_name=None, encryption=None, extended_auditing_policy=None, import_=None, location=None, max_size_bytes=None, max_size_gb=None, name=None, read_scale=None, requested_service_objective_id=None, requested_service_objective_name=None, resource_group_name=None, restore_point_in_time=None, server_name=None, source_database_deletion_date=None, source_database_id=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:

Collation string: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
CreateMode string: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
CreationDate string: The creation date of the SQL Database.
DefaultSecondaryLocation string: The default secondary location of the SQL Database.
Edition string: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
ElasticPoolName string: The name of the elastic database pool.
Encryption string
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicyArgs: A extended_auditing_policy block as defined below.
Import DatabaseImportArgs: A Database Import block as documented below. create_mode must be set to Default.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes string: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
MaxSizeGb string
Name string: The name of the database.
ReadScale bool: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
RequestedServiceObjectiveId string: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
RequestedServiceObjectiveName string: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
ResourceGroupName string: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
RestorePointInTime string: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
ServerName string: The name of the SQL Server on which to create the database.
SourceDatabaseDeletionDate string: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
SourceDatabaseId string: The URI of the source database if create_mode value is not Default.
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.

Collation string: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
CreateMode string: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
CreationDate string: The creation date of the SQL Database.
DefaultSecondaryLocation string: The default secondary location of the SQL Database.
Edition string: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
ElasticPoolName string: The name of the elastic database pool.
Encryption string
ExtendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
Import DatabaseImport: A Database Import block as documented below. create_mode must be set to Default.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes string: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
MaxSizeGb string
Name string: The name of the database.
ReadScale bool: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
RequestedServiceObjectiveId string: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
RequestedServiceObjectiveName string: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
ResourceGroupName string: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
RestorePointInTime string: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
ServerName string: The name of the SQL Server on which to create the database.
SourceDatabaseDeletionDate string: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
SourceDatabaseId string: The URI of the source database if create_mode value is not Default.
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.

collation string: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
createMode string: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
creationDate string: The creation date of the SQL Database.
defaultSecondaryLocation string: The default secondary location of the SQL Database.
edition string: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
elasticPoolName string: The name of the elastic database pool.
encryption string
extendedAuditingPolicy DatabaseExtendedAuditingPolicy: A extended_auditing_policy block as defined below.
import DatabaseImport: A Database Import block as documented below. create_mode must be set to Default.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maxSizeBytes string: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
maxSizeGb string
name string: The name of the database.
readScale boolean: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
requestedServiceObjectiveId string: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
requestedServiceObjectiveName string: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
resourceGroupName string: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
restorePointInTime string: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
serverName string: The name of the SQL Server on which to create the database.
sourceDatabaseDeletionDate string: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
sourceDatabaseId string: The URI of the source database if create_mode value is not Default.
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.

collation str: The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.
create_mode str: Specifies how to create the database. Valid values are: Default, Copy, OnlineSecondary, NonReadableSecondary, PointInTimeRestore, Recovery, Restore or RestoreLongTermRetentionBackup. Must be Default to create a new database. Defaults to Default. Please see Azure SQL Database REST API
creation_date str: The creation date of the SQL Database.
default_secondary_location str: The default secondary location of the SQL Database.
edition str: The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, DataWarehouse, Business, BusinessCritical, Free, GeneralPurpose, Hyperscale, Premium, PremiumRS, Standard, Stretch, System, System2, or Web. Please see Azure SQL Database Service Tiers.
elastic_pool_name str: The name of the elastic database pool.
encryption str
extended_auditing_policy Dict[DatabaseExtendedAuditingPolicy]: A extended_auditing_policy block as defined below.
import_ Dict[DatabaseImport]: A Database Import block as documented below. create_mode must be set to Default.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
max_size_bytes str: The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.
max_size_gb str
name str: The name of the database.
read_scale bool: Read-only connections will be redirected to a high-available replica. Please see Use read-only replicas to load-balance read-only query workloads.
requested_service_objective_id str: A GUID/UUID corresponding to a configured Service Level Objective for the Azure SQL database which can be used to configure a performance level. .
requested_service_objective_name str: The service objective name for the database. Valid values depend on edition and location and may include S0, S1, S2, S3, P1, P2, P4, P6, P11 and ElasticPool. You can list the available names with the cli: shell az sql db list-editions -l westus --edition Standard -o table. For further information please see Azure CLI - az sql db.
resource_group_name str: The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.
restore_point_in_time str: The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z
server_name str: The name of the SQL Server on which to create the database.
source_database_deletion_date str: The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.
source_database_id str: The URI of the source database if create_mode value is not Default.
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.

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.

DatabaseImport

See the input and output API doc for this type.

AdministratorLogin string: Specifies the name of the SQL administrator.
AdministratorLoginPassword string: Specifies the password of the SQL administrator.
AuthenticationType string: Specifies the type of authentication used to access the server. Valid values are SQL or ADPassword.
StorageKey string: Specifies the access key for the storage account.
StorageKeyType string: Specifies the type of access key for the storage account. Valid values are StorageAccessKey or SharedAccessKey.
StorageUri string: Specifies the blob URI of the .bacpac file.
OperationMode string: Specifies the type of import operation being performed. The only allowable value is Import.

AdministratorLogin string: Specifies the name of the SQL administrator.
AdministratorLoginPassword string: Specifies the password of the SQL administrator.
AuthenticationType string: Specifies the type of authentication used to access the server. Valid values are SQL or ADPassword.
StorageKey string: Specifies the access key for the storage account.
StorageKeyType string: Specifies the type of access key for the storage account. Valid values are StorageAccessKey or SharedAccessKey.
StorageUri string: Specifies the blob URI of the .bacpac file.
OperationMode string: Specifies the type of import operation being performed. The only allowable value is Import.

administratorLogin string: Specifies the name of the SQL administrator.
administratorLoginPassword string: Specifies the password of the SQL administrator.
authenticationType string: Specifies the type of authentication used to access the server. Valid values are SQL or ADPassword.
storageKey string: Specifies the access key for the storage account.
storageKeyType string: Specifies the type of access key for the storage account. Valid values are StorageAccessKey or SharedAccessKey.
storageUri string: Specifies the blob URI of the .bacpac file.
operationMode string: Specifies the type of import operation being performed. The only allowable value is Import.

administrator_login str: Specifies the name of the SQL administrator.
administrator_login_password str: Specifies the password of the SQL administrator.
authenticationType str: Specifies the type of authentication used to access the server. Valid values are SQL or ADPassword.
storageKey str: Specifies the access key for the storage account.
storageKeyType str: Specifies the type of access key for the storage account. Valid values are StorageAccessKey or SharedAccessKey.
storageUri str: Specifies the blob URI of the .bacpac file.
operationMode str: Specifies the type of import operation being performed. The only allowable value is Import.

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

Database

Create a Database Resource

Database Resource Properties

Inputs

Outputs

Look up an Existing Database Resource

Supporting Types

DatabaseExtendedAuditingPolicy

DatabaseImport

DatabaseThreatDetectionPolicy

Package Details

On This Page