IntegrationRuntimesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:integration_runtimes> attribute.

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.

begin_start(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> LROPoller[IntegrationRuntimeStatusResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
LROPoller[IntegrationRuntimeStatusResponse]	An instance of LROPoller that returns IntegrationRuntimeStatusResponse. The IntegrationRuntimeStatusResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops a ManagedReserved type integration runtime.

begin_stop(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

create_linked_integration_runtime

Create a linked integration runtime entry in a shared integration runtime.

create_linked_integration_runtime(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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.
create_linked_integration_runtime_request Required	CreateLinkedIntegrationRuntimeRequest or CreateLinkedIntegrationRuntimeRequest or IO[bytes] The linked integration runtime properties. Is either a CreateLinkedIntegrationRuntimeRequest type or a IO[bytes] type. Required.

Returns

Type	Description
IntegrationRuntimeStatusResponse	IntegrationRuntimeStatusResponse. The IntegrationRuntimeStatusResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

create_or_update

Creates or updates an integration runtime.

create_or_update(resource_group_name: str, factory_name: str, integration_runtime_name: str, integration_runtime: _models.IntegrationRuntimeResource, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.IntegrationRuntimeResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.
integration_runtime Required	IntegrationRuntimeResource or IntegrationRuntimeResource or IO[bytes] Integration runtime resource definition. Is either a IntegrationRuntimeResource type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
IntegrationRuntimeResource	IntegrationRuntimeResource. The IntegrationRuntimeResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes an integration runtime.

delete(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets an integration runtime.

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> IntegrationRuntimeResource | None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
IntegrationRuntimeResource, None	IntegrationRuntimeResource or None. The IntegrationRuntimeResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_connection_info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

get_connection_info(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> IntegrationRuntimeConnectionInfo

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
IntegrationRuntimeConnectionInfo	IntegrationRuntimeConnectionInfo. The IntegrationRuntimeConnectionInfo is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_monitoring_data

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

get_monitoring_data(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> IntegrationRuntimeMonitoringData

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
IntegrationRuntimeMonitoringData	IntegrationRuntimeMonitoringData. The IntegrationRuntimeMonitoringData is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_status

Gets detailed status information for an integration runtime.

get_status(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> IntegrationRuntimeStatusResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
IntegrationRuntimeStatusResponse	IntegrationRuntimeStatusResponse. The IntegrationRuntimeStatusResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_auth_keys

Retrieves the authentication keys for an integration runtime.

list_auth_keys(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> IntegrationRuntimeAuthKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
IntegrationRuntimeAuthKeys	IntegrationRuntimeAuthKeys. The IntegrationRuntimeAuthKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_factory

Lists integration runtimes.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> ItemPaged[IntegrationRuntimeResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
ItemPaged[IntegrationRuntimeResource]	An iterator like instance of IntegrationRuntimeResource

Exceptions

Type	Description
HttpResponseError

list_outbound_network_dependencies_endpoints

Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

list_outbound_network_dependencies_endpoints(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse	IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse. The IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

regenerate_auth_key

Regenerates the authentication key for an integration runtime.

regenerate_auth_key(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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.
regenerate_key_parameters Required	IntegrationRuntimeRegenerateKeyParameters or IntegrationRuntimeRegenerateKeyParameters or IO[bytes] The parameters for regenerating integration runtime authentication key. Is either a IntegrationRuntimeRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns

Type	Description
IntegrationRuntimeAuthKeys	IntegrationRuntimeAuthKeys. The IntegrationRuntimeAuthKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

remove_links

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

remove_links(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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.
linked_integration_runtime_request Required	LinkedIntegrationRuntimeRequest or LinkedIntegrationRuntimeRequest or IO[bytes] The data factory name for the linked integration runtime. Is either a LinkedIntegrationRuntimeRequest type or a IO[bytes] type. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

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.

sync_credentials(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

update

Updates an integration runtime.

update(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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.
update_integration_runtime_request Required	UpdateIntegrationRuntimeRequest or UpdateIntegrationRuntimeRequest or IO[bytes] The parameters for updating an integration runtime. Is either a UpdateIntegrationRuntimeRequest type or a IO[bytes] type. Required.

Returns

Type	Description
IntegrationRuntimeResource	IntegrationRuntimeResource. The IntegrationRuntimeResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

upgrade

Upgrade self-hosted integration runtime to latest version if availability.

upgrade(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
integration_runtime_name Required	str The integration runtime name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?