Skip to content

Commit c6689f6

Browse files
aciorteaaciortea
committed
command line updates
1 parent 6f192d0 commit c6689f6

2 files changed

Lines changed: 60 additions & 88 deletions

File tree

‎docs/dma/dma-commandline.md‎

Lines changed: 42 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ DmaCmd.exe
274274
```
275275
## Azure SQL Database / Azure SQL Managed Instance / SQL Server on Azure VM SKU recommendations using the CLI
276276

277-
With version 5.4 and above, when you install Data Migration Assistant, it will also install SqlAssessment.exe in %ProgramFiles%\Microsoft Data Migration Assistant\SQLAssessmentConsole\. Use SqlAssessment.exe to collect performance data for your SQL instance over an extended period of time, and output the result to JSON or CSV file. This method is especially useful when assessing several databases or huge databases
277+
With version 5.4 and above, when you install Data Migration Assistant, it will also install SqlAssessment.exe in %ProgramFiles%\Microsoft Data Migration Assistant\SQLAssessmentConsole\. Use SqlAssessment.exe to collect performance data for your SQL instance over an extended period of time, and output the result to JSON or CSV file.
278278

279279
These commands support recommendations for both Azure SQL Database single database, Azure SQL Managed Instance and SQL Server on Azure VM deployment options.
280280

@@ -286,91 +286,62 @@ These commands support recommendations for both Azure SQL Database single databa
286286

287287
|Argument |Description | Required (Y/N)
288288
|---------|---------|---------------|
289-
|`PerfDataCollection` | Starts collection of performance data | Y
290-
|`GetSkuRecommendation` | Performs aggregation and analysis of the collected performance data and determines SKU recommendations| Y
291-
|`Assess` | Performs an assessment of the target SQL instance(s) | Y
292-
|`--outputFolder` | Folder which performance data, reports, and logs will be written to/read from. <br> (Default: current directory)| N
293-
|`/SkuRecommendationHtmlResultsFilePath` | Full path to the HTML result file | Y <br> (Requires either TSV or JSON or HTML file path)
294-
|`/SkuRecommendationPreventPriceRefresh` | Prevents the price refresh from occurring. Use if running in offline mode (e.g., true). | Y <br> (Select either this argument for static prices or all arguments below need to be selected to get the latest prices)
295-
|`/SkuRecommendationCurrencyCode` | The currency in which to display prices (e.g. "USD") | Y <br> (For the latest prices)
296-
|`/SkuRecommendationOfferName` | The offer name (e.g. "MS-AZR-0003P"). For more information, see the [Microsoft Azure Offer Details](https://azure.microsoft.com/support/legal/offer-details/) page. | Y <br> (For the latest prices)
297-
|`/SkuRecommendationRegionName` | The region name (e.g. "WestUS") | Y <br> (For the latest prices)
298-
|`/SkuRecommendationSubscriptionId` | The subscription ID. | Y <br> (For the latest prices)
299-
|`/SkuRecommendationDatabasesToRecommend` | Space-separated list of databases to recommend for (e.g. “Database1” “Database2” “Database3”). Names are case-sensitive and must be surrounded by double-quotes. If omitted, recommendations are provided for all databases. | N
300-
|`/AzureAuthenticationTenantId` | The authentication tenant. | Y <br> (For the latest prices)
301-
|`/AzureAuthenticationClientId` | The client ID of the Azure AD app used for authentication. | Y <br> (For the latest prices)
302-
|`/AzureAuthenticationInteractiveAuthentication` | Set to true to pop up the window. | Y <br> (For the latest prices) <br>(Pick one of the 3 authentication options - option 1)
303-
|`/AzureAuthenticationCertificateStoreLocation` | Set to the certificate store location (e.g. "CurrentUser"). | Y <br>(For the latest prices) <br> (Pick one of the 3 authentication options - option 2)
304-
|`/AzureAuthenticationCertificateThumbprint` | Set to the cert thumbprint. | Y <br> (For the latest prices) <br>(Pick one of the 3 authentication options - option 2)
305-
|`/AzureAuthenticationToken` | Set to the certificate token. | Y <br> (For the latest prices) <br>(Pick one of the 3 authentication options - option 3)
289+
|`PerfDataCollection` | Starts collection of performance data. | Y
290+
|`GetSkuRecommendation` | Performs aggregation and analysis of the collected performance data and determines SKU recommendations. | Y
291+
|`Assess` | Performs an assessment of the target SQL instance(s). | Y
292+
|`--outputFolder` | Folder which performance data, reports, and logs will be written to/read from. | N <br> (Default: current directory)
293+
|`--sqlConnectionStrings` | Quote-enclosed formal connection string(s) for the target SQL instance(s). | Y
294+
|`--overwrite` | Whether or not to overwrite any existing assessment or SKU recommendations reports. | N <br> ( Default: `true`)
295+
|`--perfQueryIntervalInSec` | Interval at which to query performance data, in seconds. | N <br> (Specific for `PerfDataCollection` action. Default `30`)
296+
|`--staticQueryIntervalInSec` | Interval at which to query and persist static configuration data, in seconds. | N <br> (Specific for `PerfDataCollection` action. Default `30`)
297+
|`--numberOfIterations` | Number of iterations of performance data collection to perform before persisting to file. | N <br> (Specific for `PerfDataCollection` action. Default `20`)
298+
|`--perfQueryIntervalInSec` | Interval at which performance data was queried, in seconds. | N <br> (Specific for `GetSkuRecommendation`action. This must match the value that was originally used during the performance data collection. Default: `30`)
299+
|`--targetPlatform` | Target platform for SKU recommendation: either `AzureSqlDatabase`, `AzureSqlManagedInstance`, `AzureSqlVirtualMachine`, or `Any`. | N <br> (Specific for `GetSkuRecommendation`action. Default: `Any`)
300+
|`--targetSqlInstance` | Name of the SQL instance that SKU recommendation will be targeting. | N <br> (Specific for `GetSkuRecommendation`action)
301+
|`--targetPercentile` | Percentile of data points to be used during aggregation of the performance data. | N <br> (Specific for `GetSkuRecommendation`action, Default `95`)
302+
|`--scalingFactor` | Scaling (comfort) factor used during SKU recommendation. | N <br> (Specific for `GetSkuRecommendation`action. Default `100`)
303+
|`--startTime` | UTC start time of performance data points to consider during aggregation, in `"YYYY-MM-DD HH:MM"` format. | N <br> (Specific for `GetSkuRecommendation`action)
304+
|`--endTime` | UTC end time of performance data points to consider during aggregation, in `"YYYY-MM-DD HH:MM"` format | N <br> (Specific for `GetSkuRecommendation`action)
305+
|`--displayResult` | Whether or not to print the SKU recommendation results to the console | N <br> (Specific for `GetSkuRecommendation`action.Default: `true`)
306306

307307
## Examples of SKU assessments using the CLI
308308

309-
**Dmacmd.exe**
309+
**SqlAssessment.exe**
310310

311-
`Dmacmd.exe /? or DmaCmd.exe /help`
311+
`SqlAssessment.exe --help`
312312

313-
**Azure SQL Database / Azure SQL Managed Instance SKU recommendation with price refresh (get latest prices) - Interactive authentication**
313+
**Start the data collection process for on-premises SQL Server instances**
314314

315315
```
316-
.\DmaCmd.exe /Action=SkuRecommendation
317-
/SkuRecommendationInputDataFilePath="C:\TestOut\out.csv"
318-
/SkuRecommendationTsvOutputResultsFilePath="C:\TestOut\prices.tsv"
319-
/SkuRecommendationJsonOutputResultsFilePath="C:\TestOut\prices.json"
320-
/SkuRecommendationOutputResultsFilePath="C:\TestOut\prices.html"
321-
/SkuRecommendationCurrencyCode=USD
322-
/SkuRecommendationOfferName=MS-AZR-0044p
323-
/SkuRecommendationRegionName=UKWest
324-
/SkuRecommendationSubscriptionId=<Your Subscription Id>
325-
/AzureAuthenticationClientId=<Your AzureAuthenticationClientId>
326-
/AzureAuthenticationTenantId=<Your AzureAuthenticationTenantId>
327-
/AzureAuthenticationInteractiveAuthentication=true
316+
.\SqlAssessment.exe PerfDataCollection
317+
--sqlConnectionStrings "Data Source=Server1;Initial Catalog=master;Integrated Security=True;" "Data Source=Server2;Initial Catalog=master;Integrated Security=True;"
318+
--outputFolder C:\Output
328319
```
329320

330-
**Azure SQL Database / Azure SQL Managed Instance SKU recommendation with price refresh (get latest prices) - Certificate authentication**
321+
**Azure SQL Database / Azure SQL Managed Instance / SQL Server on Azure VM SKU recommendations**
331322

332323
```
333-
.\DmaCmd.exe /Action=SkuRecommendation
334-
/SkuRecommendationInputDataFilePath="C:\TestOut\out.csv"
335-
/SkuRecommendationTsvOutputResultsFilePath="C:\TestOut\prices.tsv"
336-
/SkuRecommendationJsonOutputResultsFilePath="C:\TestOut\prices.json"
337-
/SkuRecommendationOutputResultsFilePath="C:\TestOut\prices.html"
338-
/SkuRecommendationCurrencyCode=USD
339-
/SkuRecommendationOfferName=MS-AZR-0044p
340-
/SkuRecommendationRegionName=UKWest
341-
/SkuRecommendationSubscriptionId=<Your Subscription Id>
342-
/AzureAuthenticationClientId=<Your AzureAuthenticationClientId>
343-
/AzureAuthenticationTenantId=<Your AzureAuthenticationTenantId>
344-
/AzureAuthenticationCertificateStoreLocation=<Your Certificate Store Location>
345-
/AzureAuthenticationCertificateThumbprint=<Your Certificate Thumbprint>
324+
.\SqlAssessment.exe GetSkuRecommendation
325+
--outputFolder C:\Output
326+
--targetPlatform Any
346327
```
347328

348-
**Azure SQL Database / Azure SQL Managed Instance recommendation with price refresh (get latest prices) - Token authentication and specify databases to recommend**
329+
**Azure SQL Managed Instance SKU recommendations with specific aggregation percentage for data points and custom scaling factor**
349330

331+
.\SqlAssessment.exe GetSkuRecommendation
332+
--outputFolder C:\Output
333+
--targetPlatform AzureSqlManagedInstance
334+
--targetPercentile 90
335+
--scalingFactor 80
350336
```
351-
.\DmaCmd.exe /Action=SkuRecommendation
352-
/SkuRecommendationInputDataFilePath="C:\TestOut\out.csv"
353-
/SkuRecommendationTsvOutputResultsFilePath="C:\TestOut\prices.tsv"
354-
/SkuRecommendationJsonOutputResultsFilePath="C:\TestOut\prices.json"
355-
/SkuRecommendationOutputResultsFilePath="C:\TestOut\prices.html"
356-
/SkuRecommendationCurrencyCode=USD
357-
/SkuRecommendationOfferName=MS-AZR-0044p
358-
/SkuRecommendationRegionName=UKWest
359-
/SkuRecommendationDatabasesToRecommend=“TPCDS1G,EDW_3G,TPCDS10G”
360-
/SkuRecommendationSubscriptionId=<Your Subscription Id>
361-
/AzureAuthenticationClientId=<Your AzureAuthenticationClientId>
362-
/AzureAuthenticationTenantId=<Your AzureAuthenticationTenantId>
363-
/AzureAuthenticationToken=<Your Authentication Token>
364-
```
365-
366-
**Azure SQL Database / Azure SQL Managed Instance SKU recommendation without price refresh (use static prices)**
367-
```
368-
.\DmaCmd.exe /Action=SkuRecommendation
369-
/SkuRecommendationInputDataFilePath="C:\TestOut\out.csv"
370-
/SkuRecommendationTsvOutputResultsFilePath="C:\TestOut\prices.tsv"
371-
/SkuRecommendationJsonOutputResultsFilePath="C:\TestOut\prices.json"
372-
/SkuRecommendationOutputResultsFilePath="C:\TestOut\prices.html"
373-
/SkuRecommendationPreventPriceRefresh=true
337+
338+
**SQL Server on Azure VM SKU recommendations with custom aggregation timeline**
339+
340+
.\SqlAssessment.exe GetSkuRecommendation
341+
--outputFolder C:\Output
342+
--targetPlatform AzureSqlVirtualMachine
343+
--startTime "2021-06-05 00:00"
344+
--endTime "2021-06-07 00:00"
374345
```
375346

376347
## See also

0 commit comments

Comments
 (0)