JobsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:jobs> attribute.
- Inheritance
-
builtins.objectJobsOperations
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. |
| 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_secrets |
List secrets for a container apps job. List secrets for a container apps job. |
begin_create_or_update
Create or Update a Container Apps Job.
Create or Update a Container Apps Job.
begin_create_or_update(resource_group_name: str, job_name: str, job_envelope: _models.Job, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Job]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
|
job_envelope
Required
|
Properties used to create a container apps job. Is either a Job type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete a Container Apps Job.
Delete a Container Apps Job.
begin_delete(resource_group_name: str, job_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_start
Start a Container Apps Job.
Start a Container Apps Job.
begin_start(resource_group_name: str, job_name: str, template: _models.JobExecutionTemplate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.JobExecutionBase]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
|
template
Required
|
Properties used to start a job execution. Is either a JobExecutionTemplate type or a IO type. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either JobExecutionBase or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_stop_execution
Terminates execution of a running container apps job.
Terminates execution of a running container apps job.
begin_stop_execution(resource_group_name: str, job_name: str, job_execution_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
|
job_execution_name
Required
|
Job execution name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_stop_multiple_executions
Terminates execution of a running container apps job.
Terminates execution of a running container apps job.
begin_stop_multiple_executions(resource_group_name: str, job_name: str, **kwargs: Any) -> LROPoller[ContainerAppJobExecutions]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either ContainerAppJobExecutions or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update properties of a Container Apps Job.
Patches a Container Apps Job using JSON Merge Patch.
begin_update(resource_group_name: str, job_name: str, job_envelope: _models.JobPatchProperties, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Job]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
|
job_envelope
Required
|
Properties used to create a container apps job. Is either a JobPatchProperties type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get the properties of a Container Apps Job.
Get the properties of a Container Apps Job.
get(resource_group_name: str, job_name: str, **kwargs: Any) -> JobParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Job]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_subscription
Get the Container Apps Jobs in a given subscription.
Get the Container Apps Jobs in a given subscription.
list_by_subscription(**kwargs: Any) -> Iterable[Job]Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_secrets
List secrets for a container apps job.
List secrets for a container apps job.
list_secrets(resource_group_name: str, job_name: str, **kwargs: Any) -> JobSecretsCollectionParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
job_name
Required
|
Job Name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
JobSecretsCollection or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.appcontainers.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\appcontainers\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for