# pylint: disable=too-many-lines
# 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 typing import Any, Callable, Dict, IO, Iterable, Optional, TypeVar, Union, cast, overload
from urllib.parse import parse_qs, urljoin, urlparse
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.polling import LROPoller, NoPolling, PollingMethod
from azure.core.rest import HttpRequest
from azure.core.tracing.decorator import distributed_trace
from azure.core.utils import case_insensitive_dict
from azure.mgmt.core.exceptions import ARMErrorFormat
from azure.mgmt.core.polling.arm_polling import ARMPolling
from .. import models as _models
from .._serialization import Serializer
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_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes",
) # 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 = _format_url_section(_url, **path_format_arguments)
# 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,
integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# 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,
integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# 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_update_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# 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="PATCH", url=_url, params=_params, headers=_headers, **kwargs)
def build_delete_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# 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_get_status_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_list_outbound_network_dependencies_endpoints_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# 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_get_connection_info_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_regenerate_auth_key_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# 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)
def build_list_auth_keys_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_start_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_stop_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_sync_credentials_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_get_monitoring_data_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_upgrade_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_remove_links_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# 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)
def build_create_linked_integration_runtime_request(
resource_group_name: str, factory_name: str, integration_runtime_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 = kwargs.pop("api_version", _params.pop("api-version", "2018-06-01")) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime",
) # 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]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# 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 IntegrationRuntimesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.datafactory.DataFactoryManagementClient`'s
:attr:`integration_runtimes` 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.IntegrationRuntimeResource"]:
"""Lists integration runtimes.
: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
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either IntegrationRuntimeResource or the result of
cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.datafactory.models.IntegrationRuntimeResource]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeListResponse]
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
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,
template_url=self.list_by_factory.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
else:
# make call to next link with the client's api-version
_parsed_next_link = urlparse(next_link)
_next_request_params = case_insensitive_dict(parse_qs(_parsed_next_link.query))
_next_request_params["api-version"] = self._config.api_version
request = HttpRequest("GET", urljoin(next_link, _parsed_next_link.path), params=_next_request_params)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
request.method = "GET"
return request
def extract_data(pipeline_response):
deserialized = self._deserialize("IntegrationRuntimeListResponse", 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( # type: ignore # pylint: disable=protected-access
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_factory.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes"} # type: ignore
@overload
def create_or_update(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
integration_runtime: _models.IntegrationRuntimeResource,
if_match: Optional[str] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeResource:
"""Creates or updates an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param integration_runtime: Integration runtime resource definition. Required.
:type integration_runtime: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:param if_match: ETag of the integration runtime 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
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def create_or_update(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
integration_runtime: IO,
if_match: Optional[str] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeResource:
"""Creates or updates an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param integration_runtime: Integration runtime resource definition. Required.
:type integration_runtime: IO
:param if_match: ETag of the integration runtime 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
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def create_or_update(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
integration_runtime: Union[_models.IntegrationRuntimeResource, IO],
if_match: Optional[str] = None,
**kwargs: Any
) -> _models.IntegrationRuntimeResource:
"""Creates or updates an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param integration_runtime: Integration runtime resource definition. Is either a model type or
a IO type. Required.
:type integration_runtime: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource or IO
:param if_match: ETag of the integration runtime 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. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
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 = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeResource]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(integration_runtime, (IO, bytes)):
_content = integration_runtime
else:
_json = self._serialize.body(integration_runtime, "IntegrationRuntimeResource")
request = build_create_or_update_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
if_match=if_match,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.create_or_update.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
create_or_update.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}"} # type: ignore
[docs] @distributed_trace
def get(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
if_none_match: Optional[str] = None,
**kwargs: Any
) -> Optional[_models.IntegrationRuntimeResource]:
"""Gets an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param if_none_match: ETag of the integration runtime 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
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or None or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource or None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.IntegrationRuntimeResource]]
request = build_get_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
if_none_match=if_none_match,
api_version=api_version,
template_url=self.get.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **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("IntegrationRuntimeResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}"} # type: ignore
@overload
def update(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
update_integration_runtime_request: _models.UpdateIntegrationRuntimeRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeResource:
"""Updates an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param update_integration_runtime_request: The parameters for updating an integration runtime.
Required.
:type update_integration_runtime_request:
~azure.mgmt.datafactory.models.UpdateIntegrationRuntimeRequest
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def update(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
update_integration_runtime_request: IO,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeResource:
"""Updates an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param update_integration_runtime_request: The parameters for updating an integration runtime.
Required.
:type update_integration_runtime_request: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def update(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
update_integration_runtime_request: Union[_models.UpdateIntegrationRuntimeRequest, IO],
**kwargs: Any
) -> _models.IntegrationRuntimeResource:
"""Updates an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param update_integration_runtime_request: The parameters for updating an integration runtime.
Is either a model type or a IO type. Required.
:type update_integration_runtime_request:
~azure.mgmt.datafactory.models.UpdateIntegrationRuntimeRequest or IO
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeResource or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeResource
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
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 = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeResource]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(update_integration_runtime_request, (IO, bytes)):
_content = update_integration_runtime_request
else:
_json = self._serialize.body(update_integration_runtime_request, "UpdateIntegrationRuntimeRequest")
request = build_update_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.update.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeResource", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
update.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}"} # type: ignore
[docs] @distributed_trace
def delete( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> None:
"""Deletes an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
request = build_delete_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.delete.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **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, {})
delete.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}"} # type: ignore
[docs] @distributed_trace
def get_status(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> _models.IntegrationRuntimeStatusResponse:
"""Gets detailed status information for an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeStatusResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeStatusResponse]
request = build_get_status_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.get_status.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeStatusResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get_status.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus"} # type: ignore
[docs] @distributed_trace
def list_outbound_network_dependencies_endpoints(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> _models.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse:
"""Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse or the result of
cls(response)
:rtype:
~azure.mgmt.datafactory.models.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop(
"cls", None
) # type: ClsType[_models.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse]
request = build_list_outbound_network_dependencies_endpoints_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.list_outbound_network_dependencies_endpoints.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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(
"IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse", pipeline_response
)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
list_outbound_network_dependencies_endpoints.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints"} # type: ignore
[docs] @distributed_trace
def get_connection_info(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> _models.IntegrationRuntimeConnectionInfo:
"""Gets the on-premises integration runtime connection information for encrypting the on-premises
data source credentials.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeConnectionInfo or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeConnectionInfo
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeConnectionInfo]
request = build_get_connection_info_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.get_connection_info.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeConnectionInfo", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get_connection_info.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo"} # type: ignore
@overload
def regenerate_auth_key(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
regenerate_key_parameters: _models.IntegrationRuntimeRegenerateKeyParameters,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeAuthKeys:
"""Regenerates the authentication key for an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param regenerate_key_parameters: The parameters for regenerating integration runtime
authentication key. Required.
:type regenerate_key_parameters:
~azure.mgmt.datafactory.models.IntegrationRuntimeRegenerateKeyParameters
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeAuthKeys or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeys
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def regenerate_auth_key(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
regenerate_key_parameters: IO,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeAuthKeys:
"""Regenerates the authentication key for an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param regenerate_key_parameters: The parameters for regenerating integration runtime
authentication key. Required.
:type regenerate_key_parameters: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeAuthKeys or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeys
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def regenerate_auth_key(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
regenerate_key_parameters: Union[_models.IntegrationRuntimeRegenerateKeyParameters, IO],
**kwargs: Any
) -> _models.IntegrationRuntimeAuthKeys:
"""Regenerates the authentication key for an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param regenerate_key_parameters: The parameters for regenerating integration runtime
authentication key. Is either a model type or a IO type. Required.
:type regenerate_key_parameters:
~azure.mgmt.datafactory.models.IntegrationRuntimeRegenerateKeyParameters or IO
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeAuthKeys or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeys
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
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 = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeAuthKeys]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(regenerate_key_parameters, (IO, bytes)):
_content = regenerate_key_parameters
else:
_json = self._serialize.body(regenerate_key_parameters, "IntegrationRuntimeRegenerateKeyParameters")
request = build_regenerate_auth_key_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.regenerate_auth_key.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeAuthKeys", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
regenerate_auth_key.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey"} # type: ignore
[docs] @distributed_trace
def list_auth_keys(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> _models.IntegrationRuntimeAuthKeys:
"""Retrieves the authentication keys for an integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeAuthKeys or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeAuthKeys
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeAuthKeys]
request = build_list_auth_keys_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.list_auth_keys.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeAuthKeys", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
list_auth_keys.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys"} # type: ignore
def _start_initial(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> Optional[_models.IntegrationRuntimeStatusResponse]:
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.IntegrationRuntimeStatusResponse]]
request = build_start_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self._start_initial.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
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("IntegrationRuntimeStatusResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
_start_initial.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start"} # type: ignore
[docs] @distributed_trace
def begin_start(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> LROPoller[_models.IntegrationRuntimeStatusResponse]:
"""Starts a ManagedReserved type integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either IntegrationRuntimeStatusResponse or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeStatusResponse]
polling = kwargs.pop("polling", True) # type: Union[bool, PollingMethod]
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token = kwargs.pop("continuation_token", None) # type: Optional[str]
if cont_token is None:
raw_result = self._start_initial( # type: ignore
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("IntegrationRuntimeStatusResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
if polling is True:
polling_method = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) # type: PollingMethod
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller.from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller(self._client, raw_result, get_long_running_output, polling_method)
begin_start.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start"} # type: ignore
def _stop_initial( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> None:
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
request = build_stop_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self._stop_initial.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request, stream=False, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
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, {})
_stop_initial.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop"} # type: ignore
[docs] @distributed_trace
def begin_stop(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> LROPoller[None]:
"""Stops a ManagedReserved type integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.LROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
polling = kwargs.pop("polling", True) # type: Union[bool, PollingMethod]
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token = kwargs.pop("continuation_token", None) # type: Optional[str]
if cont_token is None:
raw_result = self._stop_initial( # type: ignore
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements
if cls:
return cls(pipeline_response, None, {})
if polling is True:
polling_method = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) # type: PollingMethod
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller.from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller(self._client, raw_result, get_long_running_output, polling_method)
begin_stop.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop"} # type: ignore
[docs] @distributed_trace
def sync_credentials( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> None:
"""Force the integration runtime to synchronize credentials across integration runtime nodes, and
this will override the credentials across all worker nodes with those available on the
dispatcher node. If you already have the latest credential backup file, you should manually
import it (preferred) on any self-hosted integration runtime node than using this API directly.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
request = build_sync_credentials_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.sync_credentials.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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)
if cls:
return cls(pipeline_response, None, {})
sync_credentials.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials"} # type: ignore
[docs] @distributed_trace
def get_monitoring_data(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> _models.IntegrationRuntimeMonitoringData:
"""Get the integration runtime monitoring data, which includes the monitor data for all the nodes
under this integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeMonitoringData or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeMonitoringData
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeMonitoringData]
request = build_get_monitoring_data_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.get_monitoring_data.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeMonitoringData", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get_monitoring_data.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"} # type: ignore
[docs] @distributed_trace
def upgrade( # pylint: disable=inconsistent-return-statements
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> None:
"""Upgrade self-hosted integration runtime to latest version if availability.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[None]
request = build_upgrade_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.upgrade.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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)
if cls:
return cls(pipeline_response, None, {})
upgrade.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade"} # type: ignore
@overload
def remove_links( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
linked_integration_runtime_request: _models.LinkedIntegrationRuntimeRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> None:
"""Remove all linked integration runtimes under specific data factory in a self-hosted integration
runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param linked_integration_runtime_request: The data factory name for the linked integration
runtime. Required.
:type linked_integration_runtime_request:
~azure.mgmt.datafactory.models.LinkedIntegrationRuntimeRequest
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def remove_links( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
linked_integration_runtime_request: IO,
*,
content_type: str = "application/json",
**kwargs: Any
) -> None:
"""Remove all linked integration runtimes under specific data factory in a self-hosted integration
runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param linked_integration_runtime_request: The data factory name for the linked integration
runtime. Required.
:type linked_integration_runtime_request: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def remove_links( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
linked_integration_runtime_request: Union[_models.LinkedIntegrationRuntimeRequest, IO],
**kwargs: Any
) -> None:
"""Remove all linked integration runtimes under specific data factory in a self-hosted integration
runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param linked_integration_runtime_request: The data factory name for the linked integration
runtime. Is either a model type or a IO type. Required.
:type linked_integration_runtime_request:
~azure.mgmt.datafactory.models.LinkedIntegrationRuntimeRequest or IO
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
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 = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[None]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(linked_integration_runtime_request, (IO, bytes)):
_content = linked_integration_runtime_request
else:
_json = self._serialize.body(linked_integration_runtime_request, "LinkedIntegrationRuntimeRequest")
request = build_remove_links_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.remove_links.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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)
if cls:
return cls(pipeline_response, None, {})
remove_links.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks"} # type: ignore
@overload
def create_linked_integration_runtime(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
create_linked_integration_runtime_request: _models.CreateLinkedIntegrationRuntimeRequest,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeStatusResponse:
"""Create a linked integration runtime entry in a shared integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param create_linked_integration_runtime_request: The linked integration runtime properties.
Required.
:type create_linked_integration_runtime_request:
~azure.mgmt.datafactory.models.CreateLinkedIntegrationRuntimeRequest
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeStatusResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def create_linked_integration_runtime(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
create_linked_integration_runtime_request: IO,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.IntegrationRuntimeStatusResponse:
"""Create a linked integration runtime entry in a shared integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param create_linked_integration_runtime_request: The linked integration runtime properties.
Required.
:type create_linked_integration_runtime_request: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeStatusResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def create_linked_integration_runtime(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
create_linked_integration_runtime_request: Union[_models.CreateLinkedIntegrationRuntimeRequest, IO],
**kwargs: Any
) -> _models.IntegrationRuntimeStatusResponse:
"""Create a linked integration runtime entry in a shared integration runtime.
: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 integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param create_linked_integration_runtime_request: The linked integration runtime properties. Is
either a model type or a IO type. Required.
:type create_linked_integration_runtime_request:
~azure.mgmt.datafactory.models.CreateLinkedIntegrationRuntimeRequest or IO
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: IntegrationRuntimeStatusResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.IntegrationRuntimeStatusResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
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 = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.IntegrationRuntimeStatusResponse]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(create_linked_integration_runtime_request, (IO, bytes)):
_content = create_linked_integration_runtime_request
else:
_json = self._serialize.body(
create_linked_integration_runtime_request, "CreateLinkedIntegrationRuntimeRequest"
)
request = build_create_linked_integration_runtime_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.create_linked_integration_runtime.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
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("IntegrationRuntimeStatusResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
create_linked_integration_runtime.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime"} # type: ignore