Skip to content

Commit

Permalink
[Az.DataMigration] Change Azure Database Migration Service in documen…
Browse files Browse the repository at this point in the history
…tation to Azure Database Migration Service (classic) (#20893)

* Rename Azure Database migration Service to Azure Database Migration Service (classic)

* fix PR comments
  • Loading branch information
ash1625 authored Feb 13, 2023
1 parent 58aa75d commit 565c798
Show file tree
Hide file tree
Showing 26 changed files with 93 additions and 93 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
namespace Microsoft.Azure.Commands.DataMigration.Cmdlets
{
/// <summary>
/// Cmdlet for getting Data Migration Service resource
/// Cmdlet for getting Azure Data Migration Service (classic) resource
/// </summary>
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "DataMigrationService", DefaultParameterSetName = ResourceGroupSet), OutputType(typeof(PSDataMigrationService))]
[Alias("Get-" + ResourceManager.Common.AzureRMConstants.AzureRMPrefix+ "Dms")]
Expand Down Expand Up @@ -52,12 +52,12 @@ public class GetAzureDataMigrationService : DataMigrationCmdlet
public string ResourceGroupName { get; set; }

/// <summary>
/// Gets or sets the name of the data migration service.
/// Gets or sets the name of the Azure Database Migration Service (classic).
/// </summary>
[Parameter(Mandatory = true,
Position = 1,
ParameterSetName = ServiceNameGroupSet,
HelpMessage = "Name of Database Migration Service.")]
HelpMessage = "Name of Azure Database Migration Service (classic).")]
[ValidateNotNullOrEmpty]
[Alias("ServiceName")]
public string Name { get; set; }
Expand Down
6 changes: 3 additions & 3 deletions src/DataMigration/DataMigration/Cmdlets/GetProjectCmdlet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
namespace Microsoft.Azure.Commands.DataMigration.Cmdlets
{
/// <summary>
/// Class for the command let that creates a new instance of the Data Migration Service.
/// Class for the command let that creates a new instance of the Azure Database Migration Service (classic).
/// </summary>
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "DataMigrationProject", DefaultParameterSetName = ComponentNameParameterSet), OutputType(typeof(PSProject))]
[Alias("Get-" + ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "DmsProject")]
Expand All @@ -43,7 +43,7 @@ public class GetProjectCmdlet : DataMigrationCmdlet
Mandatory = true,
ParameterSetName = ResourceIdParameterSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "DataMigrationService Resource Id.")]
HelpMessage = "Azure Database Migration Service (classic) Resource Id.")]
[ValidateNotNullOrEmpty]
public string ResourceId { get; set; }

Expand All @@ -58,7 +58,7 @@ public class GetProjectCmdlet : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,29 +35,29 @@ public sealed class NewAzureRmDataMigrationService : DataMigrationCmdlet

[Parameter(
Mandatory = true,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
[Alias("ServiceName")]
public string Name { get; set; }

[Parameter(
Mandatory = true,
HelpMessage = "The location of the instance of the Database Migration Service to be created. "
HelpMessage = "The location of the instance of the Azure Database Migration Service (classic) to be created. "
+ "This corresponds to an Azure region.")]
[ValidateNotNullOrEmpty]
public string Location { get; set; }

[Parameter(
Mandatory = true,
HelpMessage = "The SKU for DataMigration service instance, possible values are GeneralPurpose_1vCore, GeneralPurpose_2vCores, GeneralPurpose_4vCores, BusinessCritical_4vCores"
HelpMessage = "The SKU for Azure Database Migration service (classic) instance, possible values are GeneralPurpose_1vCore, GeneralPurpose_2vCores, GeneralPurpose_4vCores, BusinessCritical_4vCores"
)]
[ValidateNotNullOrEmpty]
[PSArgumentCompleter("GeneralPurpose_1vCore", "GeneralPurpose_2vCores", "GeneralPurpose_4vCores", "BusinessCritical_4vCores")]
public string Sku { get; set; }

[Parameter(
Mandatory = true,
HelpMessage = "The name of the subnet under the specified virtual network to be used for the Database Migration Service instance.")]
HelpMessage = "The name of the subnet under the specified virtual network to be used for the Azure Database Migration Service (classic) instance.")]
[ValidateNotNullOrEmpty]
public string VirtualSubnetId { get; set; }

