1. Packages
  2. Azure Native
  3. API Docs
  4. datamigration
  5. getDatabaseMigrationsSqlDb
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.datamigration.getDatabaseMigrationsSqlDb

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Retrieve the Database Migration resource.

Uses Azure REST API version 2023-07-15-preview.

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

Using getDatabaseMigrationsSqlDb

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 getDatabaseMigrationsSqlDb(args: GetDatabaseMigrationsSqlDbArgs, opts?: InvokeOptions): Promise<GetDatabaseMigrationsSqlDbResult>
function getDatabaseMigrationsSqlDbOutput(args: GetDatabaseMigrationsSqlDbOutputArgs, opts?: InvokeOptions): Output<GetDatabaseMigrationsSqlDbResult>
Copy
def get_database_migrations_sql_db(expand: Optional[str] = None,
                                   migration_operation_id: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   sql_db_instance_name: Optional[str] = None,
                                   target_db_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetDatabaseMigrationsSqlDbResult
def get_database_migrations_sql_db_output(expand: Optional[pulumi.Input[str]] = None,
                                   migration_operation_id: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   sql_db_instance_name: Optional[pulumi.Input[str]] = None,
                                   target_db_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseMigrationsSqlDbResult]
Copy
func LookupDatabaseMigrationsSqlDb(ctx *Context, args *LookupDatabaseMigrationsSqlDbArgs, opts ...InvokeOption) (*LookupDatabaseMigrationsSqlDbResult, error)
func LookupDatabaseMigrationsSqlDbOutput(ctx *Context, args *LookupDatabaseMigrationsSqlDbOutputArgs, opts ...InvokeOption) LookupDatabaseMigrationsSqlDbResultOutput
Copy

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

public static class GetDatabaseMigrationsSqlDb 
{
    public static Task<GetDatabaseMigrationsSqlDbResult> InvokeAsync(GetDatabaseMigrationsSqlDbArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseMigrationsSqlDbResult> Invoke(GetDatabaseMigrationsSqlDbInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabaseMigrationsSqlDbResult> getDatabaseMigrationsSqlDb(GetDatabaseMigrationsSqlDbArgs args, InvokeOptions options)
public static Output<GetDatabaseMigrationsSqlDbResult> getDatabaseMigrationsSqlDb(GetDatabaseMigrationsSqlDbArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:datamigration:getDatabaseMigrationsSqlDb
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
SqlDbInstanceName
This property is required.
Changes to this property will trigger replacement.
string
TargetDbName
This property is required.
Changes to this property will trigger replacement.
string
The name of the target database.
Expand string
Complete migration details be included in the response.
MigrationOperationId string
Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
SqlDbInstanceName
This property is required.
Changes to this property will trigger replacement.
string
TargetDbName
This property is required.
Changes to this property will trigger replacement.
string
The name of the target database.
Expand string
Complete migration details be included in the response.
MigrationOperationId string
Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlDbInstanceName
This property is required.
Changes to this property will trigger replacement.
String
targetDbName
This property is required.
Changes to this property will trigger replacement.
String
The name of the target database.
expand String
Complete migration details be included in the response.
migrationOperationId String
Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlDbInstanceName
This property is required.
Changes to this property will trigger replacement.
string
targetDbName
This property is required.
Changes to this property will trigger replacement.
string
The name of the target database.
expand string
Complete migration details be included in the response.
migrationOperationId string
Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sql_db_instance_name
This property is required.
Changes to this property will trigger replacement.
str
target_db_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the target database.
expand str
Complete migration details be included in the response.
migration_operation_id str
Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
sqlDbInstanceName
This property is required.
Changes to this property will trigger replacement.
String
targetDbName
This property is required.
Changes to this property will trigger replacement.
String
The name of the target database.
expand String
Complete migration details be included in the response.
migrationOperationId String
Optional migration operation ID. If this is provided, then details of migration operation for that ID are retrieved. If not provided (default), then details related to most recent or current operation are retrieved.

getDatabaseMigrationsSqlDb Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Name string
Properties Pulumi.AzureNative.DataMigration.Outputs.DatabaseMigrationPropertiesSqlDbResponse
Database Migration Resource properties for SQL database.
SystemData Pulumi.AzureNative.DataMigration.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
AzureApiVersion string
The Azure API version of the resource.
Id string
Name string
Properties DatabaseMigrationPropertiesSqlDbResponse
Database Migration Resource properties for SQL database.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
azureApiVersion String
The Azure API version of the resource.
id String
name String
properties DatabaseMigrationPropertiesSqlDbResponse
Database Migration Resource properties for SQL database.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
azureApiVersion string
The Azure API version of the resource.
id string
name string
properties DatabaseMigrationPropertiesSqlDbResponse
Database Migration Resource properties for SQL database.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
azure_api_version str
The Azure API version of the resource.
id str
name str
properties DatabaseMigrationPropertiesSqlDbResponse
Database Migration Resource properties for SQL database.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
azureApiVersion String
The Azure API version of the resource.
id String
name String
properties Property Map
Database Migration Resource properties for SQL database.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String

Supporting Types

CopyProgressDetailsResponse

CopyDuration This property is required. int
Copy Duration in seconds
CopyStart This property is required. string
Copy Start
CopyThroughput This property is required. double
Copy throughput in KBps
DataRead This property is required. double
Bytes read
DataWritten This property is required. double
Bytes written
ParallelCopyType This property is required. string
Type of parallel copy (Dynamic range, Physical partition, none).
RowsCopied This property is required. double
Rows Copied
RowsRead This property is required. double
Rows read
Status This property is required. string
Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).
TableName This property is required. string
Table Name
UsedParallelCopies This property is required. int
The degree of parallelization.
CopyDuration This property is required. int
Copy Duration in seconds
CopyStart This property is required. string
Copy Start
CopyThroughput This property is required. float64
Copy throughput in KBps
DataRead This property is required. float64
Bytes read
DataWritten This property is required. float64
Bytes written
ParallelCopyType This property is required. string
Type of parallel copy (Dynamic range, Physical partition, none).
RowsCopied This property is required. float64
Rows Copied
RowsRead This property is required. float64
Rows read
Status This property is required. string
Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).
TableName This property is required. string
Table Name
UsedParallelCopies This property is required. int
The degree of parallelization.
copyDuration This property is required. Integer
Copy Duration in seconds
copyStart This property is required. String
Copy Start
copyThroughput This property is required. Double
Copy throughput in KBps
dataRead This property is required. Double
Bytes read
dataWritten This property is required. Double
Bytes written
parallelCopyType This property is required. String
Type of parallel copy (Dynamic range, Physical partition, none).
rowsCopied This property is required. Double
Rows Copied
rowsRead This property is required. Double
Rows read
status This property is required. String
Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).
tableName This property is required. String
Table Name
usedParallelCopies This property is required. Integer
The degree of parallelization.
copyDuration This property is required. number
Copy Duration in seconds
copyStart This property is required. string
Copy Start
copyThroughput This property is required. number
Copy throughput in KBps
dataRead This property is required. number
Bytes read
dataWritten This property is required. number
Bytes written
parallelCopyType This property is required. string
Type of parallel copy (Dynamic range, Physical partition, none).
rowsCopied This property is required. number
Rows Copied
rowsRead This property is required. number
Rows read
status This property is required. string
Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).
tableName This property is required. string
Table Name
usedParallelCopies This property is required. number
The degree of parallelization.
copy_duration This property is required. int
Copy Duration in seconds
copy_start This property is required. str
Copy Start
copy_throughput This property is required. float
Copy throughput in KBps
data_read This property is required. float
Bytes read
data_written This property is required. float
Bytes written
parallel_copy_type This property is required. str
Type of parallel copy (Dynamic range, Physical partition, none).
rows_copied This property is required. float
Rows Copied
rows_read This property is required. float
Rows read
status This property is required. str
Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).
table_name This property is required. str
Table Name
used_parallel_copies This property is required. int
The degree of parallelization.
copyDuration This property is required. Number
Copy Duration in seconds
copyStart This property is required. String
Copy Start
copyThroughput This property is required. Number
Copy throughput in KBps
dataRead This property is required. Number
Bytes read
dataWritten This property is required. Number
Bytes written
parallelCopyType This property is required. String
Type of parallel copy (Dynamic range, Physical partition, none).
rowsCopied This property is required. Number
Rows Copied
rowsRead This property is required. Number
Rows read
status This property is required. String
Status of the Copy activity (InProgress, Succeeded, Failed, Canceled).
tableName This property is required. String
Table Name
usedParallelCopies This property is required. Number
The degree of parallelization.

