Share via

JobsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AzureMediaServices's

<xref:jobs> attribute.

Inheritance
builtins.object
JobsOperations

Constructor

JobsOperations(*args, **kwargs)

Methods

cancel_job

Cancel Job.

Cancel a Job.
create

Create Job.

Creates a Job.
delete

Delete Job.

Deletes a Job.
get

Get Job.

Gets a Job.
list

List Jobs.

Lists all of the Jobs for the Transform.
update

Update Job.

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.

cancel_job

Cancel Job.

Cancel a Job.

cancel_job(resource_group_name: str, account_name: str, transform_name: str, job_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
transform_name
Required
str

The Transform name. Required.
job_name
Required
str

The Job name. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create

Create Job.

Creates a Job.

create(resource_group_name: str, account_name: str, transform_name: str, job_name: str, parameters: _models.Job, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Job

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
transform_name
Required
str

The Transform name. Required.
job_name
Required
str

The Job name. Required.
parameters
Required
Job or IO

The request parameters. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Job

Job or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete Job.

Deletes a Job.

delete(resource_group_name: str, account_name: str, transform_name: str, job_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
transform_name
Required
str

The Transform name. Required.
job_name
Required
str

The Job name. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get Job.

Gets a Job.

get(resource_group_name: str, account_name: str, transform_name: str, job_name: str, **kwargs: Any) -> Job

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
transform_name
Required
str

The Transform name. Required.
job_name
Required
str

The Job name. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Job

Job or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List Jobs.

Lists all of the Jobs for the Transform.

list(resource_group_name: str, account_name: str, transform_name: str, filter: str | None = None, orderby: str | None = None, **kwargs: Any) -> Iterable[Job]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
transform_name
Required
str

The Transform name. Required.
filter
Required
str

Restricts the set of items returned. Default value is None.
orderby
Required
str

Specifies the key by which the result collection should be ordered. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[Job]

An iterator like instance of either Job or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Update Job.

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.

update(resource_group_name: str, account_name: str, transform_name: str, job_name: str, parameters: _models.Job, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Job

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
transform_name
Required
str

The Transform name. Required.
job_name
Required
str

The Job name. Required.
parameters
Required
Job or IO

The request parameters. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Job

Job or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.media.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\media\\models\\__init__.py'>