Expand All @@ -73,7 +73,7 @@ public override void ExecuteCmdlet()
}

/// <summary>
/// Helper method that calls the creation of an instance of the Database Migration Service
/// Helper method that calls the creation of an instance of the Azure Database Migration Service (classic)
/// </summary>
/// <returns>The instance of PSDataMigrationService that was created.</returns>
public DataMigrationService CreateService()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public TaskTypeEnum TaskType
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

Expand Down
6 changes: 3 additions & 3 deletions src/DataMigration/DataMigration/Cmdlets/NewProjectCmdlet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public class NewProjectCmdlet : DataMigrationCmdlet
Mandatory = true,
ParameterSetName = ResourceIdParameterSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "DataMigrationService Resource Id.")]
HelpMessage = "Azure Database Migration Service (classic) Resource Id.")]
[ValidateNotNullOrEmpty]
public string ResourceId { get; set; }

Expand All @@ -59,13 +59,13 @@ public class NewProjectCmdlet : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

[Parameter(
Mandatory = true,
HelpMessage = "The location of the instance of the Database Migration Service")]
HelpMessage = "The location of the instance of the Azure Database Migration Service (classic)")]
[ValidateNotNullOrEmpty]
public string Location { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class RemoveDataMigrationProject : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public class RemoveDataMigrationService : DataMigrationCmdlet
Mandatory = true,
ParameterSetName = ResourceIdParameterSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "DataMigrationService Resource Id.")]
HelpMessage = "Azure Database Migration Service (classic) Resource Id.")]
[ValidateNotNullOrEmpty]
public string ResourceId { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class RemoveDataMigrationTask : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class StartDataMigrationService : DataMigrationCmdlet
Mandatory = true,
ParameterSetName = ResourceIdParameterSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "DataMigrationService Resource Id.")]
HelpMessage = "Azure Database Migration Service (classic) Resource Id.")]
[ValidateNotNullOrEmpty]
public string ResourceId { get; set; }

Expand All @@ -53,7 +53,7 @@ public class StartDataMigrationService : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
[Alias("ServiceName")]
public string Name { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class StopDataMigrationService : DataMigrationCmdlet
Mandatory = true,
ParameterSetName = ResourceIdParameterSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "DataMigrationService Resource Id.")]
HelpMessage = "Azure Database Migration Service (classic) Resource Id.")]
[ValidateNotNullOrEmpty]
public string ResourceId { get; set; }

Expand All @@ -53,7 +53,7 @@ public class StopDataMigrationService : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
[Alias("ServiceName")]
public string Name { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class StopDataMigrationTask : DataMigrationCmdlet
[Parameter(
Mandatory = true,
ParameterSetName = ComponentNameParameterSet,
HelpMessage = "Database Migration Service Name.")]
HelpMessage = "Azure Database Migration Service (classic) Name.")]
[ValidateNotNullOrEmpty]
public string ServiceName { get; set; }

Expand Down
30 changes: 15 additions & 15 deletions src/DataMigration/DataMigration/help/Az.DataMigration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Start assessment on SQL Server instance(s)
Collect performance data for given SQL Server instance(s)

### [Get-AzDataMigrationProject](Get-AzDataMigrationProject.md)
Retrieves the properties of an Azure Database Migration project.
Retrieves the properties of an Azure Database Migration Service (classic) project.

### [Get-AzDataMigrationService](Get-AzDataMigrationService.md)
Retrieves the properties associated with an instance of the Azure Database Migration Service.
Retrieves the properties associated with an instance of the Azure Database Migration Service (classic).

### [Get-AzDataMigrationSkuRecommendation](Get-AzDataMigrationSkuRecommendation.md)
Gives SKU recommendations for Azure SQL offerings
Expand All @@ -39,7 +39,7 @@ Retrieve the registered Integration Runtime nodes and their monitoring data for
Retrieve the List of database migrations attached to the service.

### [Get-AzDataMigrationTask](Get-AzDataMigrationTask.md)
Retrieves the PSProjectTask object associated with an Azure Database Migration Service migration task.
Retrieves the PSProjectTask object associated with an Azure Database Migration Service (classic) migration task.