DatabaseMigrationPropertiesSqlDbResponse

EndedOn This property is required. string
Database migration end time.
MigrationFailureError This property is required. Pulumi.AzureNative.DataMigration.Inputs.ErrorInfoResponse
Error details in case of migration failure.
MigrationStatus This property is required. string
Migration status.
MigrationStatusDetails This property is required. Pulumi.AzureNative.DataMigration.Inputs.SqlDbMigrationStatusDetailsResponse
Detailed migration status. Not included by default.
OfflineConfiguration This property is required. Pulumi.AzureNative.DataMigration.Inputs.SqlDbOfflineConfigurationResponse
Offline configuration.
ProvisioningState This property is required. string
Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
SourceServerName This property is required. string
Name of the source sql server.
StartedOn This property is required. string
Database migration start time.
MigrationOperationId string
ID for current migration operation.
MigrationService string
Resource Id of the Migration Service.
ProvisioningError string
Error message for migration provisioning failure, if any.
Scope string
Resource Id of the target resource.
SourceDatabaseName string
Name of the source database.
SourceSqlConnection Pulumi.AzureNative.DataMigration.Inputs.SqlConnectionInformationResponse
Source SQL Server connection details.
TableList List<string>
List of tables to copy.
TargetDatabaseCollation string
Database collation to be used for the target database.
TargetSqlConnection Pulumi.AzureNative.DataMigration.Inputs.SqlConnectionInformationResponse
Target SQL DB connection details.
EndedOn This property is required. string
Database migration end time.
MigrationFailureError This property is required. ErrorInfoResponse
Error details in case of migration failure.
MigrationStatus This property is required. string
Migration status.
MigrationStatusDetails This property is required. SqlDbMigrationStatusDetailsResponse
Detailed migration status. Not included by default.
OfflineConfiguration This property is required. SqlDbOfflineConfigurationResponse
Offline configuration.
ProvisioningState This property is required. string
Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
SourceServerName This property is required. string
Name of the source sql server.
StartedOn This property is required. string
Database migration start time.
MigrationOperationId string
ID for current migration operation.
MigrationService string
Resource Id of the Migration Service.
ProvisioningError string
Error message for migration provisioning failure, if any.
Scope string
Resource Id of the target resource.
SourceDatabaseName string
Name of the source database.
SourceSqlConnection SqlConnectionInformationResponse
Source SQL Server connection details.
TableList []string
List of tables to copy.
TargetDatabaseCollation string
Database collation to be used for the target database.
TargetSqlConnection SqlConnectionInformationResponse
Target SQL DB connection details.
endedOn This property is required. String
Database migration end time.
migrationFailureError This property is required. ErrorInfoResponse
Error details in case of migration failure.
migrationStatus This property is required. String
Migration status.
migrationStatusDetails This property is required. SqlDbMigrationStatusDetailsResponse
Detailed migration status. Not included by default.
offlineConfiguration This property is required. SqlDbOfflineConfigurationResponse
Offline configuration.
provisioningState This property is required. String
Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
sourceServerName This property is required. String
Name of the source sql server.
startedOn This property is required. String
Database migration start time.
migrationOperationId String
ID for current migration operation.
migrationService String
Resource Id of the Migration Service.
provisioningError String
Error message for migration provisioning failure, if any.
scope String
Resource Id of the target resource.
sourceDatabaseName String
Name of the source database.
sourceSqlConnection SqlConnectionInformationResponse
Source SQL Server connection details.
tableList List<String>
List of tables to copy.
targetDatabaseCollation String
Database collation to be used for the target database.
targetSqlConnection SqlConnectionInformationResponse
Target SQL DB connection details.
endedOn This property is required. string
Database migration end time.
migrationFailureError This property is required. ErrorInfoResponse
Error details in case of migration failure.
migrationStatus This property is required. string
Migration status.
migrationStatusDetails This property is required. SqlDbMigrationStatusDetailsResponse
Detailed migration status. Not included by default.
offlineConfiguration This property is required. SqlDbOfflineConfigurationResponse
Offline configuration.
provisioningState This property is required. string
Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
sourceServerName This property is required. string
Name of the source sql server.
startedOn This property is required. string
Database migration start time.
migrationOperationId string
ID for current migration operation.
migrationService string
Resource Id of the Migration Service.
provisioningError string
Error message for migration provisioning failure, if any.
scope string
Resource Id of the target resource.
sourceDatabaseName string
Name of the source database.
sourceSqlConnection SqlConnectionInformationResponse
Source SQL Server connection details.
tableList string[]
List of tables to copy.
targetDatabaseCollation string
Database collation to be used for the target database.
targetSqlConnection SqlConnectionInformationResponse
Target SQL DB connection details.
ended_on This property is required. str
Database migration end time.
migration_failure_error This property is required. ErrorInfoResponse
Error details in case of migration failure.
migration_status This property is required. str
Migration status.
migration_status_details This property is required. SqlDbMigrationStatusDetailsResponse
Detailed migration status. Not included by default.
offline_configuration This property is required. SqlDbOfflineConfigurationResponse
Offline configuration.
provisioning_state This property is required. str
Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
source_server_name This property is required. str
Name of the source sql server.
started_on This property is required. str
Database migration start time.
migration_operation_id str
ID for current migration operation.
migration_service str
Resource Id of the Migration Service.
provisioning_error str
Error message for migration provisioning failure, if any.
scope str
Resource Id of the target resource.
source_database_name str
Name of the source database.
source_sql_connection SqlConnectionInformationResponse
Source SQL Server connection details.
table_list Sequence[str]
List of tables to copy.
target_database_collation str
Database collation to be used for the target database.
target_sql_connection SqlConnectionInformationResponse
Target SQL DB connection details.
endedOn This property is required. String
Database migration end time.
migrationFailureError This property is required. Property Map
Error details in case of migration failure.
migrationStatus This property is required. String
Migration status.
migrationStatusDetails This property is required. Property Map
Detailed migration status. Not included by default.
offlineConfiguration This property is required. Property Map
Offline configuration.
provisioningState This property is required. String
Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started.
sourceServerName This property is required. String
Name of the source sql server.
startedOn This property is required. String
Database migration start time.
migrationOperationId String
ID for current migration operation.
migrationService String
Resource Id of the Migration Service.
provisioningError String
Error message for migration provisioning failure, if any.
scope String
Resource Id of the target resource.
sourceDatabaseName String
Name of the source database.
sourceSqlConnection Property Map
Source SQL Server connection details.
tableList List<String>
List of tables to copy.
targetDatabaseCollation String
Database collation to be used for the target database.
targetSqlConnection Property Map
Target SQL DB connection details.

