Jobs class

Class representing a Jobs.

Constructors

Jobs(StorageImportExportManagementClientContext)

Create a Jobs.

Methods

create(string, string, PutJobParameters, JobsCreateOptionalParams, ServiceCallback<JobResponse>)
create(string, string, PutJobParameters, Models.JobsCreateOptionalParams)

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

create(string, string, PutJobParameters, ServiceCallback<JobResponse>)
deleteMethod(string, string, msRest.RequestOptionsBase)

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

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, ServiceCallback<void>)
get(string, string, msRest.RequestOptionsBase)

Gets information about an existing job.

get(string, string, RequestOptionsBase, ServiceCallback<JobResponse>)
get(string, string, ServiceCallback<JobResponse>)
listByResourceGroup(string, JobsListByResourceGroupOptionalParams, ServiceCallback<ListJobsResponse>)
listByResourceGroup(string, Models.JobsListByResourceGroupOptionalParams)

Returns all active and completed jobs in a resource group.

listByResourceGroup(string, ServiceCallback<ListJobsResponse>)
listByResourceGroupNext(string, msRest.RequestOptionsBase)

Returns all active and completed jobs in a resource group.

listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<ListJobsResponse>)
listByResourceGroupNext(string, ServiceCallback<ListJobsResponse>)
listBySubscription(JobsListBySubscriptionOptionalParams, ServiceCallback<ListJobsResponse>)
listBySubscription(Models.JobsListBySubscriptionOptionalParams)

Returns all active and completed jobs in a subscription.

listBySubscription(ServiceCallback<ListJobsResponse>)
listBySubscriptionNext(string, msRest.RequestOptionsBase)

Returns all active and completed jobs in a subscription.

listBySubscriptionNext(string, RequestOptionsBase, ServiceCallback<ListJobsResponse>)
listBySubscriptionNext(string, ServiceCallback<ListJobsResponse>)
update(string, string, UpdateJobParameters, msRest.RequestOptionsBase)

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.

update(string, string, UpdateJobParameters, RequestOptionsBase, ServiceCallback<JobResponse>)
update(string, string, UpdateJobParameters, ServiceCallback<JobResponse>)

Constructor Details

Jobs(StorageImportExportManagementClientContext)

Create a Jobs.

new Jobs(client: StorageImportExportManagementClientContext)

Parameters

client
StorageImportExportManagementClientContext

Reference to the service client.

Method Details

create(string, string, PutJobParameters, JobsCreateOptionalParams, ServiceCallback<JobResponse>)

