Get-AzDataMigrationTask
Retrieves the PSProjectTask object associated with an Azure Database Migration Service (classic) migration task.
Syntax
ListByComponent (Default)
Get-AzDataMigrationTask
-ResourceGroupName <String>
-ServiceName <String>
-ProjectName <String>
[-TaskType <TaskTypeEnum>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzDataMigrationTask
[-InputObject] <PSProject>
[-TaskType <TaskTypeEnum>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzDataMigrationTask
[-InputObject] <PSProject>
-Name <String>
[-Expand]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzDataMigrationTask
[-InputObject] <PSProject>
-Name <String>
-ResultType <ResultTypeEnum>
[-Expand]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ListByResourceId
Get-AzDataMigrationTask
[-ResourceId] <String>
[-TaskType <TaskTypeEnum>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceId
Get-AzDataMigrationTask
[-ResourceId] <String>
-Name <String>
[-Expand]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdResultType
Get-AzDataMigrationTask
[-ResourceId] <String>
-Name <String>
-ResultType <ResultTypeEnum>
[-Expand]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByComponent
Get-AzDataMigrationTask
-ResourceGroupName <String>
-ServiceName <String>
-ProjectName <String>
[-Name <String>]
[-Expand]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByComponentResultType
Get-AzDataMigrationTask
-ResourceGroupName <String>
-ServiceName <String>
-ProjectName <String>
-Name <String>
-ResultType <ResultTypeEnum>
[-Expand]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzDataMigrationTask cmdlet retrieves the properties associated with an Azure Database Migration Service (classic) migration task.
Examples
Example 1
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 (classic) migration task based on task name passed in as input parameter
Example 2
Get-AzDataMigrationTask -Project $myProject
The above example illustrates the use of Get-AzDataMigrationTask 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.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Expand
Expand output
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False
Parameter sets
GetByInputObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponent
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
PSProject Object.
Type: PSProject
Default value: None Supports wildcards: False DontShow: False Aliases: Project
ListByInputObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the task.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: TaskName
Parameter sets
GetByInputObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByInputObjectResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByResourceIdResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponentResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProjectName
The name of the project.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ListByComponent
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponent
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponentResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ListByComponent
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponent
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponentResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
Project Resource Id.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ListByResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResultType
Expand output of given result type.
Parameter properties
Type: ResultTypeEnum
Default value: None Accepted values: MigrationLevelOutput, DatabaseLevelOutput, TableLevelOutput, MigrationValidationOutput, MigrationValidationDatabaseLevelOutput, LoginLevelOutput, AgentJobLevelOutput, Command Supports wildcards: False DontShow: False
Parameter sets
GetByInputObjectResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByResourceIdResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponentResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServiceName
Database Migration Service Name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ListByComponent
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponent
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetByComponentResultType
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TaskType
Filter by TaskType.
Parameter properties
Type: Nullable<T> [ TaskTypeEnum ]
Default value: None Accepted values: MigrateSqlServerSqlDb, ConnectToSourceSqlServer, ConnectToTargetSqlDb, GetUserTablesSql, ConnectToTargetSqlDbMi, MigrateSqlServerSqlDbMi, ValidateSqlServerSqlDbMi, MigrateSqlServerSqlDbSync, ConnectToSourceSqlServerSync, ConnectToTargetSqlSync, GetUserTablesSqlSync, ValidateSqlServerSqlDbSync, ConnectToSourceMongoDb, ConnectToTargetMongoDb, MigrateMongoDb, ValidateMongoDbMigration, ConnectToTargetSqlDbMiSync, ValidateSqlServerSqlDbMiSync, MigrateSqlServerSqlDbMiSync Supports wildcards: False DontShow: False
Parameter sets
ListByComponent
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ListByInputObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ListByResourceId
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