ErrorInfoResponse

Code This property is required. string
Error code.
Message This property is required. string
Error message.
Code This property is required. string
Error code.
Message This property is required. string
Error message.
code This property is required. String
Error code.
message This property is required. String
Error message.
code This property is required. string
Error code.
message This property is required. string
Error message.
code This property is required. str
Error code.
message This property is required. str
Error message.
code This property is required. String
Error code.
message This property is required. String
Error message.

SqlConnectionInformationResponse

Authentication string
Authentication type.
DataSource string
Data source.
EncryptConnection bool
Whether to encrypt connection or not.
Password string
Password to connect to source SQL.
TrustServerCertificate bool
Whether to trust server certificate or not.
UserName string
User name to connect to source SQL.
Authentication string
Authentication type.
DataSource string
Data source.
EncryptConnection bool
Whether to encrypt connection or not.
Password string
Password to connect to source SQL.
TrustServerCertificate bool
Whether to trust server certificate or not.
UserName string
User name to connect to source SQL.
authentication String
Authentication type.
dataSource String
Data source.
encryptConnection Boolean
Whether to encrypt connection or not.
password String
Password to connect to source SQL.
trustServerCertificate Boolean
Whether to trust server certificate or not.
userName String
User name to connect to source SQL.
authentication string
Authentication type.
dataSource string
Data source.
encryptConnection boolean
Whether to encrypt connection or not.
password string
Password to connect to source SQL.
trustServerCertificate boolean
Whether to trust server certificate or not.
userName string
User name to connect to source SQL.
authentication str
Authentication type.
data_source str
Data source.
encrypt_connection bool
Whether to encrypt connection or not.
password str
Password to connect to source SQL.
trust_server_certificate bool
Whether to trust server certificate or not.
user_name str
User name to connect to source SQL.
authentication String
Authentication type.
dataSource String
Data source.
encryptConnection Boolean
Whether to encrypt connection or not.
password String
Password to connect to source SQL.
trustServerCertificate Boolean
Whether to trust server certificate or not.
userName String
User name to connect to source SQL.

