Skip to content

Commit ac0bfb9

Browse files
committed
manual merge the changes for mongodb migration help files
1 parent fdf7de0 commit ac0bfb9

File tree

3 files changed

+53
-10
lines changed

3 files changed

+53
-10
lines changed

src/ResourceManager/DataMigration/Commands.DataMigration/help/Invoke-AzDataMigrationCommand.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,27 @@ Creates a new command to be executed on an existing DMS task.
1313
## SYNTAX
1414

1515
```
16-
Invoke-AzDataMigrationCommand -CommandType <String> -ResourceGroupName <String> -ServiceName <String>
17-
-ProjectName <String> -TaskName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
16+
Invoke-AzDataMigrationCommand -CommandType <String> -ResourceGroupName <String> -ServiceName <String> [-ObjectName <ObjectName>]
17+
-ProjectName <String> -TaskName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1818
[<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
The New-AzDataMigrationCommand cmdlet creates a new command task to be run on an existing migration task.
22+
The Invoke-AzDataMigrationCommand cmdlet creates a new command task to be run on an existing migration task.
2323

2424
## EXAMPLES
2525

2626
### Example 1
2727
```
28-
PS C:\> $command = New-AzDmsCommand -CommandType Complete -ResourceGroupName $rg.ResourceGroupName -ServiceName $service.Name -ProjectName -TaskName $taskName -DatabaseName $output.DatabaseName
28+
PS C:\> $command = Invoke-AzDataMigrationCommand -CommandType Complete -ResourceGroupName $rg.ResourceGroupName -ServiceName $service.Name -ProjectName -TaskName $taskName -DatabaseName $output.DatabaseName
2929
```
3030

31-
The above examples uses the New-AzDmsCommand cmdlet to create a command for an existing service, project, and task
31+
The above examples uses the Invoke-AzDataMigrationCommand cmdlet to create a command for an existing service, project, and task
3232

3333
## PARAMETERS
3434

3535
### -CommandType
36-
Command Type.
36+
Command Type, possible values: Complete, Cancel, Restart, Finish
3737

3838
```yaml
3939
Type: System.String
@@ -51,7 +51,7 @@ Accept wildcard characters: False
5151
The credentials, account, tenant, and subscription used for communication with Azure.
5252
5353
```yaml
54-
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
54+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
5555
Parameter Sets: (All)
5656
Aliases: AzureRmContext, AzureCredential
5757

@@ -115,6 +115,20 @@ Type: System.String
115115
Parameter Sets: (All)
116116
Aliases:
117117

118+
Required: True
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
### -ObjectName
125+
The name of the database object the command will run against.
126+
127+
```yaml
128+
Type: System.String
129+
Parameter Sets: (All)
130+
Aliases:
131+
118132
Required: True
119133
Position: Named
120134
Default value: None

src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzDataMigrationConnectionInfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Accept wildcard characters: False
4747
```
4848
4949
### -ServerType
50-
Enum that describes server type to connect to. Currently supported values are SQL for SQL Server, Azure SQL Managed Instance and Azure SQL Database.
50+
Enum that describes server type to connect to. Currently supported values are SQL for SQL Server, Azure SQL Managed Instance, MongoDb, CosmosDb and Azure SQL Database.
5151
5252
```yaml
5353
Type: Microsoft.Azure.Commands.DataMigration.Models.ServerTypeEnum

src/ResourceManager/DataMigration/Commands.DataMigration/help/New-AzDataMigrationTask.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The New-AzDataMigrationTask cmdlet creates data migration task. This cmdlet take
3838

3939
### Example 1
4040
```
41-
PS C:\> New-AzDmsTask -TaskType MigrateSqlServerSqlDb -ResourceGroupName myResourceGroup -ServiceName TestService -ProjectName myDMSProject -TaskName MyMigrationTask -SourceConnection $sourceConnInfo -SourceCred $sourceCred -TargetConnection $targetConnInfo -TargetCred $targetCred -SelectedDatabase $selectedDbs
41+
PS C:\> New-AzDmsTask -TaskType MigrateSqlServerSqlDb -ResourceGroupName myResourceGroup -ServiceName TestService -ProjectName myDMSProject -TaskName MyMigrationTask -SourceConnection $sourceConnInfo -SourceCred $sourceCred -TargetConnection $targetConnInfo -TargetCred $targetCred -SelectedDatabase $selectedDbs -MigrationValidation $validationTask
4242
```
4343

4444
This example script shows how to create a new Data Migration Task named MyMigrationTask in the project named myDMSProject and service named TestService.
@@ -157,7 +157,7 @@ Task Type.
157157
Type: Microsoft.Azure.Commands.DataMigration.Models.TaskTypeEnum
158158
Parameter Sets: (All)
159159
Aliases:
160-
Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi, MigrateSqlServerSqlDbSync, ConnectToSourceSqlServerSync, ConnectToTargetSqlSync, GetUserTablesSqlSync, ValidateSqlServerSqlDbSync
160+
Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi, MigrateSqlServerSqlDbSync, ConnectToSourceSqlServerSync, ConnectToTargetSqlSync, GetUserTablesSqlSync, ValidateSqlServerSqlDbSync, ConnectToTargetMongoDb, ConnectToSourceMongoDb, MigrateMongoDb, ValidateMongoDbMigration
161161

162162
Required: True
163163
Position: Named
@@ -166,6 +166,35 @@ Accept pipeline input: False
166166
Accept wildcard characters: False
167167
```
168168
169+
### -MigrationValidation
170+
Task response object by validation call, optional but recommended.
171+
172+
```yaml
173+
Type: Microsoft.Azure.Commands.DataMigration.Models.PSProjectTask
174+
Parameter Sets: (All)
175+
Aliases:
176+
177+
Required: False
178+
Position: Named
179+
Default value: None
180+
Accept pipeline input: False
181+
Accept wildcard characters: False
182+
```
183+
184+
### -Wait
185+
Whether to wait for task to finish. If the flag is set, checks every one seconds till the task finishes and return to user the task properties where output or error can be inspected.
186+
```yaml
187+
Type: System.Management.Automation.SwitchParameter
188+
Parameter Sets: (All)
189+
Aliases:
190+
191+
Required: False
192+
Position: Named
193+
Default value: None
194+
Accept pipeline input: False
195+
Accept wildcard characters: False
196+
```
197+
169198
### -Confirm
170199
Prompts you for confirmation before running the cmdlet.
171200

0 commit comments

Comments
 (0)