Remove-AzImportExport

Reference

Module:: Az.ImportExport

Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

Syntax

Remove-AzImportExport
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AcceptLanguage <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Remove-AzImportExport
      -InputObject <IImportExportIdentity>
      [-AcceptLanguage <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

Examples

Example 1: Remove ImportExport job by resourceGroup and server name

Remove-AzImportExport -Name test-job -ResourceGroupName ImportTestRG

This cmdlet removes ImportExport job by resourceGroup and server name.

Example 2: Remove ImportExport job by identity

Get-AzImportExport -Name test-job -ResourceGroupName ImportTestRG | Remove-AzImportExport

These cmdlet removes ImportExport job by identity.

Parameters

-AcceptLanguage

Specifies the preferred language for the response.

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

-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:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the import/export job.

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

-PassThru

Returns true when the command succeeds

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

-ResourceGroupName

The resource group name uniquely identifies the resource group within the user subscription.

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

-SubscriptionId

The subscription ID for the Azure user.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
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

IImportExportIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IImportExportIdentity>: Identity Parameter

[Id <String>]: Resource identity path
[JobName <String>]: The name of the import/export job.
[LocationName <String>]: The name of the location. For example, West US or westus.
[ResourceGroupName <String>]: The resource group name uniquely identifies the resource group within the user subscription.
[SubscriptionId <String>]: The subscription ID for the Azure user.

Share via