Edit

Update-AzImportExport

  • Reference
Module:
Az.ImportExport

Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.

Syntax

Update-AzImportExport
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AcceptLanguage <String>]
      [-BackupDriveManifest]
      [-CancelRequested]
      [-DeliveryPackageCarrierName <String>]
      [-DeliveryPackageDriveCount <Int64>]
      [-DeliveryPackageShipDate <String>]
      [-DeliveryPackageTrackingNumber <String>]
      [-DriveList <IDriveStatus[]>]
      [-LogLevel <String>]
      [-ReturnAddressCity <String>]
      [-ReturnAddressCountryOrRegion <String>]
      [-ReturnAddressEmail <String>]
      [-ReturnAddressPhone <String>]
      [-ReturnAddressPostalCode <String>]
      [-ReturnAddressRecipientName <String>]
      [-ReturnAddressStateOrProvince <String>]
      [-ReturnAddressStreetAddress1 <String>]
      [-ReturnAddressStreetAddress2 <String>]
      [-ReturnShippingCarrierAccountNumber <String>]
      [-ReturnShippingCarrierName <String>]
      [-State <String>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzImportExport
      -InputObject <IImportExportIdentity>
      [-AcceptLanguage <String>]
      [-BackupDriveManifest]
      [-CancelRequested]
      [-DeliveryPackageCarrierName <String>]
      [-DeliveryPackageDriveCount <Int64>]
      [-DeliveryPackageShipDate <String>]
      [-DeliveryPackageTrackingNumber <String>]
      [-DriveList <IDriveStatus[]>]
      [-LogLevel <String>]
      [-ReturnAddressCity <String>]
      [-ReturnAddressCountryOrRegion <String>]
      [-ReturnAddressEmail <String>]
      [-ReturnAddressPhone <String>]
      [-ReturnAddressPostalCode <String>]
      [-ReturnAddressRecipientName <String>]
      [-ReturnAddressStateOrProvince <String>]
      [-ReturnAddressStreetAddress1 <String>]
      [-ReturnAddressStreetAddress2 <String>]
      [-ReturnShippingCarrierAccountNumber <String>]
      [-ReturnShippingCarrierName <String>]
      [-State <String>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.

Examples

Example 1: Update ImportExport job by resource group and server name

Update-AzImportExport -Name test-job -ResourceGroupName ImportTestRG -DeliveryPackageCarrierName pwsh -DeliveryPackageTrackingNumber pwsh20200000

Location Name     Type
-------- ----     ----
East US  test-job Microsoft.ImportExport/jobs

This cmdlet updates ImportExport job by resource group and server name.

Example 2: Update ImportExport job by identity.

Get-AzImportExport -Name test-job -ResourceGroupName ImportTestRG | Update-AzImportExport -CancelRequested

Location Name     Type
-------- ----     ----
East US  test-job Microsoft.ImportExport/jobs

This cmdlet updates 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

-BackupDriveManifest

Indicates whether the manifest files on the drives should be copied to block blobs.

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

-CancelRequested

If specified, the value must be true. The service will attempt to cancel the job.

Type:SwitchParameter
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

-DeliveryPackageCarrierName

The name of the carrier that is used to ship the import or export drives.

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

-DeliveryPackageDriveCount

The number of drives included in the package.

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

-DeliveryPackageShipDate

The date when the package is shipped.

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

-DeliveryPackageTrackingNumber

The tracking number of the package.

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

-DriveList

List of drives that comprise the job. To construct, see NOTES section for DRIVELIST properties and create a hash table.

Type:IDriveStatus[]
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

-LogLevel

Indicates whether error logging or verbose logging is enabled.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-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

-ReturnAddressCity

The city name to use when returning the drives.

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

-ReturnAddressCountryOrRegion

The country or region to use when returning the drives.

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

-ReturnAddressEmail

Email address of the recipient of the returned drives.

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

-ReturnAddressPhone

Phone number of the recipient of the returned drives.

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

-ReturnAddressPostalCode

The postal code to use when returning the drives.

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

-ReturnAddressRecipientName

The name of the recipient who will receive the hard drives when they are returned.

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

-ReturnAddressStateOrProvince

The state or province to use when returning the drives.

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

-ReturnAddressStreetAddress1

The first line of the street address to use when returning the drives.

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

-ReturnAddressStreetAddress2

The second line of the street address to use when returning the drives.

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

-ReturnShippingCarrierAccountNumber

The customer's account number with the carrier.

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

-ReturnShippingCarrierName

The carrier's name.

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

-State

If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail.

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

-Tag

Specifies the tags that will be assigned to the job.

Type:Hashtable
Position:Named
Default value:None
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

IJobResponse

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.

DRIVELIST <IDriveStatus[]>: List of drives that comprise the job.

  • [BitLockerKey <String>]: The BitLocker key used to encrypt the drive.
  • [BytesSucceeded <Int64?>]: Bytes successfully transferred for the drive.
  • [CopyStatus <String>]: Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state.
  • [DriveHeaderHash <String>]: The drive header hash value.
  • [DriveId <String>]: The drive's hardware serial number, without spaces.
  • [ErrorLogUri <String>]: A URI that points to the blob containing the error log for the data transfer operation.
  • [ManifestFile <String>]: The relative path of the manifest file on the drive.
  • [ManifestHash <String>]: The Base16-encoded MD5 hash of the manifest file on the drive.
  • [ManifestUri <String>]: A URI that points to the blob containing the drive manifest file.
  • [PercentComplete <Int64?>]: Percentage completed for the drive.
  • [State <DriveState?>]: The drive's current state.
  • [VerboseLogUri <String>]: A URI that points to the blob containing the verbose log for the data transfer operation.

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.