JobStepsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:job_steps> attribute.

Constructor

JobStepsOperations(*args, **kwargs)

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.

async create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, parameters: _models.JobStep, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobStep

Parameters

Name	Description
resource_group_name Required	str 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	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
job_name Required	str The name of the job. Required.
step_name Required	str The name of the job step. Required.
parameters Required	JobStep or IO[bytes] The requested state of the job step. Is either a JobStep type or a IO[bytes] type. Required.

Returns

Type	Description
JobStep	JobStep or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

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

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

Parameters

Name	Description
resource_group_name Required	str 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	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
job_name Required	str The name of the job. Required.
step_name Required	str The name of the job step to delete. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

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

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

Parameters

Name	Description
resource_group_name Required	str 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	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
job_name Required	str The name of the job. Required.
step_name Required	str The name of the job step. Required.

Returns

Type	Description
JobStep	JobStep or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_by_version

Gets the specified version of a job step.

async 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) -> JobStep

Parameters

Name	Description
resource_group_name Required	str 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	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
job_name Required	str The name of the job. Required.
job_version Required	int The version of the job to get. Required.
step_name Required	str The name of the job step. Required.

Returns

Type	Description
JobStep	JobStep or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> AsyncItemPaged[JobStep]

Parameters

Name	Description
resource_group_name Required	str 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	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
job_name Required	str The name of the job to get. Required.

Returns

Type	Description
AsyncItemPaged[JobStep]	An iterator like instance of either JobStep or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> AsyncItemPaged[JobStep]

Parameters

Name	Description
resource_group_name Required	str 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	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
job_name Required	str The name of the job to get. Required.
job_version Required	int The version of the job to get. Required.

Returns

Type	Description
AsyncItemPaged[JobStep]	An iterator like instance of either JobStep or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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'>