@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Job Resource.
*
* Uses Azure REST API version 2024-03-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-12-01.
*
* Other available API versions: 2022-12-01, 2023-03-01, 2023-12-01, 2024-02-01-preview, 2025-02-01, 2025-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native databox [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Job extends pulumi.CustomResource {
/**
* Get an existing Job resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Job;
/**
* Returns true if the given object is an instance of Job. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Job;
/**
* Flag to indicate if all devices associated with the job are lost.
*/
readonly allDevicesLost: pulumi.Output<boolean>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Reason for cancellation.
*/
readonly cancellationReason: pulumi.Output<string>;
/**
* Name of the stage where delay might be present.
*/
readonly delayedStage: pulumi.Output<string>;
/**
* Delivery Info of Job.
*/
readonly deliveryInfo: pulumi.Output<outputs.databox.JobDeliveryInfoResponse | undefined>;
/**
* Delivery type of Job.
*/
readonly deliveryType: pulumi.Output<string | undefined>;
/**
* Details of a job run. This field will only be sent for expand details filter.
*/
readonly details: pulumi.Output<outputs.databox.DataBoxCustomerDiskJobDetailsResponse | outputs.databox.DataBoxDiskJobDetailsResponse | outputs.databox.DataBoxHeavyJobDetailsResponse | outputs.databox.DataBoxJobDetailsResponse | undefined>;
/**
* Top level error for the job.
*/
readonly error: pulumi.Output<outputs.databox.CloudErrorResponse>;
/**
* Msi identity of the resource
*/
readonly identity: pulumi.Output<outputs.databox.ResourceIdentityResponse | undefined>;
/**
* Describes whether the job is cancellable or not.
*/
readonly isCancellable: pulumi.Output<boolean>;
/**
* Flag to indicate cancellation of scheduled job.
*/
readonly isCancellableWithoutFee: pulumi.Output<boolean>;
/**
* Describes whether the job is deletable or not.
*/
readonly isDeletable: pulumi.Output<boolean>;
/**
* Is Prepare To Ship Enabled on this job
*/
readonly isPrepareToShipEnabled: pulumi.Output<boolean>;
/**
* Describes whether the shipping address is editable or not.
*/
readonly isShippingAddressEditable: pulumi.Output<boolean>;
/**
* The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
*/
readonly location: pulumi.Output<string>;
/**
* Name of the object.
*/
readonly name: pulumi.Output<string>;
/**
* The Editable status for Reverse Shipping Address and Contact Info
*/
readonly reverseShippingDetailsUpdate: pulumi.Output<string>;
/**
* The Editable status for Reverse Transport preferences
*/
readonly reverseTransportPreferenceUpdate: pulumi.Output<string>;
/**
* The sku type.
*/
readonly sku: pulumi.Output<outputs.databox.SkuResponse>;
/**
* Time at which the job was started in UTC ISO 8601 format.
*/
readonly startTime: pulumi.Output<string>;
/**
* Name of the stage which is in progress.
*/
readonly status: pulumi.Output<string>;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: pulumi.Output<outputs.databox.SystemDataResponse>;
/**
* The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Type of the data transfer.
*/
readonly transferType: pulumi.Output<string>;
/**
* Type of the object.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Job resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: JobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Job resource.
*/
export interface JobArgs {
/**
* Delivery Info of Job.
*/
deliveryInfo?: pulumi.Input<inputs.databox.JobDeliveryInfoArgs>;
/**
* Delivery type of Job.
*/
deliveryType?: pulumi.Input<string | enums.databox.JobDeliveryType>;
/**
* Details of a job run. This field will only be sent for expand details filter.
*/
details?: pulumi.Input<inputs.databox.DataBoxCustomerDiskJobDetailsArgs | inputs.databox.DataBoxDiskJobDetailsArgs | inputs.databox.DataBoxHeavyJobDetailsArgs | inputs.databox.DataBoxJobDetailsArgs>;
/**
* Msi identity of the resource
*/
identity?: pulumi.Input<inputs.databox.ResourceIdentityArgs>;
/**
* The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
*/
jobName?: pulumi.Input<string>;
/**
* The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.
*/
location?: pulumi.Input<string>;
/**
* The Resource Group Name
*/
resourceGroupName: pulumi.Input<string>;
/**
* The sku type.
*/
sku: pulumi.Input<inputs.databox.SkuArgs>;
/**
* The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Type of the data transfer.
*/
transferType: pulumi.Input<string | enums.databox.TransferType>;
}