SqlDbMigrationStatusDetailsResponse

ListOfCopyProgressDetails This property is required. List<Pulumi.AzureNative.DataMigration.Inputs.CopyProgressDetailsResponse>
Details on progress of ADF copy activities.
MigrationState This property is required. string
Current State of Migration.
SqlDataCopyErrors This property is required. List<string>
Sql Data Copy errors, if any.
ListOfCopyProgressDetails This property is required. []CopyProgressDetailsResponse
Details on progress of ADF copy activities.
MigrationState This property is required. string
Current State of Migration.
SqlDataCopyErrors This property is required. []string
Sql Data Copy errors, if any.
listOfCopyProgressDetails This property is required. List<CopyProgressDetailsResponse>
Details on progress of ADF copy activities.
migrationState This property is required. String
Current State of Migration.
sqlDataCopyErrors This property is required. List<String>
Sql Data Copy errors, if any.
listOfCopyProgressDetails This property is required. CopyProgressDetailsResponse[]
Details on progress of ADF copy activities.
migrationState This property is required. string
Current State of Migration.
sqlDataCopyErrors This property is required. string[]
Sql Data Copy errors, if any.
list_of_copy_progress_details This property is required. Sequence[CopyProgressDetailsResponse]
Details on progress of ADF copy activities.
migration_state This property is required. str
Current State of Migration.
sql_data_copy_errors This property is required. Sequence[str]
Sql Data Copy errors, if any.
listOfCopyProgressDetails This property is required. List<Property Map>
Details on progress of ADF copy activities.
migrationState This property is required. String
Current State of Migration.
sqlDataCopyErrors This property is required. List<String>
Sql Data Copy errors, if any.

SqlDbOfflineConfigurationResponse

Offline This property is required. bool
Offline migration
Offline This property is required. bool
Offline migration
offline This property is required. Boolean
Offline migration
offline This property is required. boolean
Offline migration
offline This property is required. bool
Offline migration
offline This property is required. Boolean
Offline migration

SystemDataResponse

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.2.0 published on Monday, Apr 14, 2025 by Pulumi