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 |
Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API. |
| begin_delete |
Deletes a job. |
| begin_update |
Updates the properties of an existing job. |
| book_shipment_pick_up |
Book shipment pick up. |
| cancel |
CancelJob. |
| get |
Gets information about the specified job. |
| list |
Lists all the jobs available under the subscription. |
| list_by_resource_group |
Lists all the jobs available under the given resource group. |
| list_credentials |
This method gets the unencrypted secrets related to the job. |
begin_create
Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.
async begin_create(resource_group_name: str, job_name: str, job_resource: _models.JobResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.JobResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. Required. |
|
job_resource
Required
|
JobResource or
IO
Job details from request body. Is either a JobResource 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 AsyncARMPolling. 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 AsyncLROPoller that returns either JobResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes a job.
async begin_delete(resource_group_name: str, job_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. 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 AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Updates the properties of an existing job.
async begin_update(resource_group_name: str, job_name: str, job_resource_update_parameter: _models.JobResourceUpdateParameter, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.JobResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. Required. |
|
job_resource_update_parameter
Required
|
Job update parameters from request body. Is either a JobResourceUpdateParameter type or a IO type. Required. |
|
if_match
Required
|
Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. 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 AsyncARMPolling. 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 AsyncLROPoller that returns either JobResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
book_shipment_pick_up
Book shipment pick up.
async book_shipment_pick_up(resource_group_name: str, job_name: str, shipment_pick_up_request: _models.ShipmentPickUpRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ShipmentPickUpResponseParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. Required. |
|
shipment_pick_up_request
Required
|
Details of shipment pick up request. Is either a ShipmentPickUpRequest 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 |
Returns
| Type | Description |
|---|---|
|
ShipmentPickUpResponse or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
cancel
CancelJob.
async cancel(resource_group_name: str, job_name: str, cancellation_reason: _models.CancellationReason, *, content_type: str = 'application/json', **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. Required. |
|
cancellation_reason
Required
|
Reason for cancellation. Is either a CancellationReason 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 |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets information about the specified job.
async get(resource_group_name: str, job_name: str, expand: str | None = None, **kwargs: Any) -> JobResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. Required. |
|
expand
Required
|
$expand is supported on details parameter for job, which provides details on the job stages. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
JobResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Lists all the jobs available under the subscription.
list(skip_token: str | None = None, **kwargs: Any) -> AsyncIterable[JobResource]Parameters
| Name | Description |
|---|---|
|
skip_token
Required
|
$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. Default value is None. |
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 JobResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
Lists all the jobs available under the given resource group.
list_by_resource_group(resource_group_name: str, skip_token: str | None = None, **kwargs: Any) -> AsyncIterable[JobResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
skip_token
Required
|
$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. Default value is None. |
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 JobResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_credentials
This method gets the unencrypted secrets related to the job.
list_credentials(resource_group_name: str, job_name: str, **kwargs: Any) -> AsyncIterable[UnencryptedCredentials]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The Resource Group Name. Required. |
|
job_name
Required
|
The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only. 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 UnencryptedCredentials or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.databox.v2020_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\databox\\v2020_04_01\\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