Jobs interface

Package:

@azure/arm-storageimportexport

Interface representing a Jobs.

Methods

create(string, string, PutJobParameters, JobsCreateOptionalParams)	Creates a new job or updates an existing job in the specified subscription.
delete(string, string, JobsDeleteOptionalParams)	Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.
get(string, string, JobsGetOptionalParams)	Gets information about an existing job.
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)	Returns all active and completed jobs in a resource group.
listBySubscription(JobsListBySubscriptionOptionalParams)	Returns all active and completed jobs in a subscription.
update(string, string, UpdateJobParameters, JobsUpdateOptionalParams)	Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.

Method Details

create(string, string, PutJobParameters, JobsCreateOptionalParams)

Creates a new job or updates an existing job in the specified subscription.

function create(jobName: string, resourceGroupName: string, body: PutJobParameters, options?: JobsCreateOptionalParams): Promise<JobResponse>

Parameters

jobName

string

The name of the import/export job.

resourceGroupName

string

The resource group name uniquely identifies the resource group within the user subscription.

body

PutJobParameters

The parameters used for creating the job

options

JobsCreateOptionalParams

The options parameters.

Returns

Promise<JobResponse>

delete(string, string, JobsDeleteOptionalParams)

Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

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

Parameters

jobName

string

The name of the import/export job.

resourceGroupName

string

The resource group name uniquely identifies the resource group within the user subscription.

options

JobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, JobsGetOptionalParams)

Gets information about an existing job.

function get(jobName: string, resourceGroupName: string, options?: JobsGetOptionalParams): Promise<JobResponse>

Parameters

jobName

string

The name of the import/export job.

resourceGroupName

string

The resource group name uniquely identifies the resource group within the user subscription.

options

JobsGetOptionalParams

The options parameters.

Returns

Promise<JobResponse>

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Returns all active and completed jobs in a resource group.

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

Parameters

resourceGroupName

string

The resource group name uniquely identifies the resource group within the user subscription.

options

JobsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>

listBySubscription(JobsListBySubscriptionOptionalParams)

Returns all active and completed jobs in a subscription.

function listBySubscription(options?: JobsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>

Parameters

options

JobsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>

update(string, string, UpdateJobParameters, JobsUpdateOptionalParams)

Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.

function update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, options?: JobsUpdateOptionalParams): Promise<JobResponse>

Parameters

jobName

string

The name of the import/export job.

resourceGroupName

string

The resource group name uniquely identifies the resource group within the user subscription.

body

UpdateJobParameters

The parameters to update in the job

options

JobsUpdateOptionalParams

The options parameters.

Returns

Promise<JobResponse>