JobsOperations interface

Package:

@azure/arm-databox

Interface representing a Jobs operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
bookShipmentPickUp	Book shipment pick up.
cancel	CancelJob.
create	Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.
delete	Deletes a job.
get	Gets information about the specified job.
list	Lists all the jobs available under the subscription.
listByResourceGroup	Lists all the jobs available under the given resource group.
listCredentials	This method gets the unencrypted secrets related to the job.
markDevicesShipped	Request to mark devices for a given job as shipped
update	Updates the properties of an existing job.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>

Property Value

(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams) => Promise<JobResource>

Property Value

(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams) => Promise<JobResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>

Property Value

(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams) => Promise<JobResource>

Property Value

(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams) => Promise<JobResource>

bookShipmentPickUp

Book shipment pick up.

bookShipmentPickUp: (resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams) => Promise<ShipmentPickUpResponse>

Property Value

(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams) => Promise<ShipmentPickUpResponse>

cancel

CancelJob.

cancel: (resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams) => Promise<void>

create

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

create: (resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams) => PollerLike<OperationState<JobResource>, JobResource>

Property Value

(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams) => PollerLike<OperationState<JobResource>, JobResource>

delete

Deletes a job.

delete: (resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about the specified job.

get: (resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams) => Promise<JobResource>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams) => Promise<JobResource>

list

Lists all the jobs available under the subscription.

list: (options?: JobsListOptionalParams) => PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

Property Value

(options?: JobsListOptionalParams) => PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listByResourceGroup

Lists all the jobs available under the given resource group.

listByResourceGroup: (resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listCredentials

This method gets the unencrypted secrets related to the job.

listCredentials: (resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams) => PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

Property Value

(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams) => PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

markDevicesShipped

Request to mark devices for a given job as shipped

markDevicesShipped: (jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams) => Promise<void>

Property Value

(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams) => Promise<void>

update

Updates the properties of an existing job.

update: (resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams) => PollerLike<OperationState<JobResource>, JobResource>

Property Value

(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams) => PollerLike<OperationState<JobResource>, JobResource>