JobStepsOperations Class

JobStepsOperations 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.object
JobStepsOperations

Constructor

JobStepsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

create_or_update

Creates or updates a job step. This will implicitly create a new job version.

delete

Deletes a job step. This will implicitly create a new job version.

get

Gets a job step in a job's current version.

get_by_version

Gets the specified version of a job step.

list_by_job

Gets all job steps for a job's current version.

list_by_version

Gets all job steps in the specified job version.

create_or_update

Creates or updates a job step. This will implicitly create a new job version.

create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, parameters: _models.JobStep, **kwargs: Any) -> _models.JobStep

Parameters

resource_group_name
str
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
str
Required

The name of the server.

job_agent_name
str
Required

The name of the job agent.

job_name
str
Required

The name of the job.

step_name
str
Required

The name of the job step.

parameters
JobStep
Required

The requested state of the job step.

cls
callable

A custom type or function that will be passed the direct response

Returns

JobStep, or the result of cls(response)

Return type

Exceptions

delete

Deletes a job step. This will implicitly create a new job version.

delete(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, **kwargs: Any) -> None

Parameters

resource_group_name
str
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
str
Required

The name of the server.

job_agent_name
str
Required

The name of the job agent.

job_name
str
Required

The name of the job.

step_name
str
Required

The name of the job step to delete.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Gets a job step in a job's current version.

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, **kwargs: Any) -> _models.JobStep

Parameters

resource_group_name
str
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
str
Required

The name of the server.

job_agent_name
str
Required

The name of the job agent.

job_name
str
Required

The name of the job.

step_name
str
Required

The name of the job step.

cls
callable

A custom type or function that will be passed the direct response

Returns

JobStep, or the result of cls(response)

Return type

Exceptions

get_by_version

Gets the specified version of a job step.

get_by_version(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, step_name: str, **kwargs: Any) -> _models.JobStep

Parameters

resource_group_name
str
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
str
Required

The name of the server.

job_agent_name
str
Required

The name of the job agent.

job_name
str
Required

The name of the job.

job_version
int
Required

The version of the job to get.

step_name
str
Required

The name of the job step.

cls
callable

A custom type or function that will be passed the direct response

Returns

JobStep, or the result of cls(response)

Return type

Exceptions

list_by_job

Gets all job steps for a job's current version.

list_by_job(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) -> Iterable[_models.JobStepListResult]

Parameters

resource_group_name
str
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
str
Required

The name of the server.

job_agent_name
str
Required

The name of the job agent.

job_name
str
Required

The name of the job to get.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobStepListResult or the result of cls(response)

Return type

Exceptions

list_by_version

Gets all job steps in the specified job version.

list_by_version(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, **kwargs: Any) -> Iterable[_models.JobStepListResult]

Parameters

resource_group_name
str
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
str
Required

The name of the server.

job_agent_name
str
Required

The name of the job agent.

job_name
str
Required

The name of the job to get.

job_version
int
Required

The version of the job to get.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobStepListResult or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>