Share via


PutJobParameters Class

Definition

Put Job parameters

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.PutJobParametersTypeConverter))]
public class PutJobParameters : Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IPutJobParameters
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.PutJobParametersTypeConverter))>]
type PutJobParameters = class
    interface IPutJobParameters
    interface IJsonSerializable
Public Class PutJobParameters
Implements IPutJobParameters
Inheritance
PutJobParameters
Attributes
Implements

Constructors

PutJobParameters()

Creates an new PutJobParameters instance.

Properties

BackupDriveManifest

Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.

BlobListBlobPathPrefix

A collection of blob-prefix strings.

BlobPath

A collection of blob-path strings.

CancelRequested

Indicates whether a request has been submitted to cancel the job.

DeliveryPackageCarrierName

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

DeliveryPackageDriveCount

The number of drives included in the package.

DeliveryPackageShipDate

The date when the package is shipped.

DeliveryPackageTrackingNumber

The tracking number of the package.

DiagnosticsPath

The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.

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.

EncryptionKeyKekType

The type of kek encryption key

EncryptionKeyKekUrl

Specifies the url for kek encryption key.

EncryptionKeyKekVaultResourceId

Specifies the keyvault resource id for kek encryption key.

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.

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.

JobType

The type of job

Location

Specifies the supported Azure location where the job should be created

LogLevel

Default value is Error. Indicates whether error logging or verbose logging will be enabled.

PercentComplete

Overall percentage completed for the job.

ProvisioningState

Specifies the provisioning state of the job.

ReturnAddressCity

The city name to use when returning the drives.

ReturnAddressCountryOrRegion

The country or region to use when returning the drives.

ReturnAddressEmail

Email address of the recipient of the returned drives.

ReturnAddressPhone

Phone number of the recipient of the returned drives.

ReturnAddressPostalCode

The postal code to use when returning the drives.

ReturnAddressRecipientName

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

ReturnAddressStateOrProvince

The state or province to use when returning the drives.

ReturnAddressStreetAddress1

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

ReturnAddressStreetAddress2

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

ReturnPackageCarrierName

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

ReturnPackageDriveCount

The number of drives included in the package.

ReturnPackageShipDate

The date when the package is shipped.

ReturnPackageTrackingNumber

The tracking number of the package.

ReturnShippingCarrierAccountNumber

The customer's account number with the carrier.

ReturnShippingCarrierName

The carrier's name.

ShippingInformationAdditionalInformation

Additional shipping information for customer, specific to datacenter to which customer should send their disks.

ShippingInformationCity

The city name to use when returning the drives.

ShippingInformationCountryOrRegion

The country or region to use when returning the drives.

ShippingInformationPhone

Phone number of the recipient of the returned drives.

ShippingInformationPostalCode

The postal code to use when returning the drives.

ShippingInformationRecipientName

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

ShippingInformationStateOrProvince

The state or province to use when returning the drives.

ShippingInformationStreetAddress1

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

ShippingInformationStreetAddress2

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

State

Current state of the job.

StorageAccountId

The resource identifier of the storage account where data will be imported to or exported from.

Tag

Specifies the tags that will be assigned to the job.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PutJobParameters.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PutJobParameters.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ImportExport.Models.Api202101.IPutJobParameters.

FromJsonString(String)

Creates a new instance of PutJobParameters, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of PutJobParameters into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to