Edit

Share via


Remove-SPOMigrationJob

Cmdlet to remove a previously created migration job from the specified site collection.

Syntax

Default (Default)

Remove-SPOMigrationJob
    [-TargetWebUrl] <String>
    [-JobId] <Guid>
    -Credentials <CredentialCmdletPipeBind>
    [-NoLogFile]
    [<CommonParameters>]

Description

Cmdlet to remove a previously created migration job from the specified site collection.

Examples

Example 1

Remove-SPOMigrationJob -JobId 4da9e777-3e38-4804-96d9-ddeebe7dfa79 -TargetUrl https://contoso.sharepoint.com/sites/TargetSite

This example removes the specified migration job from the site collection "https://contoso.sharepoint.com/sites/TargetSite".

Parameters

-Credentials

Applicable: SharePoint Online

Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session's previous call to Connect-SPOService will be used to connect to the site collection.

Parameter properties

Type:Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobId

Applicable: SharePoint Online

Id of a previously created migration job that exists on the target site collection.

Parameter properties

Type:System.Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoLogFile

Applicable: SharePoint Online

Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetWebUrl

Applicable: SharePoint Online

The fully qualified URL of the site collection where the job will be deleted if found.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
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.

Inputs

None

Outputs

System.Object