IntegrationRuntimesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:integration_runtimes> attribute.
- Inheritance
-
builtins.objectIntegrationRuntimesOperations
Constructor
IntegrationRuntimesOperations(*args, **kwargs)Methods
| begin_start |
Starts a ManagedReserved type integration runtime. |
| begin_stop |
Stops a ManagedReserved type integration runtime. |
| create_linked_integration_runtime |
Create a linked integration runtime entry in a shared integration runtime. |
| create_or_update |
Creates or updates an integration runtime. |
| delete |
Deletes an integration runtime. |
| get |
Gets an integration runtime. |
| get_connection_info |
Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials. |
| get_monitoring_data |
Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime. |
| get_status |
Gets detailed status information for an integration runtime. |
| list_auth_keys |
Retrieves the authentication keys for an integration runtime. |
| list_by_factory |
Lists integration runtimes. |
| list_outbound_network_dependencies_endpoints |
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime. |
| regenerate_auth_key |
Regenerates the authentication key for an integration runtime. |
| remove_links |
Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime. |
| sync_credentials |
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. |
| update |
Updates an integration runtime. |
| upgrade |
Upgrade self-hosted integration runtime to latest version if availability. |
begin_start
Starts a ManagedReserved type integration runtime.
async begin_start(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeStatusResponse]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either IntegrationRuntimeStatusResponse or the result of cls(response)
Return type
Exceptions
begin_stop
Stops a ManagedReserved type integration runtime.
async begin_stop(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
create_linked_integration_runtime
Create a linked integration runtime entry in a shared integration runtime.
async create_linked_integration_runtime(resource_group_name: str, factory_name: str, integration_runtime_name: str, create_linked_integration_runtime_request: azure.mgmt.datafactory.models._models_py3.CreateLinkedIntegrationRuntimeRequest, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeStatusResponseParameters
- create_linked_integration_runtime_request
- CreateLinkedIntegrationRuntimeRequest
The linked integration runtime properties.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeStatusResponse, or the result of cls(response)
Return type
Exceptions
create_or_update
Creates or updates an integration runtime.
async create_or_update(resource_group_name: str, factory_name: str, integration_runtime_name: str, integration_runtime: azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeResource, if_match: Optional[str] = None, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeResourceParameters
- if_match
- str
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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeResource, or the result of cls(response)
Return type
Exceptions
delete
Deletes an integration runtime.
async delete(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
Gets an integration runtime.
async get(resource_group_name: str, factory_name: str, integration_runtime_name: str, if_none_match: Optional[str] = None, **kwargs: Any) -> Optional[azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeResource]Parameters
- if_none_match
- str
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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeResource, or the result of cls(response)
Return type
Exceptions
get_connection_info
Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
async get_connection_info(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeConnectionInfoParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeConnectionInfo, or the result of cls(response)
Return type
Exceptions
get_monitoring_data
Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
async get_monitoring_data(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeMonitoringDataParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeMonitoringData, or the result of cls(response)
Return type
Exceptions
get_status
Gets detailed status information for an integration runtime.
async get_status(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeStatusResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeStatusResponse, or the result of cls(response)
Return type
Exceptions
list_auth_keys
Retrieves the authentication keys for an integration runtime.
async list_auth_keys(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeAuthKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeAuthKeys, or the result of cls(response)
Return type
Exceptions
list_by_factory
Lists integration runtimes.
list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeListResponse]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either IntegrationRuntimeListResponse or the result of cls(response)
Return type
Exceptions
list_outbound_network_dependencies_endpoints
Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
async list_outbound_network_dependencies_endpoints(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse, or the result of cls(response)
Return type
Exceptions
regenerate_auth_key
Regenerates the authentication key for an integration runtime.
async regenerate_auth_key(resource_group_name: str, factory_name: str, integration_runtime_name: str, regenerate_key_parameters: azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeRegenerateKeyParameters, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeAuthKeysParameters
- regenerate_key_parameters
- IntegrationRuntimeRegenerateKeyParameters
The parameters for regenerating integration runtime authentication key.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeAuthKeys, or the result of cls(response)
Return type
Exceptions
remove_links
Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
async remove_links(resource_group_name: str, factory_name: str, integration_runtime_name: str, linked_integration_runtime_request: azure.mgmt.datafactory.models._models_py3.LinkedIntegrationRuntimeRequest, **kwargs: Any) -> NoneParameters
- linked_integration_runtime_request
- LinkedIntegrationRuntimeRequest
The data factory name for the linked integration runtime.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
sync_credentials
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.
async sync_credentials(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
update
Updates an integration runtime.
async update(resource_group_name: str, factory_name: str, integration_runtime_name: str, update_integration_runtime_request: azure.mgmt.datafactory.models._models_py3.UpdateIntegrationRuntimeRequest, **kwargs: Any) -> azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeResourceParameters
- update_integration_runtime_request
- UpdateIntegrationRuntimeRequest
The parameters for updating an integration runtime.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
IntegrationRuntimeResource, or the result of cls(response)
Return type
Exceptions
upgrade
Upgrade self-hosted integration runtime to latest version if availability.
async upgrade(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.datafactory.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>Feedback
Submit and view feedback for