Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurearcdata
  5. getSqlServerDatabase
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurearcdata.getSqlServerDatabase

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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves an Arc Sql Server database.

    Uses Azure REST API version 2024-01-01.

    Other available API versions: 2023-01-15-preview, 2024-05-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurearcdata [ApiVersion]. See the version guide for details.

    Using getSqlServerDatabase

    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 getSqlServerDatabase(args: GetSqlServerDatabaseArgs, opts?: InvokeOptions): Promise<GetSqlServerDatabaseResult>
function getSqlServerDatabaseOutput(args: GetSqlServerDatabaseOutputArgs, opts?: InvokeOptions): Output<GetSqlServerDatabaseResult>
    def get_sql_server_database(database_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            sql_server_instance_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSqlServerDatabaseResult
def get_sql_server_database_output(database_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            sql_server_instance_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSqlServerDatabaseResult]
    func LookupSqlServerDatabase(ctx *Context, args *LookupSqlServerDatabaseArgs, opts ...InvokeOption) (*LookupSqlServerDatabaseResult, error)
func LookupSqlServerDatabaseOutput(ctx *Context, args *LookupSqlServerDatabaseOutputArgs, opts ...InvokeOption) LookupSqlServerDatabaseResultOutput

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

    public static class GetSqlServerDatabase 
{
    public static Task<GetSqlServerDatabaseResult> InvokeAsync(GetSqlServerDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlServerDatabaseResult> Invoke(GetSqlServerDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSqlServerDatabaseResult> getSqlServerDatabase(GetSqlServerDatabaseArgs args, InvokeOptions options)
public static Output<GetSqlServerDatabaseResult> getSqlServerDatabase(GetSqlServerDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurearcdata:getSqlServerDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    Name of the database
    ResourceGroupName string
    The name of the Azure resource group
    SqlServerInstanceName string
    Name of SQL Server Instance
    DatabaseName string
    Name of the database
    ResourceGroupName string
    The name of the Azure resource group
    SqlServerInstanceName string
    Name of SQL Server Instance
    databaseName String
    Name of the database
    resourceGroupName String
    The name of the Azure resource group
    sqlServerInstanceName String
    Name of SQL Server Instance
    databaseName string
    Name of the database
    resourceGroupName string
    The name of the Azure resource group
    sqlServerInstanceName string
    Name of SQL Server Instance
    database_name str
    Name of the database
    resource_group_name str
    The name of the Azure resource group
    sql_server_instance_name str
    Name of SQL Server Instance
    databaseName String
    Name of the database
    resourceGroupName String
    The name of the Azure resource group
    sqlServerInstanceName String
    Name of SQL Server Instance

    getSqlServerDatabase Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureArcData.Outputs.SqlServerDatabaseResourcePropertiesResponse
    Properties of Arc Sql Server database
    SystemData Pulumi.AzureNative.AzureArcData.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties SqlServerDatabaseResourcePropertiesResponse
    Properties of Arc Sql Server database
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties SqlServerDatabaseResourcePropertiesResponse
    Properties of Arc Sql Server database
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties SqlServerDatabaseResourcePropertiesResponse
    Properties of Arc Sql Server database
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties SqlServerDatabaseResourcePropertiesResponse
    Properties of Arc Sql Server database
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    Properties of Arc Sql Server database
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    BackupPolicyResponse

    DifferentialBackupHours int
    The differential backup interval in hours.
    FullBackupDays int
    The value indicating days between full backups.
    RetentionPeriodDays int
    The retention period for all the databases in this managed instance.
    TransactionLogBackupMinutes int
    The value indicating minutes between transaction log backups.
    DifferentialBackupHours int
    The differential backup interval in hours.
    FullBackupDays int
    The value indicating days between full backups.
    RetentionPeriodDays int
    The retention period for all the databases in this managed instance.
    TransactionLogBackupMinutes int
    The value indicating minutes between transaction log backups.
    differentialBackupHours Integer
    The differential backup interval in hours.
    fullBackupDays Integer
    The value indicating days between full backups.
    retentionPeriodDays Integer
    The retention period for all the databases in this managed instance.
    transactionLogBackupMinutes Integer
    The value indicating minutes between transaction log backups.
    differentialBackupHours number
    The differential backup interval in hours.
    fullBackupDays number
    The value indicating days between full backups.
    retentionPeriodDays number
    The retention period for all the databases in this managed instance.
    transactionLogBackupMinutes number
    The value indicating minutes between transaction log backups.
    differential_backup_hours int
    The differential backup interval in hours.
    full_backup_days int
    The value indicating days between full backups.
    retention_period_days int
    The retention period for all the databases in this managed instance.
    transaction_log_backup_minutes int
    The value indicating minutes between transaction log backups.
    differentialBackupHours Number
    The differential backup interval in hours.
    fullBackupDays Number
    The value indicating days between full backups.
    retentionPeriodDays Number
    The retention period for all the databases in this managed instance.
    transactionLogBackupMinutes Number
    The value indicating minutes between transaction log backups.

    SqlServerDatabaseResourcePropertiesResponse

    EarliestRestoreDate string
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    LastDatabaseUploadTime string
    The time when last successful database upload was performed.
    ProvisioningState string
    The provisioning state of the Arc-enabled SQL Server database resource.
    BackupInformation Pulumi.AzureNative.AzureArcData.Inputs.SqlServerDatabaseResourcePropertiesResponseBackupInformation
    BackupPolicy Pulumi.AzureNative.AzureArcData.Inputs.BackupPolicyResponse
    The backup profile for the SQL server.
    CollationName string
    Collation of the database.
    CompatibilityLevel int
    Compatibility level of the database
    CreateMode string
    Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.
    DatabaseCreationDate string
    Creation date of the database.
    DatabaseOptions Pulumi.AzureNative.AzureArcData.Inputs.SqlServerDatabaseResourcePropertiesResponseDatabaseOptions
    List of features that are enabled for the database
    IsReadOnly bool
    Whether the database is read only or not.
    RecoveryMode string
    Status of the database.
    RestorePointInTime string
    Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
    SizeMB double
    Size of the database.
    SourceDatabaseId string
    The resource identifier of the source database associated with create operation of this database.
    SpaceAvailableMB double
    Space left of the database.
    State string
    State of the database.
    EarliestRestoreDate string
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    LastDatabaseUploadTime string
    The time when last successful database upload was performed.
    ProvisioningState string
    The provisioning state of the Arc-enabled SQL Server database resource.
    BackupInformation SqlServerDatabaseResourcePropertiesResponseBackupInformation
    BackupPolicy BackupPolicyResponse
    The backup profile for the SQL server.
    CollationName string
    Collation of the database.
    CompatibilityLevel int
    Compatibility level of the database
    CreateMode string
    Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.
    DatabaseCreationDate string
    Creation date of the database.
    DatabaseOptions SqlServerDatabaseResourcePropertiesResponseDatabaseOptions
    List of features that are enabled for the database
    IsReadOnly bool
    Whether the database is read only or not.
    RecoveryMode string
    Status of the database.
    RestorePointInTime string
    Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
    SizeMB float64
    Size of the database.
    SourceDatabaseId string
    The resource identifier of the source database associated with create operation of this database.
    SpaceAvailableMB float64
    Space left of the database.
    State string
    State of the database.
    earliestRestoreDate String
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    lastDatabaseUploadTime String
    The time when last successful database upload was performed.
    provisioningState String
    The provisioning state of the Arc-enabled SQL Server database resource.
    backupInformation SqlServerDatabaseResourcePropertiesResponseBackupInformation
    backupPolicy BackupPolicyResponse
    The backup profile for the SQL server.
    collationName String
    Collation of the database.
    compatibilityLevel Integer
    Compatibility level of the database
    createMode String
    Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.
    databaseCreationDate String
    Creation date of the database.
    databaseOptions SqlServerDatabaseResourcePropertiesResponseDatabaseOptions
    List of features that are enabled for the database
    isReadOnly Boolean
    Whether the database is read only or not.
    recoveryMode String
    Status of the database.
    restorePointInTime String
    Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
    sizeMB Double
    Size of the database.
    sourceDatabaseId String
    The resource identifier of the source database associated with create operation of this database.
    spaceAvailableMB Double
    Space left of the database.
    state String
    State of the database.
    earliestRestoreDate string
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    lastDatabaseUploadTime string
    The time when last successful database upload was performed.
    provisioningState string
    The provisioning state of the Arc-enabled SQL Server database resource.
    backupInformation SqlServerDatabaseResourcePropertiesResponseBackupInformation
    backupPolicy BackupPolicyResponse
    The backup profile for the SQL server.
    collationName string
    Collation of the database.
    compatibilityLevel number
    Compatibility level of the database
    createMode string
    Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.
    databaseCreationDate string
    Creation date of the database.
    databaseOptions SqlServerDatabaseResourcePropertiesResponseDatabaseOptions
    List of features that are enabled for the database
    isReadOnly boolean
    Whether the database is read only or not.
    recoveryMode string
    Status of the database.
    restorePointInTime string
    Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
    sizeMB number
    Size of the database.
    sourceDatabaseId string
    The resource identifier of the source database associated with create operation of this database.
    spaceAvailableMB number
    Space left of the database.
    state string
    State of the database.
    earliest_restore_date str
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    last_database_upload_time str
    The time when last successful database upload was performed.
    provisioning_state str
    The provisioning state of the Arc-enabled SQL Server database resource.
    backup_information SqlServerDatabaseResourcePropertiesResponseBackupInformation
    backup_policy BackupPolicyResponse
    The backup profile for the SQL server.
    collation_name str
    Collation of the database.
    compatibility_level int
    Compatibility level of the database
    create_mode str
    Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.
    database_creation_date str
    Creation date of the database.
    database_options SqlServerDatabaseResourcePropertiesResponseDatabaseOptions
    List of features that are enabled for the database
    is_read_only bool
    Whether the database is read only or not.
    recovery_mode str
    Status of the database.
    restore_point_in_time str
    Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
    size_mb float
    Size of the database.
    source_database_id str
    The resource identifier of the source database associated with create operation of this database.
    space_available_mb float
    Space left of the database.
    state str
    State of the database.
    earliestRestoreDate String
    This records the earliest start date and time that restore is available for this database (ISO8601 format).
    lastDatabaseUploadTime String
    The time when last successful database upload was performed.
    provisioningState String
    The provisioning state of the Arc-enabled SQL Server database resource.
    backupInformation Property Map
    backupPolicy Property Map
    The backup profile for the SQL server.
    collationName String
    Collation of the database.
    compatibilityLevel Number
    Compatibility level of the database
    createMode String
    Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.
    databaseCreationDate String
    Creation date of the database.
    databaseOptions Property Map
    List of features that are enabled for the database
    isReadOnly Boolean
    Whether the database is read only or not.
    recoveryMode String
    Status of the database.
    restorePointInTime String
    Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
    sizeMB Number
    Size of the database.
    sourceDatabaseId String
    The resource identifier of the source database associated with create operation of this database.
    spaceAvailableMB Number
    Space left of the database.
    state String
    State of the database.

    SqlServerDatabaseResourcePropertiesResponseBackupInformation

    LastFullBackup string
    Date time of last full backup.
    LastLogBackup string
    Date time of last log backup.
    LastFullBackup string
    Date time of last full backup.
    LastLogBackup string
    Date time of last log backup.
    lastFullBackup String
    Date time of last full backup.
    lastLogBackup String
    Date time of last log backup.
    lastFullBackup string
    Date time of last full backup.
    lastLogBackup string
    Date time of last log backup.
    last_full_backup str
    Date time of last full backup.
    last_log_backup str
    Date time of last log backup.
    lastFullBackup String
    Date time of last full backup.
    lastLogBackup String
    Date time of last log backup.

    SqlServerDatabaseResourcePropertiesResponseDatabaseOptions

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native