# 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.
# --------------------------------------------------------------------------
from io import IOBase
import sys
from typing import Any, Callable, Dict, IO, Iterable, Optional, TypeVar, Union, overload
import urllib.parse
from azure.core.exceptions import (
ClientAuthenticationError,
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
ResourceNotModifiedError,
map_error,
)
from azure.core.paging import ItemPaged
from azure.core.pipeline import PipelineResponse
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.tracing.decorator import distributed_trace
from azure.core.utils import case_insensitive_dict
from azure.mgmt.core.exceptions import ARMErrorFormat
from .. import models as _models
from .._serialization import Serializer
if sys.version_info >= (3, 9):
from collections.abc import MutableMapping
else:
from typing import MutableMapping # type: ignore
JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object
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_factory_request(
resource_group_name: str, factory_name: str, subscription_id: str, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_create_or_update_request(
resource_group_name: str,
factory_name: str,
pipeline_name: str,
subscription_id: str,
*,
if_match: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
"pipelineName": _SERIALIZER.url(
"pipeline_name",
pipeline_name,
"str",
max_length=260,
min_length=1,
pattern=r"^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$",
),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if if_match is not None:
_headers["If-Match"] = _SERIALIZER.header("if_match", if_match, "str")
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs)
def build_get_request(
resource_group_name: str,
factory_name: str,
pipeline_name: str,
subscription_id: str,
*,
if_none_match: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
"pipelineName": _SERIALIZER.url(
"pipeline_name",
pipeline_name,
"str",
max_length=260,
min_length=1,
pattern=r"^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$",
),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if if_none_match is not None:
_headers["If-None-Match"] = _SERIALIZER.header("if_none_match", if_none_match, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_delete_request(
resource_group_name: str, factory_name: str, pipeline_name: str, subscription_id: str, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
"pipelineName": _SERIALIZER.url(
"pipeline_name",
pipeline_name,
"str",
max_length=260,
min_length=1,
pattern=r"^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$",
),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs)
def build_create_run_request(
resource_group_name: str,
factory_name: str,
pipeline_name: str,
subscription_id: str,
*,
reference_pipeline_run_id: Optional[str] = None,
is_recovery: Optional[bool] = None,
start_activity_name: Optional[str] = None,
start_from_failure: Optional[bool] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
"pipelineName": _SERIALIZER.url(
"pipeline_name",
pipeline_name,
"str",
max_length=260,
min_length=1,
pattern=r"^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$",
),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
if reference_pipeline_run_id is not None:
_params["referencePipelineRunId"] = _SERIALIZER.query(
"reference_pipeline_run_id", reference_pipeline_run_id, "str"
)
if is_recovery is not None:
_params["isRecovery"] = _SERIALIZER.query("is_recovery", is_recovery, "bool")
if start_activity_name is not None:
_params["startActivityName"] = _SERIALIZER.query("start_activity_name", start_activity_name, "str")
if start_from_failure is not None:
_params["startFromFailure"] = _SERIALIZER.query("start_from_failure", start_from_failure, "bool")
# Construct headers
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
[docs]
class PipelinesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.datafactory.DataFactoryManagementClient`'s
:attr:`pipelines` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
[docs]
@distributed_trace
def list_by_factory(
self, resource_group_name: str, factory_name: str, **kwargs: Any
) -> Iterable["_models.PipelineResource"]:
"""Lists pipelines.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:return: An iterator like instance of either PipelineResource or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.datafactory.models.PipelineResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.PipelineListResponse] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_request = build_list_by_factory_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("PipelineListResponse", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **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)
@overload
def create_or_update(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
pipeline: _models.PipelineResource,
if_match: Optional[str] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.PipelineResource:
"""Creates or updates a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param pipeline: Pipeline resource definition. Required.
:type pipeline: ~azure.mgmt.datafactory.models.PipelineResource
:param if_match: ETag of the pipeline entity. Should only be specified for update, for which
it should match existing entity or can be * for unconditional update. Default value is None.
:type if_match: str
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: PipelineResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.PipelineResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def create_or_update(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
pipeline: IO[bytes],
if_match: Optional[str] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.PipelineResource:
"""Creates or updates a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param pipeline: Pipeline resource definition. Required.
:type pipeline: IO[bytes]
:param if_match: ETag of the pipeline entity. Should only be specified for update, for which
it should match existing entity or can be * for unconditional update. Default value is None.
:type if_match: str
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: PipelineResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.PipelineResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs]
@distributed_trace
def create_or_update(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
pipeline: Union[_models.PipelineResource, IO[bytes]],
if_match: Optional[str] = None,
**kwargs: Any
) -> _models.PipelineResource:
"""Creates or updates a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param pipeline: Pipeline resource definition. Is either a PipelineResource type or a IO[bytes]
type. Required.
:type pipeline: ~azure.mgmt.datafactory.models.PipelineResource or IO[bytes]
:param if_match: ETag of the pipeline entity. Should only be specified for update, for which
it should match existing entity or can be * for unconditional update. Default value is None.
:type if_match: str
:return: PipelineResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.PipelineResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.PipelineResource] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(pipeline, (IOBase, bytes)):
_content = pipeline
else:
_json = self._serialize.body(pipeline, "PipelineResource")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
pipeline_name=pipeline_name,
subscription_id=self._config.subscription_id,
if_match=if_match,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **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("PipelineResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
[docs]
@distributed_trace
def get(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
if_none_match: Optional[str] = None,
**kwargs: Any
) -> Optional[_models.PipelineResource]:
"""Gets a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param if_none_match: ETag of the pipeline entity. Should only be specified for get. If the
ETag matches the existing entity tag, or if * was provided, then no content will be returned.
Default value is None.
:type if_none_match: str
:return: PipelineResource or None or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.PipelineResource or None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Optional[_models.PipelineResource]] = kwargs.pop("cls", None)
_request = build_get_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
pipeline_name=pipeline_name,
subscription_id=self._config.subscription_id,
if_none_match=if_none_match,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 304]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize("PipelineResource", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
[docs]
@distributed_trace
def delete( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, factory_name: str, pipeline_name: str, **kwargs: Any
) -> None:
"""Deletes a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
_request = build_delete_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
pipeline_name=pipeline_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 204]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {}) # type: ignore
@overload
def create_run(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
reference_pipeline_run_id: Optional[str] = None,
is_recovery: Optional[bool] = None,
start_activity_name: Optional[str] = None,
start_from_failure: Optional[bool] = None,
parameters: Optional[Dict[str, JSON]] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CreateRunResponse:
"""Creates a run of a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param reference_pipeline_run_id: The pipeline run identifier. If run ID is specified the
parameters of the specified run will be used to create a new run. Default value is None.
:type reference_pipeline_run_id: str
:param is_recovery: Recovery mode flag. If recovery mode is set to true, the specified
referenced pipeline run and the new run will be grouped under the same groupId. Default value
is None.
:type is_recovery: bool
:param start_activity_name: In recovery mode, the rerun will start from this activity. If not
specified, all activities will run. Default value is None.
:type start_activity_name: str
:param start_from_failure: In recovery mode, if set to true, the rerun will start from failed
activities. The property will be used only if startActivityName is not specified. Default value
is None.
:type start_from_failure: bool
:param parameters: Parameters of the pipeline run. These parameters will be used only if the
runId is not specified. Default value is None.
:type parameters: dict[str, JSON]
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: CreateRunResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.CreateRunResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def create_run(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
reference_pipeline_run_id: Optional[str] = None,
is_recovery: Optional[bool] = None,
start_activity_name: Optional[str] = None,
start_from_failure: Optional[bool] = None,
parameters: Optional[IO[bytes]] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.CreateRunResponse:
"""Creates a run of a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param reference_pipeline_run_id: The pipeline run identifier. If run ID is specified the
parameters of the specified run will be used to create a new run. Default value is None.
:type reference_pipeline_run_id: str
:param is_recovery: Recovery mode flag. If recovery mode is set to true, the specified
referenced pipeline run and the new run will be grouped under the same groupId. Default value
is None.
:type is_recovery: bool
:param start_activity_name: In recovery mode, the rerun will start from this activity. If not
specified, all activities will run. Default value is None.
:type start_activity_name: str
:param start_from_failure: In recovery mode, if set to true, the rerun will start from failed
activities. The property will be used only if startActivityName is not specified. Default value
is None.
:type start_from_failure: bool
:param parameters: Parameters of the pipeline run. These parameters will be used only if the
runId is not specified. Default value is None.
:type parameters: IO[bytes]
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: CreateRunResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.CreateRunResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs]
@distributed_trace
def create_run(
self,
resource_group_name: str,
factory_name: str,
pipeline_name: str,
reference_pipeline_run_id: Optional[str] = None,
is_recovery: Optional[bool] = None,
start_activity_name: Optional[str] = None,
start_from_failure: Optional[bool] = None,
parameters: Optional[Union[Dict[str, JSON], IO[bytes]]] = None,
**kwargs: Any
) -> _models.CreateRunResponse:
"""Creates a run of a pipeline.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param pipeline_name: The pipeline name. Required.
:type pipeline_name: str
:param reference_pipeline_run_id: The pipeline run identifier. If run ID is specified the
parameters of the specified run will be used to create a new run. Default value is None.
:type reference_pipeline_run_id: str
:param is_recovery: Recovery mode flag. If recovery mode is set to true, the specified
referenced pipeline run and the new run will be grouped under the same groupId. Default value
is None.
:type is_recovery: bool
:param start_activity_name: In recovery mode, the rerun will start from this activity. If not
specified, all activities will run. Default value is None.
:type start_activity_name: str
:param start_from_failure: In recovery mode, if set to true, the rerun will start from failed
activities. The property will be used only if startActivityName is not specified. Default value
is None.
:type start_from_failure: bool
:param parameters: Parameters of the pipeline run. These parameters will be used only if the
runId is not specified. Is either a {str: JSON} type or a IO[bytes] type. Default value is
None.
:type parameters: dict[str, JSON] or IO[bytes]
:return: CreateRunResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.CreateRunResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.CreateRunResponse] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(parameters, (IOBase, bytes)):
_content = parameters
else:
if parameters is not None:
_json = self._serialize.body(parameters, "{object}")
else:
_json = None
_request = build_create_run_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
pipeline_name=pipeline_name,
subscription_id=self._config.subscription_id,
reference_pipeline_run_id=reference_pipeline_run_id,
is_recovery=is_recovery,
start_activity_name=start_activity_name,
start_from_failure=start_from_failure,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **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("CreateRunResponse", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore