Edit

Share via


Get-AzDataMigrationAssessment

Start assessment on SQL Server instance(s)

Syntax

CommandLine (Default)

Get-AzDataMigrationAssessment
    -ConnectionString <String[]>
    [-OutputFolder <String>]
    [-Overwrite]
    [-PassThru]
    [<CommonParameters>]

ConfigFile

Get-AzDataMigrationAssessment
    -ConfigFilePath <String>
    [-PassThru]
    [<CommonParameters>]

Description

Start assessment on SQL Server instance(s)

Examples

Example 1: Run SQL Assessment on given SQL Server using connection string

Get-AzDataMigrationAssessment -ConnectionString "Data Source=LabServer.database.net;Initial Catalog=master;Integrated Security=False;User Id=User;Password=password" -OutputFolder "C:\AssessmentOutput" -Overwrite
Starting SQL assessment...
Progress: 100%; Issues Found: 100; Objects Assessed: 500/500; Status: Completed; Total time: 00:01:50.000.

Finishing SQL assessment...
Assessment report saved to C:\Users\user\AppData\Local\Microsoft\SqlAssessment\SqlAssessmentReport.json.
Event and Error Logs Folder Path: C:\Users\user\AppData\Local\Microsoft\SqlAssessment\Logs

This command runs SQL Assessment on given SQL Server using the connection string.

Example 2: Run SQL Assessment on given SQL Server using assessment config file

Get-AzDataMigrationAssessment -ConfigFilePath "C:\Users\user\document\config.json"
Starting SQL assessment...
Progress: 100%; Issues Found: 100; Objects Assessed: 550/550; Status: Completed; Total time: 00:01:50.000.

Finishing SQL assessment...
Assessment report saved to C:\Users\user\AppData\Local\Microsoft\SqlAssessment\SqlAssessmentReport.json.
Event and Error Logs Folder Path: C:\Users\user\AppData\Local\Microsoft\SqlAssessment\Logs

This command runs SQL Assessment on given SQL Server using assessment config file.

Parameters

-ConfigFilePath

Path of the ConfigFile

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ConfigFile
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConnectionString

Sql Server Connection Strings

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommandLine
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OutputFolder

Output folder to store assessment report

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommandLine
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Overwrite

Enable this parameter to overwrite the existing assessment report

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommandLine
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Start assessment on SQL Server instance(s)

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Boolean