Share via

Jobs interface

  • Reference
Package:
@azure/arm-storsimple8000series

Interface representing a Jobs.

Methods

beginCancel(string, string, string, string, JobsCancelOptionalParams)

Cancels a job on the device.
beginCancelAndWait(string, string, string, string, JobsCancelOptionalParams)

Cancels a job on the device.
get(string, string, string, string, JobsGetOptionalParams)

Gets the details of the specified job name.
listByDevice(string, string, string, JobsListByDeviceOptionalParams)

Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned.
listByManager(string, string, JobsListByManagerOptionalParams)

Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned.

Method Details

beginCancel(string, string, string, string, JobsCancelOptionalParams)

Cancels a job on the device.

function beginCancel(deviceName: string, jobName: string, resourceGroupName: string, managerName: string, options?: JobsCancelOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name

jobName

string

The jobName.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
JobsCancelOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginCancelAndWait(string, string, string, string, JobsCancelOptionalParams)

Cancels a job on the device.

function beginCancelAndWait(deviceName: string, jobName: string, resourceGroupName: string, managerName: string, options?: JobsCancelOptionalParams): Promise<void>

Parameters

deviceName

string

The device name

jobName

string

The jobName.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
JobsCancelOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, JobsGetOptionalParams)

Gets the details of the specified job name.

function get(deviceName: string, jobName: string, resourceGroupName: string, managerName: string, options?: JobsGetOptionalParams): Promise<Job>

Parameters

deviceName

string

The device name

jobName

string

The job Name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
JobsGetOptionalParams

The options parameters.

Returns

Promise<Job>

listByDevice(string, string, string, JobsListByDeviceOptionalParams)

Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned.

function listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: JobsListByDeviceOptionalParams): PagedAsyncIterableIterator<Job, Job[], PageSettings>

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
JobsListByDeviceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Job, Job[], PageSettings>

listByManager(string, string, JobsListByManagerOptionalParams)

Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned.

function listByManager(resourceGroupName: string, managerName: string, options?: JobsListByManagerOptionalParams): PagedAsyncIterableIterator<Job, Job[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
JobsListByManagerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Job, Job[], PageSettings>