### [Get-AzDataMigrationToSqlDb](Get-AzDataMigrationToSqlDb.md)
Retrieve the specified database migration for a given SQL Db.
Expand All @@ -51,7 +51,7 @@ Retrieve the specified database migration for a given SQL Managed Instance.
Retrieve the specified database migration for a given SQL VM.

### [Invoke-AzDataMigrationCommand](Invoke-AzDataMigrationCommand.md)
Creates a new command to be executed on an existing DMS task.
Creates a new command to be executed on an existing DMS (classic) task.

### [Invoke-AzDataMigrationCutoverToSqlManagedInstance](Invoke-AzDataMigrationCutoverToSqlManagedInstance.md)
Initiate cutover for in-progress online database migration to SQL Managed Instance.
Expand All @@ -66,10 +66,10 @@ Create a new instance DataMigration Azure ActiveDirectory Application details.
Creates a new Connection Info object specifying the server type and name for connection.

### [New-AzDataMigrationDatabaseInfo](New-AzDataMigrationDatabaseInfo.md)
Creates the DatabaseInfo object for the Azure Database Migration Service, which specifies the database source for migration.
Creates the DatabaseInfo object for the Azure Database Migration Service (classic), which specifies the database source for migration.

### [New-AzDataMigrationFileShare](New-AzDataMigrationFileShare.md)
Creates the FileShare object for the Azure Database Migration Service, which specifies the local network share to take the source database backups to.
Creates the FileShare object for the Azure Database Migration Service (classic), which specifies the local network share to take the source database backups to.

### [New-AzDataMigrationLoginsMigration](New-AzDataMigrationLoginsMigration.md)
Migrate logins from the source Sql Servers to the target Azure Sql Servers.
Expand All @@ -81,13 +81,13 @@ Creates collection setting for migration according for the mongoDb migration
Creates database setting for migration for the mongoDb migration

### [New-AzDataMigrationProject](New-AzDataMigrationProject.md)
Creates a new Azure Database Migration Service project.
Creates a new Azure Database Migration Service (classic) project.

### [New-AzDataMigrationSelectedDBObject](New-AzDataMigrationSelectedDBObject.md)
Creates a database input object that contains information about source and target databases for migration.

### [New-AzDataMigrationService](New-AzDataMigrationService.md)
Creates a new instance of the Azure Database Migration Service.
Creates a new instance of the Azure Database Migration Service (classic).

### [New-AzDataMigrationSqlService](New-AzDataMigrationSqlService.md)
Create or Update Database Migration Service.
Expand All @@ -99,7 +99,7 @@ Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.
Creates a database info object specific to the sync scenario to be used for a migration task.

### [New-AzDataMigrationTask](New-AzDataMigrationTask.md)
Creates and starts a data migration task in the Azure Database Migration Service.
Creates and starts a data migration task in the Azure Database Migration Service (classic).

### [New-AzDataMigrationToSqlDb](New-AzDataMigrationToSqlDb.md)
Create a new database migration to a given SQL Db.
Expand All @@ -114,10 +114,10 @@ Create a new database migration to a given SQL VM.
Registers Sql Migration Service on Integration Runtime

### [Remove-AzDataMigrationProject](Remove-AzDataMigrationProject.md)
Removes an Azure Database Migration Service project from Azure.
Removes an Azure Database Migration Service (classic) project from Azure.

### [Remove-AzDataMigrationService](Remove-AzDataMigrationService.md)
Removes an instance of the Azure Database Migration Service from Azure.
Removes an instance of the Azure Database Migration Service (classic) from Azure.

### [Remove-AzDataMigrationSqlService](Remove-AzDataMigrationSqlService.md)
Delete Database Migration Service.
Expand All @@ -126,19 +126,19 @@ Delete Database Migration Service.
Delete the integration runtime node.

### [Remove-AzDataMigrationTask](Remove-AzDataMigrationTask.md)
Removes an Azure Database Migration Service task from Azure.
Removes an Azure Database Migration Service (classic) task from Azure.

### [Remove-AzDataMigrationToSqlDb](Remove-AzDataMigrationToSqlDb.md)
Remove the specified database migration for a given SQL Db.

