JobsOperations Class
JobsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectJobsOperations
Constructor
JobsOperations(client, config, serializer, deserializer)
Parameters
Name | Description |
---|---|
client
Required
|
Client for service requests. |
config
Required
|
Configuration of service client. |
serializer
Required
|
An object model serializer. |
deserializer
Required
|
An object model deserializer. |
Variables
Name | Description |
---|---|
models
|
Alias to model classes used in this operation group. |
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.
create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, parameters: '_models.Job', **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. |
server_name
Required
|
The name of the server. |
job_agent_name
Required
|
The name of the job agent. |
job_name
Required
|
The name of the job to get. |
parameters
Required
|
The requested job state. |
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 |
---|---|
delete
Deletes a job.
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. |
server_name
Required
|
The name of the server. |
job_agent_name
Required
|
The name of the job agent. |
job_name
Required
|
The name of the job to delete. |
Keyword-Only Parameters
Name | Description |
---|---|
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 a job.
get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **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. |
server_name
Required
|
The name of the server. |
job_agent_name
Required
|
The name of the job agent. |
job_name
Required
|
The name of the job to get. |
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_agent
Gets a list of jobs.
list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> Iterable['_models.JobListResult']
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. |
server_name
Required
|
The name of the server. |
job_agent_name
Required
|
The name of the job agent. |
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 JobListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>
Azure SDK for Python