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
| create_or_update |
Creates or updates a job. |
| delete |
Deletes a job. |
| get |
Gets a job. |
| list_by_agent |
Gets a list of jobs. |
create_or_update
Creates or updates a job.
async create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, parameters: _models.Job, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Job
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
job_agent_name
Required
|
The name of the job agent. Required. |
|
job_name
Required
|
The name of the job to get. Required. |
|
parameters
Required
|
The requested job state. Is either a Job type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a job.
async delete(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) -> None
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
job_agent_name
Required
|
The name of the job agent. Required. |
|
job_name
Required
|
The name of the job to delete. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a job.
async get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) -> Job
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
job_agent_name
Required
|
The name of the job agent. Required. |
|
job_name
Required
|
The name of the job to get. Required. |
Returns
| Type | Description |
|---|---|
|
Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_agent
Gets a list of jobs.
list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> AsyncItemPaged[Job]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
job_agent_name
Required
|
The name of the job agent. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Job or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>