Package version:

Interface Jobs

Interface representing a Jobs.

Hierarchy

Jobs

Index

Methods

beginCancel beginCancelAndWait get listByDevice listByManager

Methods

beginCancel

beginCancel(deviceName: string, jobName: string, resourceGroupName: string, managerName: string, options?: JobsCancelOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Cancels a job on the device.
Parameters
- deviceName: string
  
  The device name
- jobName: string
  
  The jobName.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: JobsCancelOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/jobs.ts:72

beginCancelAndWait

beginCancelAndWait(deviceName: string, jobName: string, resourceGroupName: string, managerName: string, options?: JobsCancelOptionalParams): Promise<void>
Cancels a job on the device.
Parameters
- deviceName: string
  
  The device name
- jobName: string
  
  The jobName.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: JobsCancelOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/jobs.ts:87

get

get(deviceName: string, jobName: string, resourceGroupName: string, managerName: string, options?: JobsGetOptionalParams): Promise<Job>
Gets the details of the specified job name.
Parameters
- deviceName: string
  
  The device name
- jobName: string
  
  The job Name.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: JobsGetOptionalParams
  
  The options parameters.
Returns Promise<Job>
- Defined in operationsInterfaces/jobs.ts:57

listByDevice

listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: JobsListByDeviceOptionalParams): PagedAsyncIterableIterator<Job>
Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned.
Parameters
- deviceName: string
  
  The device name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: JobsListByDeviceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Job>
- Defined in operationsInterfaces/jobs.ts:31

listByManager

listByManager(resourceGroupName: string, managerName: string, options?: JobsListByManagerOptionalParams): PagedAsyncIterableIterator<Job>
Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned.
Parameters
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: JobsListByManagerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Job>
- Defined in operationsInterfaces/jobs.ts:44

Interface Jobs

Hierarchy

Index

Methods

Methods

beginCancel

Parameters

deviceName: string

jobName: string

resourceGroupName: string

managerName: string

Optional options: JobsCancelOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCancelAndWait

Parameters

deviceName: string

jobName: string

resourceGroupName: string

managerName: string

Optional options: JobsCancelOptionalParams

Returns Promise<void>

get

Parameters

deviceName: string

jobName: string

resourceGroupName: string

managerName: string

Optional options: JobsGetOptionalParams

Returns Promise<Job>

listByDevice

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: JobsListByDeviceOptionalParams

Returns PagedAsyncIterableIterator<Job>

listByManager

Parameters

resourceGroupName: string

managerName: string

Optional options: JobsListByManagerOptionalParams

Returns PagedAsyncIterableIterator<Job>

Settings

Member Visibility

Theme

`Optional` options: JobsCancelOptionalParams

`Optional` options: JobsCancelOptionalParams

`Optional` options: JobsGetOptionalParams

`Optional` options: JobsListByDeviceOptionalParams

`Optional` options: JobsListByManagerOptionalParams