Remove-AzDataMigrationProject

  • Reference
Module:
Az.DataMigration

Removes an Azure Database Migration Service (classic) project from Azure.

Syntax

Remove-AzDataMigrationProject
      -ResourceGroupName <String>
      -ServiceName <String>
      -Name <String>
      [-Force]
      [-DeleteRunningTask]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzDataMigrationProject
      [-InputObject] <PSProject>
      [-Force]
      [-DeleteRunningTask]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzDataMigrationProject
      [-ResourceId] <String>
      [-Force]
      [-DeleteRunningTask]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzDataMigrationProject cmdlet removes an Azure Database Migration Service (classic) project from Azure. Supplying the DeleteRunningTask parameter removes all of the Azure Database Migration Service (classic) tasks associated with the project that is being removed.

Examples

Example 1

Remove-AzDataMigrationProject -ResourceGroupName myResourceGroup -ServiceName myDMService -ProjectName myDMProject

The above example removes the Azure Database Migration Service (classic) project called myDMProject from Azure based on name as input parameter

Example 2

Remove-AzDataMigrationProject -InputObject $myDMSProject

The above example removes the Azure Database Migration Service (classic) project based on PSProject object as input parameter.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

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

-DeleteRunningTask

Delete any running task

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

-Force

Skip confirmation message for performing the action

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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 project.

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

-PassThru

Returns an true/false. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-ServiceName

Azure Database Migration Service (classic) Name.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSProject

String

Outputs

Boolean