Get-AzureRmDataMigrationTask

Reference

Module:: AzureRM.DataMigration

Retrieves the PSProjectTask object associated with an Azure Database Migration Service migration task.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmDataMigrationTask
   -ResourceGroupName <String>
   -ServiceName <String>
   -ProjectName <String>
   [-TaskType <TaskTypeEnum>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   [-InputObject] <PSProject>
   [-TaskType <TaskTypeEnum>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   [-InputObject] <PSProject>
   -Name <String>
   [-Expand]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   [-InputObject] <PSProject>
   -Name <String>
   [-Expand]
   -ResultType <ResultTypeEnum>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   [-ResourceId] <String>
   [-TaskType <TaskTypeEnum>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   [-ResourceId] <String>
   -Name <String>
   [-Expand]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   [-ResourceId] <String>
   -Name <String>
   [-Expand]
   -ResultType <ResultTypeEnum>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   -ResourceGroupName <String>
   -ServiceName <String>
   -ProjectName <String>
   [-Name <String>]
   [-Expand]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmDataMigrationTask
   -ResourceGroupName <String>
   -ServiceName <String>
   -ProjectName <String>
   -Name <String>
   [-Expand]
   -ResultType <ResultTypeEnum>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmDataMigrationTask cmdlet retrieves the properties associated with an Azure Database Migration Service migration task.

Examples

Example 1

PS C:\> Get -AzureRmDataMigrationTask -TaskName myTestTask -ServiceName myTestService -ProjectName MyTestProject -ResourceGroupName MyResourceGroup -Expand

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

Example 2

PS C:\> Get -AzureRmDataMigrationTask -Project $myProject

The above example illustrates the use of Get-AzureRmDataMigrationTask cmdlet to retrieve all of the migration tasks associated with PSProject object passed in as input parameter

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Expand

Expand output

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

PSProject Object.

Type:	PSProject
Aliases:	Project
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the task.

Type:	String
Aliases:	TaskName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProjectName

The name of the project.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

Project Resource Id.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResultType

Expand output of given result type.

Type:	ResultTypeEnum
Accepted values:	MigrationLevelOutput, DatabaseLevelOutput, TableLevelOutput, MigrationValidationOutput, MigrationValidationDatabaseLevelOutput, LoginLevelOutput, AgentJobLevelOutput
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceName

Database Migration Service Name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-TaskType

Filter by TaskType.

Type:	Nullable<T>[TaskTypeEnum]
Accepted values:	MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSProject

Parameters: InputObject (ByValue)

String

Outputs

PSProjectTask

Share via