New-AzImportExport
Creates a new job or updates an existing job in the specified subscription.
Syntax
New-AzImportExport
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AcceptLanguage <String>]
[-ClientTenantId <String>]
[-BackupDriveManifest]
[-BlobListBlobPath <String[]>]
[-BlobListBlobPathPrefix <String[]>]
[-CancelRequested]
[-DeliveryPackageCarrierName <String>]
[-DeliveryPackageDriveCount <Int64>]
[-DeliveryPackageShipDate <String>]
[-DeliveryPackageTrackingNumber <String>]
[-DiagnosticsPath <String>]
[-DriveList <IDriveStatus[]>]
[-EncryptionKeyKekType <EncryptionKekType>]
[-EncryptionKeyKekUrl <String>]
[-EncryptionKeyKekVaultId <String>]
[-ExportBlobListBlobPath <String>]
[-IncompleteBlobListUri <String>]
[-JobType <String>]
[-Location <String>]
[-LogLevel <String>]
[-PercentComplete <Int64>]
[-ProvisioningState <String>]
[-ReturnAddressCity <String>]
[-ReturnAddressCountryOrRegion <String>]
[-ReturnAddressEmail <String>]
[-ReturnAddressPhone <String>]
[-ReturnAddressPostalCode <String>]
[-ReturnAddressRecipientName <String>]
[-ReturnAddressStateOrProvince <String>]
[-ReturnAddressStreetAddress1 <String>]
[-ReturnAddressStreetAddress2 <String>]
[-ReturnPackageCarrierName <String>]
[-ReturnPackageDriveCount <Int64>]
[-ReturnPackageShipDate <String>]
[-ReturnPackageTrackingNumber <String>]
[-ReturnShippingCarrierAccountNumber <String>]
[-ReturnShippingCarrierName <String>]
[-ShippingInformationCity <String>]
[-ShippingInformationCountryOrRegion <String>]
[-ShippingInformationPhone <String>]
[-ShippingInformationPostalCode <String>]
[-ShippingInformationRecipientName <String>]
[-ShippingInformationStateOrProvince <String>]
[-ShippingInformationStreetAddress1 <String>]
[-ShippingInformationStreetAddress2 <String>]
[-State <String>]
[-StorageAccountId <String>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Creates a new job or updates an existing job in the specified subscription.
Examples
Example 1: Create a new ImportExport job
$driveList = @( @{ DriveId = "9CA995BA"; BitLockerKey = "238810-662376-448998-450120-652806-203390-606320-483076"; ManifestFile = "\\DriveManifest.xml"; ManifestHash = "109B21108597EF36D5785F08303F3638"; DriveHeaderHash = "" })
New-AzImportExport -Name test-job -ResourceGroupName ImportTestRG -Location eastus -StorageAccountId "/subscriptions/<SubscriptionId>/resourcegroups/ImportTestRG/providers/Microsoft.Storage/storageAccounts/teststorageforimport" -JobType Import -ReturnAddressRecipientName "Some name" -ReturnAddressStreetAddress1 "Street1" -ReturnAddressCity "Redmond" -ReturnAddressStateOrProvince "WA" -ReturnAddressPostalCode "98008" -ReturnAddressCountryOrRegion "USA" -ReturnAddressPhone "4250000000" -ReturnAddressEmail test@contoso.com -DiagnosticsPath "waimportexport" -BackupDriveManifest -DriveList $driveList
Location Name Type
-------- ---- ----
eastus test-job Microsoft.ImportExport/jobsThese cmdlets create a new ImportExport job.
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
Default value is false. 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 |
-BlobListBlobPath
A collection of blob-path strings.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BlobListBlobPathPrefix
A collection of blob-prefix strings.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CancelRequested
Indicates whether a request has been submitted to cancel the job.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientTenantId
The tenant ID of the client making the request.
| 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 DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| 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 |
-DiagnosticsPath
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DriveList
List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs. 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 |
-EncryptionKeyKekType
The type of kek encryption key
| Type: | EncryptionKekType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionKeyKekUrl
Specifies the url for kek encryption key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionKeyKekVaultId
Specifies the keyvault resource id for kek encryption key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExportBlobListBlobPath
The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncompleteBlobListUri
A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobType
The type of job
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Specifies the supported Azure location where the job should be created
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel
Default value is Error. Indicates whether error logging or verbose logging will be 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 |
-PercentComplete
Overall percentage completed for the job.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningState
Specifies the provisioning state of the job.
| Type: | String |
| 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 |
-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 |
-ReturnPackageCarrierName
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 |
-ReturnPackageDriveCount
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 |
-ReturnPackageShipDate
The date when the package is shipped.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnPackageTrackingNumber
The tracking number of the package.
| 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 |
-ShippingInformationCity
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 |
-ShippingInformationCountryOrRegion
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 |
-ShippingInformationPhone
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 |
-ShippingInformationPostalCode
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 |
-ShippingInformationRecipientName
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 |
-ShippingInformationStateOrProvince
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 |
-ShippingInformationStreetAddress1
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 |
-ShippingInformationStreetAddress2
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 |
-State
Current state of the job.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StorageAccountId
The resource identifier of the storage account where data will be imported to or exported from.
| 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 |
