# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
import functools
from typing import Any, Callable, Dict, Generic, Iterable, Optional, TypeVar
import warnings
from azure.core.exceptions import ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, map_error
from azure.core.paging import ItemPaged
from azure.core.pipeline import PipelineResponse
from azure.core.pipeline.transport import HttpResponse
from azure.core.rest import HttpRequest
from azure.core.tracing.decorator import distributed_trace
from azure.mgmt.core.exceptions import ARMErrorFormat
from msrest import Serializer
from .. import models as _models
from .._vendor import _convert_request, _format_url_section
T = TypeVar('T')
ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]]
_SERIALIZER = Serializer()
_SERIALIZER.client_side_validation = False
def build_list_by_job_execution_request(
resource_group_name: str,
server_name: str,
job_agent_name: str,
job_name: str,
job_execution_id: str,
subscription_id: str,
*,
create_time_min: Optional[datetime.datetime] = None,
create_time_max: Optional[datetime.datetime] = None,
end_time_min: Optional[datetime.datetime] = None,
end_time_max: Optional[datetime.datetime] = None,
is_active: Optional[bool] = None,
skip: Optional[int] = None,
top: Optional[int] = None,
**kwargs: Any
) -> HttpRequest:
api_version = "2020-11-01-preview"
accept = "application/json"
# Construct URL
url = kwargs.pop("template_url", '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps')
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, 'str'),
"serverName": _SERIALIZER.url("server_name", server_name, 'str'),
"jobAgentName": _SERIALIZER.url("job_agent_name", job_agent_name, 'str'),
"jobName": _SERIALIZER.url("job_name", job_name, 'str'),
"jobExecutionId": _SERIALIZER.url("job_execution_id", job_execution_id, 'str'),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, 'str'),
}
url = _format_url_section(url, **path_format_arguments)
# Construct parameters
query_parameters = kwargs.pop("params", {}) # type: Dict[str, Any]
if create_time_min is not None:
query_parameters['createTimeMin'] = _SERIALIZER.query("create_time_min", create_time_min, 'iso-8601')
if create_time_max is not None:
query_parameters['createTimeMax'] = _SERIALIZER.query("create_time_max", create_time_max, 'iso-8601')
if end_time_min is not None:
query_parameters['endTimeMin'] = _SERIALIZER.query("end_time_min", end_time_min, 'iso-8601')
if end_time_max is not None:
query_parameters['endTimeMax'] = _SERIALIZER.query("end_time_max", end_time_max, 'iso-8601')
if is_active is not None:
query_parameters['isActive'] = _SERIALIZER.query("is_active", is_active, 'bool')
if skip is not None:
query_parameters['$skip'] = _SERIALIZER.query("skip", skip, 'int')
if top is not None:
query_parameters['$top'] = _SERIALIZER.query("top", top, 'int')
query_parameters['api-version'] = _SERIALIZER.query("api_version", api_version, 'str')
# Construct headers
header_parameters = kwargs.pop("headers", {}) # type: Dict[str, Any]
header_parameters['Accept'] = _SERIALIZER.header("accept", accept, 'str')
return HttpRequest(
method="GET",
url=url,
params=query_parameters,
headers=header_parameters,
**kwargs
)
def build_get_request(
resource_group_name: str,
server_name: str,
job_agent_name: str,
job_name: str,
job_execution_id: str,
step_name: str,
subscription_id: str,
**kwargs: Any
) -> HttpRequest:
api_version = "2020-11-01-preview"
accept = "application/json"
# Construct URL
url = kwargs.pop("template_url", '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}')
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, 'str'),
"serverName": _SERIALIZER.url("server_name", server_name, 'str'),
"jobAgentName": _SERIALIZER.url("job_agent_name", job_agent_name, 'str'),
"jobName": _SERIALIZER.url("job_name", job_name, 'str'),
"jobExecutionId": _SERIALIZER.url("job_execution_id", job_execution_id, 'str'),
"stepName": _SERIALIZER.url("step_name", step_name, 'str'),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, 'str'),
}
url = _format_url_section(url, **path_format_arguments)
# Construct parameters
query_parameters = kwargs.pop("params", {}) # type: Dict[str, Any]
query_parameters['api-version'] = _SERIALIZER.query("api_version", api_version, 'str')
# Construct headers
header_parameters = kwargs.pop("headers", {}) # type: Dict[str, Any]
header_parameters['Accept'] = _SERIALIZER.header("accept", accept, 'str')
return HttpRequest(
method="GET",
url=url,
params=query_parameters,
headers=header_parameters,
**kwargs
)
[docs]class JobStepExecutionsOperations(object):
"""JobStepExecutionsOperations 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.
:ivar models: Alias to model classes used in this operation group.
:type models: ~azure.mgmt.sql.models
:param client: Client for service requests.
:param config: Configuration of service client.
:param serializer: An object model serializer.
:param deserializer: An object model deserializer.
"""
models = _models
def __init__(self, client, config, serializer, deserializer):
self._client = client
self._serialize = serializer
self._deserialize = deserializer
self._config = config
[docs] @distributed_trace
def list_by_job_execution(
self,
resource_group_name: str,
server_name: str,
job_agent_name: str,
job_name: str,
job_execution_id: str,
create_time_min: Optional[datetime.datetime] = None,
create_time_max: Optional[datetime.datetime] = None,
end_time_min: Optional[datetime.datetime] = None,
end_time_max: Optional[datetime.datetime] = None,
is_active: Optional[bool] = None,
skip: Optional[int] = None,
top: Optional[int] = None,
**kwargs: Any
) -> Iterable["_models.JobExecutionListResult"]:
"""Lists the step executions of a job execution.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal.
:type resource_group_name: str
:param server_name: The name of the server.
:type server_name: str
:param job_agent_name: The name of the job agent.
:type job_agent_name: str
:param job_name: The name of the job to get.
:type job_name: str
:param job_execution_id: The id of the job execution.
:type job_execution_id: str
:param create_time_min: If specified, only job executions created at or after the specified
time are included.
:type create_time_min: ~datetime.datetime
:param create_time_max: If specified, only job executions created before the specified time are
included.
:type create_time_max: ~datetime.datetime
:param end_time_min: If specified, only job executions completed at or after the specified time
are included.
:type end_time_min: ~datetime.datetime
:param end_time_max: If specified, only job executions completed before the specified time are
included.
:type end_time_max: ~datetime.datetime
:param is_active: If specified, only active or only completed job executions are included.
:type is_active: bool
:param skip: The number of elements in the collection to skip.
:type skip: int
:param top: The number of elements to return from the collection.
:type top: int
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either JobExecutionListResult or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.sql.models.JobExecutionListResult]
:raises: ~azure.core.exceptions.HttpResponseError
"""
cls = kwargs.pop('cls', None) # type: ClsType["_models.JobExecutionListResult"]
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}))
def prepare_request(next_link=None):
if not next_link:
request = build_list_by_job_execution_request(
resource_group_name=resource_group_name,
server_name=server_name,
job_agent_name=job_agent_name,
job_name=job_name,
job_execution_id=job_execution_id,
subscription_id=self._config.subscription_id,
create_time_min=create_time_min,
create_time_max=create_time_max,
end_time_min=end_time_min,
end_time_max=end_time_max,
is_active=is_active,
skip=skip,
top=top,
template_url=self.list_by_job_execution.metadata['url'],
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
else:
request = build_list_by_job_execution_request(
resource_group_name=resource_group_name,
server_name=server_name,
job_agent_name=job_agent_name,
job_name=job_name,
job_execution_id=job_execution_id,
subscription_id=self._config.subscription_id,
create_time_min=create_time_min,
create_time_max=create_time_max,
end_time_min=end_time_min,
end_time_max=end_time_max,
is_active=is_active,
skip=skip,
top=top,
template_url=next_link,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
request.method = "GET"
return request
def extract_data(pipeline_response):
deserialized = self._deserialize("JobExecutionListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = self._client._pipeline.run(request, stream=False, **kwargs)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(
get_next, extract_data
)
list_by_job_execution.metadata = {'url': '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps'} # type: ignore
[docs] @distributed_trace
def get(
self,
resource_group_name: str,
server_name: str,
job_agent_name: str,
job_name: str,
job_execution_id: str,
step_name: str,
**kwargs: Any
) -> "_models.JobExecution":
"""Gets a step execution of a job execution.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal.
:type resource_group_name: str
:param server_name: The name of the server.
:type server_name: str
:param job_agent_name: The name of the job agent.
:type job_agent_name: str
:param job_name: The name of the job to get.
:type job_name: str
:param job_execution_id: The unique id of the job execution.
:type job_execution_id: str
:param step_name: The name of the step.
:type step_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: JobExecution, or the result of cls(response)
:rtype: ~azure.mgmt.sql.models.JobExecution
:raises: ~azure.core.exceptions.HttpResponseError
"""
cls = kwargs.pop('cls', None) # type: ClsType["_models.JobExecution"]
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}))
request = build_get_request(
resource_group_name=resource_group_name,
server_name=server_name,
job_agent_name=job_agent_name,
job_name=job_name,
job_execution_id=job_execution_id,
step_name=step_name,
subscription_id=self._config.subscription_id,
template_url=self.get.metadata['url'],
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
pipeline_response = self._client._pipeline.run(request, stream=False, **kwargs)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize('JobExecution', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get.metadata = {'url': '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}'} # type: ignore