Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. importexport
  5. getJob
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.importexport.getJob

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets information about an existing job. Azure REST API version: 2021-01-01.

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
Copy
def get_job(job_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_name: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
Copy
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
Copy

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
public static Output<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:importexport:getJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

JobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the import/export job.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name uniquely identifies the resource group within the user subscription.
JobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the import/export job.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name uniquely identifies the resource group within the user subscription.
jobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the import/export job.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name uniquely identifies the resource group within the user subscription.
jobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the import/export job.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name uniquely identifies the resource group within the user subscription.
job_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the import/export job.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name uniquely identifies the resource group within the user subscription.
jobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the import/export job.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name uniquely identifies the resource group within the user subscription.

getJob Result

The following output properties are available:

Id string
Specifies the resource identifier of the job.
Name string
Specifies the name of the job.
Properties Pulumi.AzureNative.ImportExport.Outputs.JobDetailsResponse
Specifies the job properties
SystemData Pulumi.AzureNative.ImportExport.Outputs.SystemDataResponse
SystemData of ImportExport Jobs.
Type string
Specifies the type of the job resource.
Identity Pulumi.AzureNative.ImportExport.Outputs.IdentityDetailsResponse
Specifies the job identity details
Location string
Specifies the Azure location where the job is created.
Tags object
Specifies the tags that are assigned to the job.
Id string
Specifies the resource identifier of the job.
Name string
Specifies the name of the job.
Properties JobDetailsResponse
Specifies the job properties
SystemData SystemDataResponse
SystemData of ImportExport Jobs.
Type string
Specifies the type of the job resource.
Identity IdentityDetailsResponse
Specifies the job identity details
Location string
Specifies the Azure location where the job is created.
Tags interface{}
Specifies the tags that are assigned to the job.
id String
Specifies the resource identifier of the job.
name String
Specifies the name of the job.
properties JobDetailsResponse
Specifies the job properties
systemData SystemDataResponse
SystemData of ImportExport Jobs.
type String
Specifies the type of the job resource.
identity IdentityDetailsResponse
Specifies the job identity details
location String
Specifies the Azure location where the job is created.
tags Object
Specifies the tags that are assigned to the job.
id string
Specifies the resource identifier of the job.
name string
Specifies the name of the job.
properties JobDetailsResponse
Specifies the job properties
systemData SystemDataResponse
SystemData of ImportExport Jobs.
type string
Specifies the type of the job resource.
identity IdentityDetailsResponse
Specifies the job identity details
location string
Specifies the Azure location where the job is created.
tags any
Specifies the tags that are assigned to the job.
id str
Specifies the resource identifier of the job.
name str
Specifies the name of the job.
properties JobDetailsResponse
Specifies the job properties
system_data SystemDataResponse
SystemData of ImportExport Jobs.
type str
Specifies the type of the job resource.
identity IdentityDetailsResponse
Specifies the job identity details
location str
Specifies the Azure location where the job is created.
tags Any
Specifies the tags that are assigned to the job.
id String
Specifies the resource identifier of the job.
name String
Specifies the name of the job.
properties Property Map
Specifies the job properties
systemData Property Map
SystemData of ImportExport Jobs.
type String
Specifies the type of the job resource.
identity Property Map
Specifies the job identity details
location String
Specifies the Azure location where the job is created.
tags Any
Specifies the tags that are assigned to the job.

Supporting Types

DeliveryPackageInformationResponse

CarrierName This property is required. string
The name of the carrier that is used to ship the import or export drives.
TrackingNumber This property is required. string
The tracking number of the package.
DriveCount double
The number of drives included in the package.
ShipDate string
The date when the package is shipped.
CarrierName This property is required. string
The name of the carrier that is used to ship the import or export drives.
TrackingNumber This property is required. string
The tracking number of the package.
DriveCount float64
The number of drives included in the package.
ShipDate string
The date when the package is shipped.
carrierName This property is required. String
The name of the carrier that is used to ship the import or export drives.
trackingNumber This property is required. String
The tracking number of the package.
driveCount Double
The number of drives included in the package.
shipDate String
The date when the package is shipped.
carrierName This property is required. string
The name of the carrier that is used to ship the import or export drives.
trackingNumber This property is required. string
The tracking number of the package.
driveCount number
The number of drives included in the package.
shipDate string
The date when the package is shipped.
carrier_name This property is required. str
The name of the carrier that is used to ship the import or export drives.
tracking_number This property is required. str
The tracking number of the package.
drive_count float
The number of drives included in the package.
ship_date str
The date when the package is shipped.
carrierName This property is required. String
The name of the carrier that is used to ship the import or export drives.
trackingNumber This property is required. String
The tracking number of the package.
driveCount Number
The number of drives included in the package.
shipDate String
The date when the package is shipped.

DriveStatusResponse

BitLockerKey string
The BitLocker key used to encrypt the drive.
BytesSucceeded double
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 double
Percentage completed for the drive.
State string
The drive's current state.
VerboseLogUri string
A URI that points to the blob containing the verbose log for the data transfer operation.
BitLockerKey string
The BitLocker key used to encrypt the drive.
BytesSucceeded float64
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 float64
Percentage completed for the drive.
State string
The drive's current state.
VerboseLogUri string
A URI that points to the blob containing the verbose log for the data transfer operation.
bitLockerKey String
The BitLocker key used to encrypt the drive.
bytesSucceeded Double
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 Double
Percentage completed for the drive.
state String
The drive's current state.
verboseLogUri String
A URI that points to the blob containing the verbose log for the data transfer operation.
bitLockerKey string
The BitLocker key used to encrypt the drive.
bytesSucceeded number
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 number
Percentage completed for the drive.
state string
The drive's current state.
verboseLogUri string
A URI that points to the blob containing the verbose log for the data transfer operation.
bit_locker_key str
The BitLocker key used to encrypt the drive.
bytes_succeeded float
Bytes successfully transferred for the drive.
copy_status str
Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state.
drive_header_hash str
The drive header hash value.
drive_id str
The drive's hardware serial number, without spaces.
error_log_uri str
A URI that points to the blob containing the error log for the data transfer operation.
manifest_file str
The relative path of the manifest file on the drive.
manifest_hash str
The Base16-encoded MD5 hash of the manifest file on the drive.
manifest_uri str
A URI that points to the blob containing the drive manifest file.
percent_complete float
Percentage completed for the drive.
state str
The drive's current state.
verbose_log_uri str
A URI that points to the blob containing the verbose log for the data transfer operation.
bitLockerKey String
The BitLocker key used to encrypt the drive.
bytesSucceeded Number
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 Number
Percentage completed for the drive.
state String
The drive's current state.
verboseLogUri String
A URI that points to the blob containing the verbose log for the data transfer operation.

EncryptionKeyDetailsResponse

KekType string
The type of kek encryption key
KekUrl string
Specifies the url for kek encryption key.
KekVaultResourceID string
Specifies the keyvault resource id for kek encryption key.
KekType string
The type of kek encryption key
KekUrl string
Specifies the url for kek encryption key.
KekVaultResourceID string
Specifies the keyvault resource id for kek encryption key.
kekType String
The type of kek encryption key
kekUrl String
Specifies the url for kek encryption key.
kekVaultResourceID String
Specifies the keyvault resource id for kek encryption key.
kekType string
The type of kek encryption key
kekUrl string
Specifies the url for kek encryption key.
kekVaultResourceID string
Specifies the keyvault resource id for kek encryption key.
kek_type str
The type of kek encryption key
kek_url str
Specifies the url for kek encryption key.
kek_vault_resource_id str
Specifies the keyvault resource id for kek encryption key.
kekType String
The type of kek encryption key
kekUrl String
Specifies the url for kek encryption key.
kekVaultResourceID String
Specifies the keyvault resource id for kek encryption key.

ExportResponse

BlobListBlobPath string
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.
BlobPath List<string>
A collection of blob-path strings.
BlobPathPrefix List<string>
A collection of blob-prefix strings.
BlobListBlobPath string
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.
BlobPath []string
A collection of blob-path strings.
BlobPathPrefix []string
A collection of blob-prefix strings.
blobListBlobPath String
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.
blobPath List<String>
A collection of blob-path strings.
blobPathPrefix List<String>
A collection of blob-prefix strings.
blobListBlobPath string
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.
blobPath string[]
A collection of blob-path strings.
blobPathPrefix string[]
A collection of blob-prefix strings.
blob_list_blob_path str
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.
blob_path Sequence[str]
A collection of blob-path strings.
blob_path_prefix Sequence[str]
A collection of blob-prefix strings.
blobListBlobPath String
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.
blobPath List<String>
A collection of blob-path strings.
blobPathPrefix List<String>
A collection of blob-prefix strings.

IdentityDetailsResponse

PrincipalId This property is required. string
Specifies the principal id for the identity for the job.
TenantId This property is required. string
Specifies the tenant id for the identity for the job.
Type string
The type of identity
PrincipalId This property is required. string
Specifies the principal id for the identity for the job.
TenantId This property is required. string
Specifies the tenant id for the identity for the job.
Type string
The type of identity
principalId This property is required. String
Specifies the principal id for the identity for the job.
tenantId This property is required. String
Specifies the tenant id for the identity for the job.
type String
The type of identity
principalId This property is required. string
Specifies the principal id for the identity for the job.
tenantId This property is required. string
Specifies the tenant id for the identity for the job.
type string
The type of identity
principal_id This property is required. str
Specifies the principal id for the identity for the job.
tenant_id This property is required. str
Specifies the tenant id for the identity for the job.
type str
The type of identity
principalId This property is required. String
Specifies the principal id for the identity for the job.
tenantId This property is required. String
Specifies the tenant id for the identity for the job.
type String
The type of identity

JobDetailsResponse

BackupDriveManifest bool
Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
CancelRequested bool
Indicates whether a request has been submitted to cancel the job.
DeliveryPackage Pulumi.AzureNative.ImportExport.Inputs.DeliveryPackageInformationResponse
Contains information about the package being shipped by the customer to the Microsoft data center.
DiagnosticsPath string
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
DriveList List<Pulumi.AzureNative.ImportExport.Inputs.DriveStatusResponse>
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.
EncryptionKey Pulumi.AzureNative.ImportExport.Inputs.EncryptionKeyDetailsResponse
Contains information about the encryption key.
Export Pulumi.AzureNative.ImportExport.Inputs.ExportResponse
A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
IncompleteBlobListUri string
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.
JobType string
The type of job
LogLevel string
Default value is Error. Indicates whether error logging or verbose logging will be enabled.
PercentComplete double
Overall percentage completed for the job.
ProvisioningState string
Specifies the provisioning state of the job.
ReturnAddress Pulumi.AzureNative.ImportExport.Inputs.ReturnAddressResponse
Specifies the return address information for the job.
ReturnPackage Pulumi.AzureNative.ImportExport.Inputs.PackageInformationResponse
Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
ReturnShipping Pulumi.AzureNative.ImportExport.Inputs.ReturnShippingResponse
Specifies the return carrier and customer's account with the carrier.
ShippingInformation Pulumi.AzureNative.ImportExport.Inputs.ShippingInformationResponse
Contains information about the Microsoft datacenter to which the drives should be shipped.
State string
Current state of the job.
StorageAccountId string
The resource identifier of the storage account where data will be imported to or exported from.
BackupDriveManifest bool
Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
CancelRequested bool
Indicates whether a request has been submitted to cancel the job.
DeliveryPackage DeliveryPackageInformationResponse
Contains information about the package being shipped by the customer to the Microsoft data center.
DiagnosticsPath string
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
DriveList []DriveStatusResponse
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.
EncryptionKey EncryptionKeyDetailsResponse
Contains information about the encryption key.
Export ExportResponse
A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
IncompleteBlobListUri string
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.
JobType string
The type of job
LogLevel string
Default value is Error. Indicates whether error logging or verbose logging will be enabled.
PercentComplete float64
Overall percentage completed for the job.
ProvisioningState string
Specifies the provisioning state of the job.
ReturnAddress ReturnAddressResponse
Specifies the return address information for the job.
ReturnPackage PackageInformationResponse
Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
ReturnShipping ReturnShippingResponse
Specifies the return carrier and customer's account with the carrier.
ShippingInformation ShippingInformationResponse
Contains information about the Microsoft datacenter to which the drives should be shipped.
State string
Current state of the job.
StorageAccountId string
The resource identifier of the storage account where data will be imported to or exported from.
backupDriveManifest Boolean
Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested Boolean
Indicates whether a request has been submitted to cancel the job.
deliveryPackage DeliveryPackageInformationResponse
Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath String
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList List<DriveStatusResponse>
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.
encryptionKey EncryptionKeyDetailsResponse
Contains information about the encryption key.
export ExportResponse
A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
incompleteBlobListUri String
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.
jobType String
The type of job
logLevel String
Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete Double
Overall percentage completed for the job.
provisioningState String
Specifies the provisioning state of the job.
returnAddress ReturnAddressResponse
Specifies the return address information for the job.
returnPackage PackageInformationResponse
Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping ReturnShippingResponse
Specifies the return carrier and customer's account with the carrier.
shippingInformation ShippingInformationResponse
Contains information about the Microsoft datacenter to which the drives should be shipped.
state String
Current state of the job.
storageAccountId String
The resource identifier of the storage account where data will be imported to or exported from.
backupDriveManifest boolean
Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested boolean
Indicates whether a request has been submitted to cancel the job.
deliveryPackage DeliveryPackageInformationResponse
Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath string
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList DriveStatusResponse[]
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.
encryptionKey EncryptionKeyDetailsResponse
Contains information about the encryption key.
export ExportResponse
A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
incompleteBlobListUri string
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.
jobType string
The type of job
logLevel string
Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete number
Overall percentage completed for the job.
provisioningState string
Specifies the provisioning state of the job.
returnAddress ReturnAddressResponse
Specifies the return address information for the job.
returnPackage PackageInformationResponse
Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping ReturnShippingResponse
Specifies the return carrier and customer's account with the carrier.
shippingInformation ShippingInformationResponse
Contains information about the Microsoft datacenter to which the drives should be shipped.
state string
Current state of the job.
storageAccountId string
The resource identifier of the storage account where data will be imported to or exported from.
backup_drive_manifest bool
Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancel_requested bool
Indicates whether a request has been submitted to cancel the job.
delivery_package DeliveryPackageInformationResponse
Contains information about the package being shipped by the customer to the Microsoft data center.
diagnostics_path str
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
drive_list Sequence[DriveStatusResponse]
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.
encryption_key EncryptionKeyDetailsResponse
Contains information about the encryption key.
export ExportResponse
A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
incomplete_blob_list_uri str
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.
job_type str
The type of job
log_level str
Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percent_complete float
Overall percentage completed for the job.
provisioning_state str
Specifies the provisioning state of the job.
return_address ReturnAddressResponse
Specifies the return address information for the job.
return_package PackageInformationResponse
Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
return_shipping ReturnShippingResponse
Specifies the return carrier and customer's account with the carrier.
shipping_information ShippingInformationResponse
Contains information about the Microsoft datacenter to which the drives should be shipped.
state str
Current state of the job.
storage_account_id str
The resource identifier of the storage account where data will be imported to or exported from.
backupDriveManifest Boolean
Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.
cancelRequested Boolean
Indicates whether a request has been submitted to cancel the job.
deliveryPackage Property Map
Contains information about the package being shipped by the customer to the Microsoft data center.
diagnosticsPath String
The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.
driveList List<Property Map>
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.
encryptionKey Property Map
Contains information about the encryption key.
export Property Map
A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.
incompleteBlobListUri String
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.
jobType String
The type of job
logLevel String
Default value is Error. Indicates whether error logging or verbose logging will be enabled.
percentComplete Number
Overall percentage completed for the job.
provisioningState String
Specifies the provisioning state of the job.
returnAddress Property Map
Specifies the return address information for the job.
returnPackage Property Map
Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned.
returnShipping Property Map
Specifies the return carrier and customer's account with the carrier.
shippingInformation Property Map
Contains information about the Microsoft datacenter to which the drives should be shipped.
state String
Current state of the job.
storageAccountId String
The resource identifier of the storage account where data will be imported to or exported from.

PackageInformationResponse

CarrierName This property is required. string
The name of the carrier that is used to ship the import or export drives.
DriveCount This property is required. double
The number of drives included in the package.
ShipDate This property is required. string
The date when the package is shipped.
TrackingNumber This property is required. string
The tracking number of the package.
CarrierName This property is required. string
The name of the carrier that is used to ship the import or export drives.
DriveCount This property is required. float64
The number of drives included in the package.
ShipDate This property is required. string
The date when the package is shipped.
TrackingNumber This property is required. string
The tracking number of the package.
carrierName This property is required. String
The name of the carrier that is used to ship the import or export drives.
driveCount This property is required. Double
The number of drives included in the package.
shipDate This property is required. String
The date when the package is shipped.
trackingNumber This property is required. String
The tracking number of the package.
carrierName This property is required. string
The name of the carrier that is used to ship the import or export drives.
driveCount This property is required. number
The number of drives included in the package.
shipDate This property is required. string
The date when the package is shipped.
trackingNumber This property is required. string
The tracking number of the package.
carrier_name This property is required. str
The name of the carrier that is used to ship the import or export drives.
drive_count This property is required. float
The number of drives included in the package.
ship_date This property is required. str
The date when the package is shipped.
tracking_number This property is required. str
The tracking number of the package.
carrierName This property is required. String
The name of the carrier that is used to ship the import or export drives.
driveCount This property is required. Number
The number of drives included in the package.
shipDate This property is required. String
The date when the package is shipped.
trackingNumber This property is required. String
The tracking number of the package.

ReturnAddressResponse

City This property is required. string
The city name to use when returning the drives.
CountryOrRegion This property is required. string
The country or region to use when returning the drives.
Email This property is required. string
Email address of the recipient of the returned drives.
Phone This property is required. string
Phone number of the recipient of the returned drives.
PostalCode This property is required. string
The postal code to use when returning the drives.
RecipientName This property is required. string
The name of the recipient who will receive the hard drives when they are returned.
StreetAddress1 This property is required. string
The first line of the street address to use when returning the drives.
StateOrProvince string
The state or province to use when returning the drives.
StreetAddress2 string
The second line of the street address to use when returning the drives.
City This property is required. string
The city name to use when returning the drives.
CountryOrRegion This property is required. string
The country or region to use when returning the drives.
Email This property is required. string
Email address of the recipient of the returned drives.
Phone This property is required. string
Phone number of the recipient of the returned drives.
PostalCode This property is required. string
The postal code to use when returning the drives.
RecipientName This property is required. string
The name of the recipient who will receive the hard drives when they are returned.
StreetAddress1 This property is required. string
The first line of the street address to use when returning the drives.
StateOrProvince string
The state or province to use when returning the drives.
StreetAddress2 string
The second line of the street address to use when returning the drives.
city This property is required. String
The city name to use when returning the drives.
countryOrRegion This property is required. String
The country or region to use when returning the drives.
email This property is required. String
Email address of the recipient of the returned drives.
phone This property is required. String
Phone number of the recipient of the returned drives.
postalCode This property is required. String
The postal code to use when returning the drives.
recipientName This property is required. String
The name of the recipient who will receive the hard drives when they are returned.
streetAddress1 This property is required. String
The first line of the street address to use when returning the drives.
stateOrProvince String
The state or province to use when returning the drives.
streetAddress2 String
The second line of the street address to use when returning the drives.
city This property is required. string
The city name to use when returning the drives.
countryOrRegion This property is required. string
The country or region to use when returning the drives.
email This property is required. string
Email address of the recipient of the returned drives.
phone This property is required. string
Phone number of the recipient of the returned drives.
postalCode This property is required. string
The postal code to use when returning the drives.
recipientName This property is required. string
The name of the recipient who will receive the hard drives when they are returned.
streetAddress1 This property is required. string
The first line of the street address to use when returning the drives.
stateOrProvince string
The state or province to use when returning the drives.
streetAddress2 string
The second line of the street address to use when returning the drives.
city This property is required. str
The city name to use when returning the drives.
country_or_region This property is required. str
The country or region to use when returning the drives.
email This property is required. str
Email address of the recipient of the returned drives.
phone This property is required. str
Phone number of the recipient of the returned drives.
postal_code This property is required. str
The postal code to use when returning the drives.
recipient_name This property is required. str
The name of the recipient who will receive the hard drives when they are returned.
street_address1 This property is required. str
The first line of the street address to use when returning the drives.
state_or_province str
The state or province to use when returning the drives.
street_address2 str
The second line of the street address to use when returning the drives.
city This property is required. String
The city name to use when returning the drives.
countryOrRegion This property is required. String
The country or region to use when returning the drives.
email This property is required. String
Email address of the recipient of the returned drives.
phone This property is required. String
Phone number of the recipient of the returned drives.
postalCode This property is required. String
The postal code to use when returning the drives.
recipientName This property is required. String
The name of the recipient who will receive the hard drives when they are returned.
streetAddress1 This property is required. String
The first line of the street address to use when returning the drives.
stateOrProvince String
The state or province to use when returning the drives.
streetAddress2 String
The second line of the street address to use when returning the drives.

ReturnShippingResponse

CarrierAccountNumber This property is required. string
The customer's account number with the carrier.
CarrierName This property is required. string
The carrier's name.
CarrierAccountNumber This property is required. string
The customer's account number with the carrier.
CarrierName This property is required. string
The carrier's name.
carrierAccountNumber This property is required. String
The customer's account number with the carrier.
carrierName This property is required. String
The carrier's name.
carrierAccountNumber This property is required. string
The customer's account number with the carrier.
carrierName This property is required. string
The carrier's name.
carrier_account_number This property is required. str
The customer's account number with the carrier.
carrier_name This property is required. str
The carrier's name.
carrierAccountNumber This property is required. String
The customer's account number with the carrier.
carrierName This property is required. String
The carrier's name.

ShippingInformationResponse

AdditionalInformation This property is required. string
Additional shipping information for customer, specific to datacenter to which customer should send their disks.
City string
The city name to use when returning the drives.
CountryOrRegion string
The country or region to use when returning the drives.
Phone string
Phone number of the recipient of the returned drives.
PostalCode string
The postal code to use when returning the drives.
RecipientName string
The name of the recipient who will receive the hard drives when they are returned.
StateOrProvince string
The state or province to use when returning the drives.
StreetAddress1 string
The first line of the street address to use when returning the drives.
StreetAddress2 string
The second line of the street address to use when returning the drives.
AdditionalInformation This property is required. string
Additional shipping information for customer, specific to datacenter to which customer should send their disks.
City string
The city name to use when returning the drives.
CountryOrRegion string
The country or region to use when returning the drives.
Phone string
Phone number of the recipient of the returned drives.
PostalCode string
The postal code to use when returning the drives.
RecipientName string
The name of the recipient who will receive the hard drives when they are returned.
StateOrProvince string
The state or province to use when returning the drives.
StreetAddress1 string
The first line of the street address to use when returning the drives.
StreetAddress2 string
The second line of the street address to use when returning the drives.
additionalInformation This property is required. String
Additional shipping information for customer, specific to datacenter to which customer should send their disks.
city String
The city name to use when returning the drives.
countryOrRegion String
The country or region to use when returning the drives.
phone String
Phone number of the recipient of the returned drives.
postalCode String
The postal code to use when returning the drives.
recipientName String
The name of the recipient who will receive the hard drives when they are returned.
stateOrProvince String
The state or province to use when returning the drives.
streetAddress1 String
The first line of the street address to use when returning the drives.
streetAddress2 String
The second line of the street address to use when returning the drives.
additionalInformation This property is required. string
Additional shipping information for customer, specific to datacenter to which customer should send their disks.
city string
The city name to use when returning the drives.
countryOrRegion string
The country or region to use when returning the drives.
phone string
Phone number of the recipient of the returned drives.
postalCode string
The postal code to use when returning the drives.
recipientName string
The name of the recipient who will receive the hard drives when they are returned.
stateOrProvince string
The state or province to use when returning the drives.
streetAddress1 string
The first line of the street address to use when returning the drives.
streetAddress2 string
The second line of the street address to use when returning the drives.
additional_information This property is required. str
Additional shipping information for customer, specific to datacenter to which customer should send their disks.
city str
The city name to use when returning the drives.
country_or_region str
The country or region to use when returning the drives.
phone str
Phone number of the recipient of the returned drives.
postal_code str
The postal code to use when returning the drives.
recipient_name str
The name of the recipient who will receive the hard drives when they are returned.
state_or_province str
The state or province to use when returning the drives.
street_address1 str
The first line of the street address to use when returning the drives.
street_address2 str
The second line of the street address to use when returning the drives.
additionalInformation This property is required. String
Additional shipping information for customer, specific to datacenter to which customer should send their disks.
city String
The city name to use when returning the drives.
countryOrRegion String
The country or region to use when returning the drives.
phone String
Phone number of the recipient of the returned drives.
postalCode String
The postal code to use when returning the drives.
recipientName String
The name of the recipient who will receive the hard drives when they are returned.
stateOrProvince String
The state or province to use when returning the drives.
streetAddress1 String
The first line of the street address to use when returning the drives.
streetAddress2 String
The second line of the street address to use when returning the drives.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native