Jobs interface

Package:

@azure/arm-mediaservices

Interface representing a Jobs.

Methods

cancelJob(string, string, string, string, JobsCancelJobOptionalParams)	Cancel a Job.
create(string, string, string, string, Job, JobsCreateOptionalParams)	Creates a Job.
delete(string, string, string, string, JobsDeleteOptionalParams)	Deletes a Job.
get(string, string, string, string, JobsGetOptionalParams)	Gets a Job.
list(string, string, string, JobsListOptionalParams)	Lists all of the Jobs for the Transform.
update(string, string, string, string, Job, JobsUpdateOptionalParams)	Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.

Method Details

cancelJob(string, string, string, string, JobsCancelJobOptionalParams)

Cancel a Job.

function cancelJob(resourceGroupName: string, accountName: string, transformName: string, jobName: string, options?: JobsCancelJobOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the Azure subscription.

accountName

string

The Media Services account name.

transformName

string

The Transform name.

jobName

string

The Job name.

options

JobsCancelJobOptionalParams

The options parameters.

Returns

Promise<void>

create(string, string, string, string, Job, JobsCreateOptionalParams)

Creates a Job.

function create(resourceGroupName: string, accountName: string, transformName: string, jobName: string, parameters: Job, options?: JobsCreateOptionalParams): Promise<Job>

Parameters

resourceGroupName

string

The name of the resource group within the Azure subscription.

accountName

string

The Media Services account name.

transformName

string

The Transform name.

jobName

string

The Job name.

parameters

Job

The request parameters

options

JobsCreateOptionalParams

The options parameters.

Returns

Promise<Job>

delete(string, string, string, string, JobsDeleteOptionalParams)

Deletes a Job.

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

Parameters

resourceGroupName

string

The name of the resource group within the Azure subscription.

accountName

string

The Media Services account name.

transformName

string

The Transform name.

jobName

string

The Job name.

options

JobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

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

Gets a Job.

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

Parameters

resourceGroupName

string

The name of the resource group within the Azure subscription.

accountName

string

The Media Services account name.

transformName

string

The Transform name.

jobName

string

The Job name.

options

JobsGetOptionalParams

The options parameters.

Returns

Promise<Job>

list(string, string, string, JobsListOptionalParams)

Lists all of the Jobs for the Transform.

function list(resourceGroupName: string, accountName: string, transformName: string, options?: JobsListOptionalParams): PagedAsyncIterableIterator<Job, Job[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the Azure subscription.

accountName

string

The Media Services account name.

transformName

string

The Transform name.

options

JobsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Job, Job[], PageSettings>

update(string, string, string, string, Job, JobsUpdateOptionalParams)

Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.

function update(resourceGroupName: string, accountName: string, transformName: string, jobName: string, parameters: Job, options?: JobsUpdateOptionalParams): Promise<Job>

Parameters

resourceGroupName

string

The name of the resource group within the Azure subscription.

accountName

string

The Media Services account name.

transformName

string

The Transform name.

jobName

string

The Job name.

parameters

Job

The request parameters

options

JobsUpdateOptionalParams

The options parameters.

Returns

Promise<Job>