Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getDatabase
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getDatabase

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a database.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2014-04-01, 2017-03-01-preview, 2017-10-01-preview, 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Using getDatabase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>
    def get_database(database_name: Optional[str] = None,
                 expand: Optional[str] = None,
                 filter: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 server_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(database_name: Optional[pulumi.Input[str]] = None,
                 expand: Optional[pulumi.Input[str]] = None,
                 filter: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 server_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]
    func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

    > Note: This function is named LookupDatabase in the Go SDK.

    public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the database.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    Expand string
    The child resources to include in the response.
    Filter string
    An OData filter expression that filters elements in the collection.
    DatabaseName string
    The name of the database.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    Expand string
    The child resources to include in the response.
    Filter string
    An OData filter expression that filters elements in the collection.
    databaseName String
    The name of the database.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    expand String
    The child resources to include in the response.
    filter String
    An OData filter expression that filters elements in the collection.
    databaseName string
    The name of the database.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName string
    The name of the server.
    expand string
    The child resources to include in the response.
    filter string
    An OData filter expression that filters elements in the collection.
    database_name str
    The name of the database.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    server_name str
    The name of the server.
    expand str
    The child resources to include in the response.
    filter str
    An OData filter expression that filters elements in the collection.
    databaseName String
    The name of the database.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    expand String
    The child resources to include in the response.
    filter String
    An OData filter expression that filters elements in the collection.

    getDatabase Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    CreationDate string
    The creation date of the database (ISO8601 format).
    CurrentBackupStorageRedundancy string
    The storage account type used to store backups for this database.
    CurrentServiceObjectiveName string
    The current service level objective name of the database.
    CurrentSku Pulumi.AzureNative.Sql.Outputs.SkuResponse
    The name and tier of the SKU.
    DatabaseId string
    The ID of the database.
    DefaultSecondaryLocation string
    The default secondary region for this database.
    EarliestRestoreDate string
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    FailoverGroupId string
    Failover Group resource identifier that this database belongs to.
    Id string
    Resource ID.
    IsInfraEncryptionEnabled bool
    Infra encryption is enabled for this database.
    Kind string
    Kind of database. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    ManagedBy string
    Resource that manages the database.
    MaxLogSizeBytes double
    The max log size for this database.
    Name string
    Resource name.
    PausedDate string
    The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
    RequestedServiceObjectiveName string
    The requested service level objective name of the database.
    ResumedDate string
    The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
    Status string
    The status of the database.
    Type string
    Resource type.
    AutoPauseDelay int
    Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
    AvailabilityZone string
    Specifies the availability zone the database is pinned to.
    CatalogCollation string
    Collation of the metadata catalog.
    Collation string
    The collation of the database.
    ElasticPoolId string
    The resource identifier of the elastic pool containing this database.
    EncryptionProtector string
    The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
    EncryptionProtectorAutoRotation bool
    The flag to enable or disable auto rotation of database encryption protector AKV key.
    FederatedClientId string
    The Client id used for cross tenant per database CMK scenario
    FreeLimitExhaustionBehavior string

    Specifies the behavior when monthly free limits are exhausted for the free database.

    AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.

    BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

    HighAvailabilityReplicaCount int
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
    Identity Pulumi.AzureNative.Sql.Outputs.DatabaseIdentityResponse
    The Azure Active Directory identity of the database.
    IsLedgerOn bool
    Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
    Keys Dictionary<string, Pulumi.AzureNative.Sql.Outputs.DatabaseKeyResponse>
    The resource ids of the user assigned identities to use
    LicenseType string
    The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
    MaintenanceConfigurationId string
    Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
    ManualCutover bool

    Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

    When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

    To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

    MaxSizeBytes double
    The max size of the database expressed in bytes.
    MinCapacity double
    Minimal capacity that database will always have allocated, if not paused
    PerformCutover bool

    To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

    This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

    When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

    PreferredEnclaveType string
    Type of enclave requested on the database i.e. Default or VBS enclaves.
    ReadScale string
    The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
    RequestedBackupStorageRedundancy string
    The storage account type to be used to store backups for this database.
    SecondaryType string
    The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
    Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse

    The database SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

    az sql db list-editions -l <location> -o table

    Get-AzSqlServerServiceObjective -Location <location>
    Tags Dictionary<string, string>
    Resource tags.
    UseFreeLimit bool
    Whether or not the database uses free monthly limits. Allowed on one database in a subscription.
    ZoneRedundant bool
    Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
    AzureApiVersion string
    The Azure API version of the resource.
    CreationDate string
    The creation date of the database (ISO8601 format).
    CurrentBackupStorageRedundancy string
    The storage account type used to store backups for this database.
    CurrentServiceObjectiveName string
    The current service level objective name of the database.
    CurrentSku SkuResponse
    The name and tier of the SKU.
    DatabaseId string
    The ID of the database.
    DefaultSecondaryLocation string
    The default secondary region for this database.
    EarliestRestoreDate string
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    FailoverGroupId string
    Failover Group resource identifier that this database belongs to.
    Id string
    Resource ID.
    IsInfraEncryptionEnabled bool
    Infra encryption is enabled for this database.
    Kind string
    Kind of database. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    ManagedBy string
    Resource that manages the database.
    MaxLogSizeBytes float64
    The max log size for this database.
    Name string
    Resource name.
    PausedDate string
    The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
    RequestedServiceObjectiveName string
    The requested service level objective name of the database.
    ResumedDate string
    The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
    Status string
    The status of the database.
    Type string
    Resource type.
    AutoPauseDelay int
    Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
    AvailabilityZone string
    Specifies the availability zone the database is pinned to.
    CatalogCollation string
    Collation of the metadata catalog.
    Collation string
    The collation of the database.
    ElasticPoolId string
    The resource identifier of the elastic pool containing this database.
    EncryptionProtector string
    The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
    EncryptionProtectorAutoRotation bool
    The flag to enable or disable auto rotation of database encryption protector AKV key.
    FederatedClientId string
    The Client id used for cross tenant per database CMK scenario
    FreeLimitExhaustionBehavior string

    Specifies the behavior when monthly free limits are exhausted for the free database.

    AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.

    BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

    HighAvailabilityReplicaCount int
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
    Identity DatabaseIdentityResponse
    The Azure Active Directory identity of the database.
    IsLedgerOn bool
    Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
    Keys map[string]DatabaseKeyResponse
    The resource ids of the user assigned identities to use
    LicenseType string
    The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
    MaintenanceConfigurationId string
    Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
    ManualCutover bool

    Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

    When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

    To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

    MaxSizeBytes float64
    The max size of the database expressed in bytes.
    MinCapacity float64
    Minimal capacity that database will always have allocated, if not paused
    PerformCutover bool

    To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

    This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

    When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

    PreferredEnclaveType string
    Type of enclave requested on the database i.e. Default or VBS enclaves.
    ReadScale string
    The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
    RequestedBackupStorageRedundancy string
    The storage account type to be used to store backups for this database.
    SecondaryType string
    The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
    Sku SkuResponse

    The database SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

    az sql db list-editions -l <location> -o table

    Get-AzSqlServerServiceObjective -Location <location>
    Tags map[string]string
    Resource tags.
    UseFreeLimit bool
    Whether or not the database uses free monthly limits. Allowed on one database in a subscription.
    ZoneRedundant bool
    Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
    azureApiVersion String
    The Azure API version of the resource.
    creationDate String
    The creation date of the database (ISO8601 format).
    currentBackupStorageRedundancy String
    The storage account type used to store backups for this database.
    currentServiceObjectiveName String
    The current service level objective name of the database.
    currentSku SkuResponse
    The name and tier of the SKU.
    databaseId String
    The ID of the database.
    defaultSecondaryLocation String
    The default secondary region for this database.
    earliestRestoreDate String
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    failoverGroupId String
    Failover Group resource identifier that this database belongs to.
    id String
    Resource ID.
    isInfraEncryptionEnabled Boolean
    Infra encryption is enabled for this database.
    kind String
    Kind of database. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    managedBy String
    Resource that manages the database.
    maxLogSizeBytes Double
    The max log size for this database.
    name String
    Resource name.
    pausedDate String
    The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
    requestedServiceObjectiveName String
    The requested service level objective name of the database.
    resumedDate String
    The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
    status String
    The status of the database.
    type String
    Resource type.
    autoPauseDelay Integer
    Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
    availabilityZone String
    Specifies the availability zone the database is pinned to.
    catalogCollation String
    Collation of the metadata catalog.
    collation String
    The collation of the database.
    elasticPoolId String
    The resource identifier of the elastic pool containing this database.
    encryptionProtector String
    The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
    encryptionProtectorAutoRotation Boolean
    The flag to enable or disable auto rotation of database encryption protector AKV key.
    federatedClientId String
    The Client id used for cross tenant per database CMK scenario
    freeLimitExhaustionBehavior String

    Specifies the behavior when monthly free limits are exhausted for the free database.

    AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.

    BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

    highAvailabilityReplicaCount Integer
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
    identity DatabaseIdentityResponse
    The Azure Active Directory identity of the database.
    isLedgerOn Boolean
    Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
    keys Map<String,DatabaseKeyResponse>
    The resource ids of the user assigned identities to use
    licenseType String
    The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
    maintenanceConfigurationId String
    Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
    manualCutover Boolean

    Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

    When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

    To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

    maxSizeBytes Double
    The max size of the database expressed in bytes.
    minCapacity Double
    Minimal capacity that database will always have allocated, if not paused
    performCutover Boolean

    To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

    This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

    When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

    preferredEnclaveType String
    Type of enclave requested on the database i.e. Default or VBS enclaves.
    readScale String
    The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
    requestedBackupStorageRedundancy String
    The storage account type to be used to store backups for this database.
    secondaryType String
    The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
    sku SkuResponse

    The database SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

    az sql db list-editions -l <location> -o table

    Get-AzSqlServerServiceObjective -Location <location>
    tags Map<String,String>
    Resource tags.
    useFreeLimit Boolean
    Whether or not the database uses free monthly limits. Allowed on one database in a subscription.
    zoneRedundant Boolean
    Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
    azureApiVersion string
    The Azure API version of the resource.
    creationDate string
    The creation date of the database (ISO8601 format).
    currentBackupStorageRedundancy string
    The storage account type used to store backups for this database.
    currentServiceObjectiveName string
    The current service level objective name of the database.
    currentSku SkuResponse
    The name and tier of the SKU.
    databaseId string
    The ID of the database.
    defaultSecondaryLocation string
    The default secondary region for this database.
    earliestRestoreDate string
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    failoverGroupId string
    Failover Group resource identifier that this database belongs to.
    id string
    Resource ID.
    isInfraEncryptionEnabled boolean
    Infra encryption is enabled for this database.
    kind string
    Kind of database. This is metadata used for the Azure portal experience.
    location string
    Resource location.
    managedBy string
    Resource that manages the database.
    maxLogSizeBytes number
    The max log size for this database.
    name string
    Resource name.
    pausedDate string
    The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
    requestedServiceObjectiveName string
    The requested service level objective name of the database.
    resumedDate string
    The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
    status string
    The status of the database.
    type string
    Resource type.
    autoPauseDelay number
    Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
    availabilityZone string
    Specifies the availability zone the database is pinned to.
    catalogCollation string
    Collation of the metadata catalog.
    collation string
    The collation of the database.
    elasticPoolId string
    The resource identifier of the elastic pool containing this database.
    encryptionProtector string
    The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
    encryptionProtectorAutoRotation boolean
    The flag to enable or disable auto rotation of database encryption protector AKV key.
    federatedClientId string
    The Client id used for cross tenant per database CMK scenario
    freeLimitExhaustionBehavior string

    Specifies the behavior when monthly free limits are exhausted for the free database.

    AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.

    BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

    highAvailabilityReplicaCount number
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
    identity DatabaseIdentityResponse
    The Azure Active Directory identity of the database.
    isLedgerOn boolean
    Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
    keys {[key: string]: DatabaseKeyResponse}
    The resource ids of the user assigned identities to use
    licenseType string
    The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
    maintenanceConfigurationId string
    Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
    manualCutover boolean

    Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

    When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

    To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

    maxSizeBytes number
    The max size of the database expressed in bytes.
    minCapacity number
    Minimal capacity that database will always have allocated, if not paused
    performCutover boolean

    To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

    This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

    When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

    preferredEnclaveType string
    Type of enclave requested on the database i.e. Default or VBS enclaves.
    readScale string
    The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
    requestedBackupStorageRedundancy string
    The storage account type to be used to store backups for this database.
    secondaryType string
    The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
    sku SkuResponse

    The database SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

    az sql db list-editions -l <location> -o table

    Get-AzSqlServerServiceObjective -Location <location>
    tags {[key: string]: string}
    Resource tags.
    useFreeLimit boolean
    Whether or not the database uses free monthly limits. Allowed on one database in a subscription.
    zoneRedundant boolean
    Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
    azure_api_version str
    The Azure API version of the resource.
    creation_date str
    The creation date of the database (ISO8601 format).
    current_backup_storage_redundancy str
    The storage account type used to store backups for this database.
    current_service_objective_name str
    The current service level objective name of the database.
    current_sku SkuResponse
    The name and tier of the SKU.
    database_id str
    The ID of the database.
    default_secondary_location str
    The default secondary region for this database.
    earliest_restore_date str
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    failover_group_id str
    Failover Group resource identifier that this database belongs to.
    id str
    Resource ID.
    is_infra_encryption_enabled bool
    Infra encryption is enabled for this database.
    kind str
    Kind of database. This is metadata used for the Azure portal experience.
    location str
    Resource location.
    managed_by str
    Resource that manages the database.
    max_log_size_bytes float
    The max log size for this database.
    name str
    Resource name.
    paused_date str
    The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
    requested_service_objective_name str
    The requested service level objective name of the database.
    resumed_date str
    The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
    status str
    The status of the database.
    type str
    Resource type.
    auto_pause_delay int
    Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
    availability_zone str
    Specifies the availability zone the database is pinned to.
    catalog_collation str
    Collation of the metadata catalog.
    collation str
    The collation of the database.
    elastic_pool_id str
    The resource identifier of the elastic pool containing this database.
    encryption_protector str
    The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
    encryption_protector_auto_rotation bool
    The flag to enable or disable auto rotation of database encryption protector AKV key.
    federated_client_id str
    The Client id used for cross tenant per database CMK scenario
    free_limit_exhaustion_behavior str

    Specifies the behavior when monthly free limits are exhausted for the free database.

    AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.

    BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

    high_availability_replica_count int
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
    identity DatabaseIdentityResponse
    The Azure Active Directory identity of the database.
    is_ledger_on bool
    Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
    keys Mapping[str, DatabaseKeyResponse]
    The resource ids of the user assigned identities to use
    license_type str
    The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
    maintenance_configuration_id str
    Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
    manual_cutover bool

    Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

    When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

    To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

    max_size_bytes float
    The max size of the database expressed in bytes.
    min_capacity float
    Minimal capacity that database will always have allocated, if not paused
    perform_cutover bool

    To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

    This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

    When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

    preferred_enclave_type str
    Type of enclave requested on the database i.e. Default or VBS enclaves.
    read_scale str
    The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
    requested_backup_storage_redundancy str
    The storage account type to be used to store backups for this database.
    secondary_type str
    The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
    sku SkuResponse

    The database SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

    az sql db list-editions -l <location> -o table

    Get-AzSqlServerServiceObjective -Location <location>
    tags Mapping[str, str]
    Resource tags.
    use_free_limit bool
    Whether or not the database uses free monthly limits. Allowed on one database in a subscription.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    creationDate String
    The creation date of the database (ISO8601 format).
    currentBackupStorageRedundancy String
    The storage account type used to store backups for this database.
    currentServiceObjectiveName String
    The current service level objective name of the database.
    currentSku Property Map
    The name and tier of the SKU.
    databaseId String
    The ID of the database.
    defaultSecondaryLocation String
    The default secondary region for this database.
    earliestRestoreDate String
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    failoverGroupId String
    Failover Group resource identifier that this database belongs to.
    id String
    Resource ID.
    isInfraEncryptionEnabled Boolean
    Infra encryption is enabled for this database.
    kind String
    Kind of database. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    managedBy String
    Resource that manages the database.
    maxLogSizeBytes Number
    The max log size for this database.
    name String
    Resource name.
    pausedDate String
    The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
    requestedServiceObjectiveName String
    The requested service level objective name of the database.
    resumedDate String
    The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
    status String
    The status of the database.
    type String
    Resource type.
    autoPauseDelay Number
    Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
    availabilityZone String
    Specifies the availability zone the database is pinned to.
    catalogCollation String
    Collation of the metadata catalog.
    collation String
    The collation of the database.
    elasticPoolId String
    The resource identifier of the elastic pool containing this database.
    encryptionProtector String
    The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
    encryptionProtectorAutoRotation Boolean
    The flag to enable or disable auto rotation of database encryption protector AKV key.
    federatedClientId String
    The Client id used for cross tenant per database CMK scenario
    freeLimitExhaustionBehavior String

    Specifies the behavior when monthly free limits are exhausted for the free database.

    AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.

    BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

    highAvailabilityReplicaCount Number
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
    identity Property Map
    The Azure Active Directory identity of the database.
    isLedgerOn Boolean
    Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
    keys Map<Property Map>
    The resource ids of the user assigned identities to use
    licenseType String
    The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
    maintenanceConfigurationId String
    Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
    manualCutover Boolean

    Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

    When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

    To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

    maxSizeBytes Number
    The max size of the database expressed in bytes.
    minCapacity Number
    Minimal capacity that database will always have allocated, if not paused
    performCutover Boolean

    To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

    This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

    This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

    When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

    preferredEnclaveType String
    Type of enclave requested on the database i.e. Default or VBS enclaves.
    readScale String
    The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
    requestedBackupStorageRedundancy String
    The storage account type to be used to store backups for this database.
    secondaryType String
    The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
    sku Property Map

    The database SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

    az sql db list-editions -l <location> -o table

    Get-AzSqlServerServiceObjective -Location <location>
    tags Map<String>
    Resource tags.
    useFreeLimit Boolean
    Whether or not the database uses free monthly limits. Allowed on one database in a subscription.
    zoneRedundant Boolean
    Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

    Supporting Types

    DatabaseIdentityResponse

    TenantId string
    The Azure Active Directory tenant id.
    Type string
    The identity type
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Sql.Inputs.DatabaseUserIdentityResponse>
    The resource ids of the user assigned identities to use
    TenantId string
    The Azure Active Directory tenant id.
    Type string
    The identity type
    UserAssignedIdentities map[string]DatabaseUserIdentityResponse
    The resource ids of the user assigned identities to use
    tenantId String
    The Azure Active Directory tenant id.
    type String
    The identity type
    userAssignedIdentities Map<String,DatabaseUserIdentityResponse>
    The resource ids of the user assigned identities to use
    tenantId string
    The Azure Active Directory tenant id.
    type string
    The identity type
    userAssignedIdentities {[key: string]: DatabaseUserIdentityResponse}
    The resource ids of the user assigned identities to use
    tenant_id str
    The Azure Active Directory tenant id.
    type str
    The identity type
    user_assigned_identities Mapping[str, DatabaseUserIdentityResponse]
    The resource ids of the user assigned identities to use
    tenantId String
    The Azure Active Directory tenant id.
    type String
    The identity type
    userAssignedIdentities Map<Property Map>
    The resource ids of the user assigned identities to use

    DatabaseKeyResponse

    CreationDate string
    The database key creation date.
    Subregion string
    Subregion of the server key.
    Thumbprint string
    Thumbprint of the database key.
    Type string
    The database key type. Only supported value is 'AzureKeyVault'.
    CreationDate string
    The database key creation date.
    Subregion string
    Subregion of the server key.
    Thumbprint string
    Thumbprint of the database key.
    Type string
    The database key type. Only supported value is 'AzureKeyVault'.
    creationDate String
    The database key creation date.
    subregion String
    Subregion of the server key.
    thumbprint String
    Thumbprint of the database key.
    type String
    The database key type. Only supported value is 'AzureKeyVault'.
    creationDate string
    The database key creation date.
    subregion string
    Subregion of the server key.
    thumbprint string
    Thumbprint of the database key.
    type string
    The database key type. Only supported value is 'AzureKeyVault'.
    creation_date str
    The database key creation date.
    subregion str
    Subregion of the server key.
    thumbprint str
    Thumbprint of the database key.
    type str
    The database key type. Only supported value is 'AzureKeyVault'.
    creationDate String
    The database key creation date.
    subregion String
    Subregion of the server key.
    thumbprint String
    Thumbprint of the database key.
    type String
    The database key type. Only supported value is 'AzureKeyVault'.

    DatabaseUserIdentityResponse

    ClientId string
    The Azure Active Directory client id.
    PrincipalId string
    The Azure Active Directory principal id.
    ClientId string
    The Azure Active Directory client id.
    PrincipalId string
    The Azure Active Directory principal id.
    clientId String
    The Azure Active Directory client id.
    principalId String
    The Azure Active Directory principal id.
    clientId string
    The Azure Active Directory client id.
    principalId string
    The Azure Active Directory principal id.
    client_id str
    The Azure Active Directory client id.
    principal_id str
    The Azure Active Directory principal id.
    clientId String
    The Azure Active Directory client id.
    principalId String
    The Azure Active Directory principal id.

    SkuResponse

    Name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    Capacity int
    Capacity of the particular SKU.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    Size of the particular SKU
    Tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    Name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    Capacity int
    Capacity of the particular SKU.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    Size of the particular SKU
    Tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name String
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity Integer
    Capacity of the particular SKU.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    Size of the particular SKU
    tier String
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity number
    Capacity of the particular SKU.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    Size of the particular SKU
    tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name str
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity int
    Capacity of the particular SKU.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    Size of the particular SKU
    tier str
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name String
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity Number
    Capacity of the particular SKU.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    Size of the particular SKU
    tier String
    The tier or edition of the particular SKU, e.g. Basic, Premium.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native