### [Start-AzDataMigrationService](Start-AzDataMigrationService.md)
Starts an instance of the Azure Database Migration Service in a stopped state.
Starts an instance of the Azure Database Migration Service (classic) in a stopped state.

### [Stop-AzDataMigrationService](Stop-AzDataMigrationService.md)
Stops an instance of the Azure Database Migration Service that is in a running state.
Starts an instance of the Azure Database Migration Service (classic) in a stopped state.

### [Stop-AzDataMigrationTask](Stop-AzDataMigrationTask.md)
Stops an Azure Database Migration Service task that is in a running state.
Stops an Azure Database Migration Service (classic) task that is in a running state.

### [Stop-AzDataMigrationToSqlDb](Stop-AzDataMigrationToSqlDb.md)
Stop in-progress database migration to SQL Db.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzDataMigrationProject

## SYNOPSIS
Retrieves the properties of an Azure Database Migration project.
Retrieves the properties of an Azure Database Migration Service (classic) project.

## SYNTAX

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzDataMigrationService

## SYNOPSIS
Retrieves the properties associated with an instance of the Azure Database Migration Service.
Retrieves the properties associated with an instance of the Azure Database Migration Service (classic).

## SYNTAX

Expand All @@ -31,7 +31,7 @@ Get-AzDataMigrationService [-ResourceGroupName] <String> [-Name] <String>
```

## DESCRIPTION
The Get-AzDataMigrationService cmdlet retrieves the properties associated with an instance of the Azure Database Migration Service based on Service name and Azure Resource Group name as input parameters.
The Get-AzDataMigrationService cmdlet retrieves the properties associated with an instance of the Azure Database Migration Service (classic) based on Service name and Azure Resource Group name as input parameters.

## EXAMPLES

Expand All @@ -40,14 +40,14 @@ The Get-AzDataMigrationService cmdlet retrieves the properties associated with a
Get-AzDataMigrationService -ResourceGroupName testResourceGroup -Name testService
```

The above example retrieves the properties of the Azure Database Migration Service instance called testService.
The above example retrieves the properties of the Azure Database Migration Service (classic) instance called testService.

### Example 2
```powershell
Get-AzDataMigrationService -ResourceGroupName testResourceGroup
```

The above example retrieves Azure Database Migration Services in the resource group called testResourceGroup.
The above example retrieves Azure Database Migration Services (classic) in the resource group called testResourceGroup.

## PARAMETERS

Expand All @@ -67,7 +67,7 @@ Accept wildcard characters: False
```
### -Name
Name of Database Migration Service.
Name of Azure Database Migration Service (classic).
```yaml
Type: System.String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzDataMigrationTask

## SYNOPSIS
Retrieves the PSProjectTask object associated with an Azure Database Migration Service migration task.
Retrieves the PSProjectTask object associated with an Azure Database Migration Service (classic) migration task.

## SYNTAX

Expand Down Expand Up @@ -67,7 +67,7 @@ Get-AzDataMigrationTask -ResourceGroupName <String> -ServiceName <String> -Proje
```

## DESCRIPTION
The Get-AzDataMigrationTask cmdlet retrieves the properties associated with an Azure Database Migration Service migration task.
The Get-AzDataMigrationTask cmdlet retrieves the properties associated with an Azure Database Migration Service (classic) migration task.

## EXAMPLES

Expand All @@ -76,7 +76,7 @@ The Get-AzDataMigrationTask cmdlet retrieves the properties associated with an A
Get-AzDataMigrationTask -TaskName myTestTask -ServiceName myTestService -ProjectName MyTestProject -ResourceGroupName MyResourceGroup -Expand
```

The above example illustrates the use of Get-AzDataMigrationTask cmdlet to retrieve the properties associated with an Azure Database Migration Service migration task based on task name passed in as input parameter
The above example illustrates the use of Get-AzDataMigrationTask cmdlet to retrieve the properties associated with an Azure Database Migration Service (classic) migration task based on task name passed in as input parameter

### Example 2
```powershell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Invoke-AzDataMigrationCommand

## SYNOPSIS
Creates a new command to be executed on an existing DMS task.
Creates a new command to be executed on an existing DMS (classic) task.

## SYNTAX

Expand Down
Loading

0 comments on commit 565c798

Please sign in to comment.