JobsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:jobs> attribute.

Constructor

JobsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or Update a Container Apps Job. Create or Update a Container Apps Job.
begin_delete	Delete a Container Apps Job. Delete a Container Apps Job.
begin_start	Start a Container Apps Job. Start a Container Apps Job.
begin_stop_execution	Terminates execution of a running container apps job. Terminates execution of a running container apps job.
begin_stop_multiple_executions	Terminates execution of a running container apps job. Terminates execution of a running container apps job.
begin_update	Update properties of a Container Apps Job. Patches a Container Apps Job using JSON Merge Patch.
get	Get the properties of a Container Apps Job. Get the properties of a Container Apps Job.
get_detector	Get the diagnostics data for a given Container App Job. Get the diagnostics data for a Container App Job.
list_by_resource_group	Get the Container Apps Jobs in a given resource group. Get the Container Apps Jobs in a given resource group.
list_by_subscription	Get the Container Apps Jobs in a given subscription. Get the Container Apps Jobs in a given subscription.
list_detectors	Get the list of diagnostics for a given Container App Job. Get the list of diagnostics for a Container App Job.
list_secrets	List secrets for a container apps job. List secrets for a container apps job.
proxy_get	Get the properties of a Container App Job. Get the properties of a Container App Job.

begin_create_or_update

Create or Update a Container Apps Job.

async begin_create_or_update(resource_group_name: str, job_name: str, job_envelope: _models.Job, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Job]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.
job_envelope Required	Job or IO[bytes] Properties used to create a container apps job. Is either a Job type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[Job]	An instance of AsyncLROPoller that returns either Job or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a Container Apps Job.

async begin_delete(resource_group_name: str, job_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start

Start a Container Apps Job.

async begin_start(resource_group_name: str, job_name: str, template: _models.JobExecutionTemplate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.JobExecutionBase]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.
template	JobExecutionTemplate or IO[bytes] Properties used to start a job execution. Is either a JobExecutionTemplate type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
AsyncLROPoller[JobExecutionBase]	An instance of AsyncLROPoller that returns either JobExecutionBase or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop_execution

Terminates execution of a running container apps job.

async begin_stop_execution(resource_group_name: str, job_name: str, job_execution_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.
job_execution_name Required	str Job execution name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop_multiple_executions

Terminates execution of a running container apps job.

async begin_stop_multiple_executions(resource_group_name: str, job_name: str, **kwargs: Any) -> AsyncLROPoller[ContainerAppJobExecutions]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.

Returns

Type	Description
AsyncLROPoller[ContainerAppJobExecutions]	An instance of AsyncLROPoller that returns either ContainerAppJobExecutions or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Update properties of a Container Apps Job.

Patches a Container Apps Job using JSON Merge Patch.

async begin_update(resource_group_name: str, job_name: str, job_envelope: _models.JobPatchProperties, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Job]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.
job_envelope Required	JobPatchProperties or IO[bytes] Properties used to create a container apps job. Is either a JobPatchProperties type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[Job]	An instance of AsyncLROPoller that returns either Job or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the properties of a Container Apps Job.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.

Returns

Type	Description
Job	Job or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_detector

Get the diagnostics data for a given Container App Job.

Get the diagnostics data for a Container App Job.

async get_detector(resource_group_name: str, job_name: str, detector_name: str, **kwargs: Any) -> Diagnostics

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.
detector_name Required	str Name of the Container App Job detector. Required.

Returns

Type	Description
Diagnostics	Diagnostics or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get the Container Apps Jobs in a given resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[Job]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
AsyncItemPaged[Job]	An iterator like instance of either Job or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Get the Container Apps Jobs in a given subscription.

list_by_subscription(**kwargs: Any) -> AsyncIterable[Job]

Returns

Type	Description
AsyncItemPaged[Job]	An iterator like instance of either Job or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_detectors

Get the list of diagnostics for a given Container App Job.

Get the list of diagnostics for a Container App Job.

list_detectors(resource_group_name: str, job_name: str, **kwargs: Any) -> AsyncIterable[Diagnostics]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.

Returns

Type	Description
AsyncItemPaged[Diagnostics]	An iterator like instance of either Diagnostics or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_secrets

List secrets for a container apps job.

async list_secrets(resource_group_name: str, job_name: str, **kwargs: Any) -> JobSecretsCollection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.

Returns

Type	Description
JobSecretsCollection	JobSecretsCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

proxy_get

Get the properties of a Container App Job.

async proxy_get(resource_group_name: str, job_name: str, api_name: str, **kwargs: Any) -> Job

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
job_name Required	str Job Name. Required.
api_name Required	str Proxy API Name for Container App Job. Required.

Returns

Type	Description
Job	Job or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.appcontainers.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv67\\Lib\\site-packages\\azure\\mgmt\\appcontainers\\models\\__init__.py'>

Feedback

Was this page helpful?

Share via

JobsOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

begin_start

Parameters

Returns

Exceptions

begin_stop_execution

Parameters

Returns

Exceptions

begin_stop_multiple_executions

Parameters

Returns

Exceptions

begin_update

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_detector

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_by_subscription

Returns

Exceptions

list_detectors

Parameters

Returns

Exceptions

list_secrets

Parameters

Returns

Exceptions

proxy_get

Parameters

Returns

Exceptions

Attributes

models

Feedback