Jobs | @azure/arm-storageimportexport

Class representing a Jobs.

Hierarchy

Jobs

Index

Constructors

constructor

Methods

Constructors

constructor

new Jobs(client: StorageImportExportManagementClientContext): Jobs

- Defined in operations/jobs.ts:19
Create a Jobs.

Parameters
- client: StorageImportExportManagementClientContext
  
  Reference to the service client.
Returns Jobs

Methods

create

create(jobName: string, resourceGroupName: string, body: PutJobParameters, options?: Models.JobsCreateOptionalParams): Promise<Models.JobsCreateResponse>
create(jobName: string, resourceGroupName: string, body: PutJobParameters, callback: msRest.ServiceCallback<JobResponse>): void
create(jobName: string, resourceGroupName: string, body: PutJobParameters, options: JobsCreateOptionalParams, callback: msRest.ServiceCallback<JobResponse>): void

- Defined in operations/jobs.ts:169
Creates a new job or updates an existing job in the specified subscription.

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
- Optional options: Models.JobsCreateOptionalParams
Returns Promise<Models.JobsCreateResponse>

Promise<Models.JobsCreateResponse>
- Defined in operations/jobs.ts:177
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: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:186
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: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void

deleteMethod

deleteMethod(jobName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteMethod(jobName: string, resourceGroupName: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(jobName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/jobs.ts:207
Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/jobs.ts:214
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: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/jobs.ts:222
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
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

get

get(jobName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsGetResponse>
get(jobName: string, resourceGroupName: string, callback: msRest.ServiceCallback<JobResponse>): void
get(jobName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponse>): void

- Defined in operations/jobs.ts:92
Gets information about an existing job.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.JobsGetResponse>

Promise<Models.JobsGetResponse>
- Defined in operations/jobs.ts:99
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: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:107
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
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: Models.JobsListByResourceGroupOptionalParams): Promise<Models.JobsListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ListJobsResponse>): void
listByResourceGroup(resourceGroupName: string, options: JobsListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<ListJobsResponse>): void

- Defined in operations/jobs.ts:60
Returns all active and completed jobs in a resource group.

Parameters
- resourceGroupName: string
  
  The resource group name uniquely identifies the resource group within the user subscription.
- Optional options: Models.JobsListByResourceGroupOptionalParams
Returns Promise<Models.JobsListByResourceGroupResponse>

Promise<Models.JobsListByResourceGroupResponse>
- Defined in operations/jobs.ts:66
Parameters
- resourceGroupName: string
  
  The resource group name uniquely identifies the resource group within the user subscription.
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:73
Parameters
- resourceGroupName: string
  
  The resource group name uniquely identifies the resource group within the user subscription.
- options: JobsListByResourceGroupOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<ListJobsResponse>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ListJobsResponse>): void

- Defined in operations/jobs.ts:268
Returns all active and completed jobs in a resource group.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.JobsListByResourceGroupNextResponse>

Promise<Models.JobsListByResourceGroupNextResponse>
- Defined in operations/jobs.ts:273
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:279
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void

listBySubscription

listBySubscription(options?: Models.JobsListBySubscriptionOptionalParams): Promise<Models.JobsListBySubscriptionResponse>
listBySubscription(callback: msRest.ServiceCallback<ListJobsResponse>): void
listBySubscription(options: JobsListBySubscriptionOptionalParams, callback: msRest.ServiceCallback<ListJobsResponse>): void

- Defined in operations/jobs.ts:34
Returns all active and completed jobs in a subscription.

Parameters
- Optional options: Models.JobsListBySubscriptionOptionalParams
Returns Promise<Models.JobsListBySubscriptionResponse>

Promise<Models.JobsListBySubscriptionResponse>
- Defined in operations/jobs.ts:38
Parameters
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:43
Parameters
- options: JobsListBySubscriptionOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void

listBySubscriptionNext

listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.JobsListBySubscriptionNextResponse>
listBySubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<ListJobsResponse>): void
listBySubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ListJobsResponse>): void

- Defined in operations/jobs.ts:240
Returns all active and completed jobs in a subscription.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.JobsListBySubscriptionNextResponse>

Promise<Models.JobsListBySubscriptionNextResponse>
- Defined in operations/jobs.ts:245
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:251
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ListJobsResponse>
  
  The callback
Returns void

update

update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, options?: msRest.RequestOptionsBase): Promise<Models.JobsUpdateResponse>
update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, callback: msRest.ServiceCallback<JobResponse>): void
update(jobName: string, resourceGroupName: string, body: UpdateJobParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponse>): void

- Defined in operations/jobs.ts:130
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.

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
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.JobsUpdateResponse>

Promise<Models.JobsUpdateResponse>
- Defined in operations/jobs.ts:138
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: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void
- Defined in operations/jobs.ts:147
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
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: StorageImportExportManagementClientContext

Returns Jobs

Methods

create

Parameters

jobName: string

resourceGroupName: string

body: PutJobParameters

Optional options: Models.JobsCreateOptionalParams

Returns Promise<Models.JobsCreateResponse>

Parameters

jobName: string

resourceGroupName: string

body: PutJobParameters

callback: msRest.ServiceCallback<JobResponse>

Returns void

Parameters

jobName: string

resourceGroupName: string

body: PutJobParameters

options: JobsCreateOptionalParams

callback: msRest.ServiceCallback<JobResponse>

Returns void

deleteMethod

Parameters

jobName: string

resourceGroupName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

jobName: string

resourceGroupName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

jobName: string

resourceGroupName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

jobName: string

resourceGroupName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.JobsGetResponse>

Parameters

jobName: string

resourceGroupName: string

callback: msRest.ServiceCallback<JobResponse>

Returns void

Parameters

jobName: string

resourceGroupName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<JobResponse>

Returns void

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: Models.JobsListByResourceGroupOptionalParams

Returns Promise<Models.JobsListByResourceGroupResponse>

Parameters

resourceGroupName: string

callback: msRest.ServiceCallback<ListJobsResponse>

Returns void

Parameters

resourceGroupName: string

options: JobsListByResourceGroupOptionalParams

callback: msRest.ServiceCallback<ListJobsResponse>

Returns void

listByResourceGroupNext

Parameters