function create(jobName: string, resourceGroupName: string, body: PutJobParameters, options: JobsCreateOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<JobResponse>

The callback

create(string, string, PutJobParameters, Models.JobsCreateOptionalParams)

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

function create(jobName: string, resourceGroupName: string, body: PutJobParameters, options?: Models.JobsCreateOptionalParams)

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
Models.JobsCreateOptionalParams

Returns

Promise<Models.JobsCreateResponse>

Promise<Models.JobsCreateResponse>

create(string, string, PutJobParameters, ServiceCallback<JobResponse>)

function create(jobName: string, resourceGroupName: string, body: PutJobParameters, callback: ServiceCallback<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

callback

ServiceCallback<JobResponse>

The callback

deleteMethod(string, string, msRest.RequestOptionsBase)

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

function deleteMethod(jobName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase)

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
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)

function deleteMethod(jobName: string, resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<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

RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, ServiceCallback<void>)

function deleteMethod(jobName: string, resourceGroupName: string, callback: ServiceCallback<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.

callback

ServiceCallback<void>

The callback

get(string, string, msRest.RequestOptionsBase)

Gets information about an existing job.

function get(jobName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase)

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
msRest.RequestOptionsBase

Returns

Promise<Models.JobsGetResponse>

Promise<Models.JobsGetResponse>

get(string, string, RequestOptionsBase, ServiceCallback<JobResponse>)

function get(jobName: string, resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<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

RequestOptionsBase

The optional parameters

callback

ServiceCallback<JobResponse>

The callback

get(string, string, ServiceCallback<JobResponse>)

function get(jobName: string, resourceGroupName: string, callback: ServiceCallback<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.

callback

ServiceCallback<JobResponse>

The callback

listByResourceGroup(string, JobsListByResourceGroupOptionalParams, ServiceCallback<ListJobsResponse>)

function listByResourceGroup(resourceGroupName: string, options: JobsListByResourceGroupOptionalParams, callback: ServiceCallback<ListJobsResponse>)

Parameters

resourceGroupName

string

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

options
JobsListByResourceGroupOptionalParams

The optional parameters

callback

ServiceCallback<ListJobsResponse>

The callback

listByResourceGroup(string, Models.JobsListByResourceGroupOptionalParams)

Returns all active and completed jobs in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: Models.JobsListByResourceGroupOptionalParams)

Parameters

resourceGroupName

string

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

options
Models.JobsListByResourceGroupOptionalParams

Returns

Promise<Models.JobsListByResourceGroupResponse>

Promise<Models.JobsListByResourceGroupResponse>

listByResourceGroup(string, ServiceCallback<ListJobsResponse>)

function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<ListJobsResponse>)

Parameters

resourceGroupName

string

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

callback

ServiceCallback<ListJobsResponse>

The callback

listByResourceGroupNext(string, msRest.RequestOptionsBase)

Returns all active and completed jobs in a resource group.

function listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.JobsListByResourceGroupNextResponse>

Promise<Models.JobsListByResourceGroupNextResponse>

listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<ListJobsResponse>)

function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ListJobsResponse>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ListJobsResponse>

The callback

listByResourceGroupNext(string, ServiceCallback<ListJobsResponse>)

function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<ListJobsResponse>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ListJobsResponse>

The callback

listBySubscription(JobsListBySubscriptionOptionalParams, ServiceCallback<ListJobsResponse>)

function listBySubscription(options: JobsListBySubscriptionOptionalParams, callback: ServiceCallback<ListJobsResponse>)

Parameters

options
JobsListBySubscriptionOptionalParams

The optional parameters

callback

ServiceCallback<ListJobsResponse>

The callback

listBySubscription(Models.JobsListBySubscriptionOptionalParams)

Returns all active and completed jobs in a subscription.

function listBySubscription(options?: Models.JobsListBySubscriptionOptionalParams)

Parameters

options
Models.JobsListBySubscriptionOptionalParams

Returns

Promise<Models.JobsListBySubscriptionResponse>

Promise<Models.JobsListBySubscriptionResponse>

listBySubscription(ServiceCallback<ListJobsResponse>)

function listBySubscription(callback: ServiceCallback<ListJobsResponse>)

Parameters

callback

ServiceCallback<ListJobsResponse>

The callback

listBySubscriptionNext(string, msRest.RequestOptionsBase)

Returns all active and completed jobs in a subscription.

function listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.JobsListBySubscriptionNextResponse>

Promise<Models.JobsListBySubscriptionNextResponse>

listBySubscriptionNext(string, RequestOptionsBase, ServiceCallback<ListJobsResponse>)

function listBySubscriptionNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ListJobsResponse>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ListJobsResponse>

The callback

listBySubscriptionNext(string, ServiceCallback<ListJobsResponse>)

function listBySubscriptionNext(nextPageLink: string, callback: ServiceCallback<ListJobsResponse>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ListJobsResponse>

The callback

update(string, string, UpdateJobParameters, msRest.RequestOptionsBase)

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?: msRest.RequestOptionsBase)

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
msRest.RequestOptionsBase

Returns

Promise<Models.JobsUpdateResponse>

Promise<Models.JobsUpdateResponse>

update(string, string, UpdateJobParameters, RequestOptionsBase, ServiceCallback<JobResponse>)

function update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, options: RequestOptionsBase, callback: ServiceCallback<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

RequestOptionsBase

The optional parameters

callback

ServiceCallback<JobResponse>

The callback

update(string, string, UpdateJobParameters, ServiceCallback<JobResponse>)

function update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, callback: ServiceCallback<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

callback

ServiceCallback<JobResponse>

The callback