azure.mgmt.datafactory.operations module

class azure.mgmt.datafactory.operations.ActivityRunsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s activity_runs attribute.

query_by_pipeline_run(resource_group_name: str, factory_name: str, run_id: str, filter_parameters: RunFilterParameters | IO[bytes], **kwargs: Any) → ActivityRunsQueryResponse[source]

Query activity runs based on input filter conditions.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • run_id (str) – The pipeline run identifier. Required.

  • filter_parameters (RunFilterParameters or IO[bytes]) – Parameters to filter the activity runs. Is either a RunFilterParameters type or a IO[bytes] type. Required.

Returns:

ActivityRunsQueryResponse or the result of cls(response)

Return type:

ActivityRunsQueryResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.ChangeDataCaptureOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s change_data_capture attribute.

create_or_update(resource_group_name: str, factory_name: str, change_data_capture_name: str, change_data_capture: ChangeDataCaptureResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → ChangeDataCaptureResource[source]

Creates or updates a change data capture resource.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • change_data_capture_name (str) – The change data capture name. Required.

  • change_data_capture (ChangeDataCaptureResource or IO[bytes]) – Change data capture resource definition. Is either a ChangeDataCaptureResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

ChangeDataCaptureResource or the result of cls(response)

Return type:

ChangeDataCaptureResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) → None[source]

Deletes a change data capture.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • change_data_capture_name (str) – The change data capture name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, change_data_capture_name: str, if_none_match: str | None = None, **kwargs: Any) → ChangeDataCaptureResource[source]

Gets a change data capture.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • change_data_capture_name (str) – The change data capture name. Required.

  • if_none_match (str) – ETag of the change data capture 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.

Returns:

ChangeDataCaptureResource or the result of cls(response)

Return type:

ChangeDataCaptureResource

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[ChangeDataCaptureResource][source]

Lists all resources of type change data capture.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either ChangeDataCaptureResource or the result of cls(response)

Return type:

ItemPaged[ChangeDataCaptureResource]

Raises:

HttpResponseError –

start(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) → None[source]

Starts a change data capture.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • change_data_capture_name (str) – The change data capture name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

status(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) → str[source]

Gets the current status for the change data capture resource.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • change_data_capture_name (str) – The change data capture name. Required.

Returns:

str or the result of cls(response)

Return type:

str

Raises:

HttpResponseError –

stop(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) → None[source]

Stops a change data capture.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • change_data_capture_name (str) – The change data capture name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.CredentialOperationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s credential_operations attribute.

create_or_update(resource_group_name: str, factory_name: str, credential_name: str, credential: CredentialResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → CredentialResource[source]

Creates or updates a credential.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • credential_name (str) – Credential name. Required.

  • credential (CredentialResource or IO[bytes]) – Credential resource definition. Is either a CredentialResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

CredentialResource or the result of cls(response)

Return type:

CredentialResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, credential_name: str, **kwargs: Any) → None[source]

Deletes a credential.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • credential_name (str) – Credential name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, credential_name: str, if_none_match: str | None = None, **kwargs: Any) → CredentialResource | None[source]

Gets a credential.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • credential_name (str) – Credential name. Required.

  • if_none_match (str) – ETag of the credential 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.

Returns:

CredentialResource or None or the result of cls(response)

Return type:

CredentialResource or None

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[CredentialResource][source]

List credentials.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either CredentialResource or the result of cls(response)

Return type:

ItemPaged[CredentialResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.DataFlowDebugSessionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s data_flow_debug_session attribute.

add_data_flow(resource_group_name: str, factory_name: str, request: DataFlowDebugPackage | IO[bytes], **kwargs: Any) → AddDataFlowToDebugSessionResponse[source]

Add a data flow into debug session.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • request (DataFlowDebugPackage or IO[bytes]) – Data flow debug session definition with debug content. Is either a DataFlowDebugPackage type or a IO[bytes] type. Required.

Returns:

AddDataFlowToDebugSessionResponse or the result of cls(response)

Return type:

AddDataFlowToDebugSessionResponse

Raises:

HttpResponseError –

begin_create(resource_group_name: str, factory_name: str, request: CreateDataFlowDebugSessionRequest | IO[bytes], **kwargs: Any) → LROPoller[CreateDataFlowDebugSessionResponse][source]

Creates a data flow debug session.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • request (CreateDataFlowDebugSessionRequest or IO[bytes]) – Data flow debug session definition. Is either a CreateDataFlowDebugSessionRequest type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either CreateDataFlowDebugSessionResponse or the result of cls(response)

Return type:

LROPoller[CreateDataFlowDebugSessionResponse]

Raises:

HttpResponseError –

begin_execute_command(resource_group_name: str, factory_name: str, request: DataFlowDebugCommandRequest | IO[bytes], **kwargs: Any) → LROPoller[DataFlowDebugCommandResponse][source]

Execute a data flow debug command.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • request (DataFlowDebugCommandRequest or IO[bytes]) – Data flow debug command definition. Is either a DataFlowDebugCommandRequest type or a IO[bytes] type. Required.

Returns:

An instance of LROPoller that returns either DataFlowDebugCommandResponse or the result of cls(response)

Return type:

LROPoller[DataFlowDebugCommandResponse]

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, request: DeleteDataFlowDebugSessionRequest | IO[bytes], **kwargs: Any) → None[source]

Deletes a data flow debug session.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • request (DeleteDataFlowDebugSessionRequest or IO[bytes]) – Data flow debug session definition for deletion. Is either a DeleteDataFlowDebugSessionRequest type or a IO[bytes] type. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[DataFlowDebugSessionInfo][source]

Query all active data flow debug sessions.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either DataFlowDebugSessionInfo or the result of cls(response)

Return type:

ItemPaged[DataFlowDebugSessionInfo]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.DataFlowsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s data_flows attribute.

create_or_update(resource_group_name: str, factory_name: str, data_flow_name: str, data_flow: DataFlowResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → DataFlowResource[source]

Creates or updates a data flow.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • data_flow_name (str) – The data flow name. Required.

  • data_flow (DataFlowResource or IO[bytes]) – Data flow resource definition. Is either a DataFlowResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

DataFlowResource or the result of cls(response)

Return type:

DataFlowResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, data_flow_name: str, **kwargs: Any) → None[source]

Deletes a data flow.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • data_flow_name (str) – The data flow name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, data_flow_name: str, if_none_match: str | None = None, **kwargs: Any) → DataFlowResource[source]

Gets a data flow.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • data_flow_name (str) – The data flow name. Required.

  • if_none_match (str) – ETag of the data flow 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.

Returns:

DataFlowResource or the result of cls(response)

Return type:

DataFlowResource

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[DataFlowResource][source]

Lists data flows.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either DataFlowResource or the result of cls(response)

Return type:

ItemPaged[DataFlowResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.DatasetsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s datasets attribute.

create_or_update(resource_group_name: str, factory_name: str, dataset_name: str, dataset: DatasetResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → DatasetResource[source]

Creates or updates a dataset.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • dataset_name (str) – The dataset name. Required.

  • dataset (DatasetResource or IO[bytes]) – Dataset resource definition. Is either a DatasetResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

DatasetResource or the result of cls(response)

Return type:

DatasetResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, dataset_name: str, **kwargs: Any) → None[source]

Deletes a dataset.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • dataset_name (str) – The dataset name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, dataset_name: str, if_none_match: str | None = None, **kwargs: Any) → DatasetResource | None[source]

Gets a dataset.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • dataset_name (str) – The dataset name. Required.

  • if_none_match (str) – ETag of the dataset 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.

Returns:

DatasetResource or None or the result of cls(response)

Return type:

DatasetResource or None

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[DatasetResource][source]

Lists datasets.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either DatasetResource or the result of cls(response)

Return type:

ItemPaged[DatasetResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.ExposureControlOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s exposure_control attribute.

get_feature_value(location_id: str, exposure_control_request: ExposureControlRequest | IO[bytes], **kwargs: Any) → ExposureControlResponse[source]

Get exposure control feature for specific location.

Parameters:

  • location_id (str) – The location identifier. Required.

  • exposure_control_request (ExposureControlRequest or IO[bytes]) – The exposure control request. Is either a ExposureControlRequest type or a IO[bytes] type. Required.

Returns:

ExposureControlResponse or the result of cls(response)

Return type:

ExposureControlResponse

Raises:

HttpResponseError –

get_feature_value_by_factory(resource_group_name: str, factory_name: str, exposure_control_request: ExposureControlRequest | IO[bytes], **kwargs: Any) → ExposureControlResponse[source]

Get exposure control feature for specific factory.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • exposure_control_request (ExposureControlRequest or IO[bytes]) – The exposure control request. Is either a ExposureControlRequest type or a IO[bytes] type. Required.

Returns:

ExposureControlResponse or the result of cls(response)

Return type:

ExposureControlResponse

Raises:

HttpResponseError –

query_feature_values_by_factory(resource_group_name: str, factory_name: str, exposure_control_batch_request: ExposureControlBatchRequest | IO[bytes], **kwargs: Any) → ExposureControlBatchResponse[source]

Get list of exposure control features for specific factory.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • exposure_control_batch_request (ExposureControlBatchRequest or IO[bytes]) – The exposure control request for list of features. Is either a ExposureControlBatchRequest type or a IO[bytes] type. Required.

Returns:

ExposureControlBatchResponse or the result of cls(response)

Return type:

ExposureControlBatchResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.FactoriesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s factories attribute.

configure_factory_repo(location_id: str, factory_repo_update: FactoryRepoUpdate | IO[bytes], **kwargs: Any) → Factory[source]

Updates a factory’s repo information.

Parameters:

  • location_id (str) – The location identifier. Required.

  • factory_repo_update (FactoryRepoUpdate or IO[bytes]) – Update factory repo request definition. Is either a FactoryRepoUpdate type or a IO[bytes] type. Required.

Returns:

Factory or the result of cls(response)

Return type:

Factory

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, factory_name: str, factory: Factory | IO[bytes], if_match: str | None = None, **kwargs: Any) → Factory[source]

Creates or updates a factory.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • factory (Factory or IO[bytes]) – Factory resource definition. Is either a Factory type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

Factory or the result of cls(response)

Return type:

Factory

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, **kwargs: Any) → None[source]

Deletes a factory.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, if_none_match: str | None = None, **kwargs: Any) → Factory | None[source]

Gets a factory.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • if_none_match (str) – ETag of the factory 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.

Returns:

Factory or None or the result of cls(response)

Return type:

Factory or None

Raises:

HttpResponseError –

get_data_plane_access(resource_group_name: str, factory_name: str, policy: UserAccessPolicy | IO[bytes], **kwargs: Any) → AccessPolicyResponse[source]

Get Data Plane access.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • policy (UserAccessPolicy or IO[bytes]) – Data Plane user access policy definition. Is either a UserAccessPolicy type or a IO[bytes] type. Required.

Returns:

AccessPolicyResponse or the result of cls(response)

Return type:

AccessPolicyResponse

Raises:

HttpResponseError –

get_git_hub_access_token(resource_group_name: str, factory_name: str, git_hub_access_token_request: GitHubAccessTokenRequest | IO[bytes], **kwargs: Any) → GitHubAccessTokenResponse[source]

Get GitHub Access Token.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • git_hub_access_token_request (GitHubAccessTokenRequest or IO[bytes]) – Get GitHub access token request definition. Is either a GitHubAccessTokenRequest type or a IO[bytes] type. Required.

Returns:

GitHubAccessTokenResponse or the result of cls(response)

Return type:

GitHubAccessTokenResponse

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[Factory][source]

Lists factories under the specified subscription.

Returns:

An iterator like instance of either Factory or the result of cls(response)

Return type:

ItemPaged[Factory]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[Factory][source]

Lists factories.

Parameters:

resource_group_name (str) – The resource group name. Required.

Returns:

An iterator like instance of either Factory or the result of cls(response)

Return type:

ItemPaged[Factory]

Raises:

HttpResponseError –

update(resource_group_name: str, factory_name: str, factory_update_parameters: FactoryUpdateParameters | IO[bytes], **kwargs: Any) → Factory[source]

Updates a factory.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • factory_update_parameters (FactoryUpdateParameters or IO[bytes]) – The parameters for updating a factory. Is either a FactoryUpdateParameters type or a IO[bytes] type. Required.

Returns:

Factory or the result of cls(response)

Return type:

Factory

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.GlobalParametersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s global_parameters attribute.

create_or_update(resource_group_name: str, factory_name: str, global_parameter_name: str, default: GlobalParameterResource | IO[bytes], **kwargs: Any) → GlobalParameterResource[source]

Creates or updates a Global parameter.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • global_parameter_name (str) – The global parameter name. Required.

  • default (GlobalParameterResource or IO[bytes]) – Global parameter resource definition. Is either a GlobalParameterResource type or a IO[bytes] type. Required.

Returns:

GlobalParameterResource or the result of cls(response)

Return type:

GlobalParameterResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, global_parameter_name: str, **kwargs: Any) → None[source]

Deletes a Global parameter.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • global_parameter_name (str) – The global parameter name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, global_parameter_name: str, **kwargs: Any) → GlobalParameterResource[source]

Gets a Global parameter.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • global_parameter_name (str) – The global parameter name. Required.

Returns:

GlobalParameterResource or the result of cls(response)

Return type:

GlobalParameterResource

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[GlobalParameterResource][source]

Lists Global parameters.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either GlobalParameterResource or the result of cls(response)

Return type:

ItemPaged[GlobalParameterResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.IntegrationRuntimeNodesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s integration_runtime_nodes attribute.

delete(resource_group_name: str, factory_name: str, integration_runtime_name: str, node_name: str, **kwargs: Any) → None[source]

Deletes a self-hosted integration runtime node.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • node_name (str) – The integration runtime node name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, node_name: str, **kwargs: Any) → SelfHostedIntegrationRuntimeNode[source]

Gets a self-hosted integration runtime node.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • node_name (str) – The integration runtime node name. Required.

Returns:

SelfHostedIntegrationRuntimeNode or the result of cls(response)

Return type:

SelfHostedIntegrationRuntimeNode

Raises:

HttpResponseError –

get_ip_address(resource_group_name: str, factory_name: str, integration_runtime_name: str, node_name: str, **kwargs: Any) → IntegrationRuntimeNodeIpAddress[source]

Get the IP address of self-hosted integration runtime node.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • node_name (str) – The integration runtime node name. Required.

Returns:

IntegrationRuntimeNodeIpAddress or the result of cls(response)

Return type:

IntegrationRuntimeNodeIpAddress

Raises:

HttpResponseError –

update(resource_group_name: str, factory_name: str, integration_runtime_name: str, node_name: str, update_integration_runtime_node_request: UpdateIntegrationRuntimeNodeRequest | IO[bytes], **kwargs: Any) → SelfHostedIntegrationRuntimeNode[source]

Updates a self-hosted integration runtime node.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • node_name (str) – The integration runtime node name. Required.

  • update_integration_runtime_node_request (UpdateIntegrationRuntimeNodeRequest or IO[bytes]) – The parameters for updating an integration runtime node. Is either a UpdateIntegrationRuntimeNodeRequest type or a IO[bytes] type. Required.

Returns:

SelfHostedIntegrationRuntimeNode or the result of cls(response)

Return type:

SelfHostedIntegrationRuntimeNode

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.IntegrationRuntimeObjectMetadataOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s integration_runtime_object_metadata attribute.

begin_refresh(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → LROPoller[SsisObjectMetadataStatusResponse][source]

Refresh a SSIS integration runtime object metadata.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

An instance of LROPoller that returns either SsisObjectMetadataStatusResponse or the result of cls(response)

Return type:

LROPoller[SsisObjectMetadataStatusResponse]

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, get_metadata_request: GetSsisObjectMetadataRequest | IO[bytes] | None = None, **kwargs: Any) → SsisObjectMetadataListResponse[source]

Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • get_metadata_request (GetSsisObjectMetadataRequest or IO[bytes]) – The parameters for getting a SSIS object metadata. Is either a GetSsisObjectMetadataRequest type or a IO[bytes] type. Default value is None.

Returns:

SsisObjectMetadataListResponse or the result of cls(response)

Return type:

SsisObjectMetadataListResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.IntegrationRuntimesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s integration_runtimes attribute.

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

Starts a ManagedReserved type integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

An instance of LROPoller that returns either IntegrationRuntimeStatusResponse or the result of cls(response)

Return type:

LROPoller[IntegrationRuntimeStatusResponse]

Raises:

HttpResponseError –

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

Stops a ManagedReserved type integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_linked_integration_runtime(resource_group_name: str, factory_name: str, integration_runtime_name: str, create_linked_integration_runtime_request: CreateLinkedIntegrationRuntimeRequest | IO[bytes], **kwargs: Any) → IntegrationRuntimeStatusResponse[source]

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

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • create_linked_integration_runtime_request (CreateLinkedIntegrationRuntimeRequest or IO[bytes]) – The linked integration runtime properties. Is either a CreateLinkedIntegrationRuntimeRequest type or a IO[bytes] type. Required.

Returns:

IntegrationRuntimeStatusResponse or the result of cls(response)

Return type:

IntegrationRuntimeStatusResponse

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, factory_name: str, integration_runtime_name: str, integration_runtime: IntegrationRuntimeResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → IntegrationRuntimeResource[source]

Creates or updates an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • integration_runtime (IntegrationRuntimeResource or IO[bytes]) – Integration runtime resource definition. Is either a IntegrationRuntimeResource type or a IO[bytes] type. Required.

  • 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.

Returns:

IntegrationRuntimeResource or the result of cls(response)

Return type:

IntegrationRuntimeResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → None[source]

Deletes an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, if_none_match: str | None = None, **kwargs: Any) → IntegrationRuntimeResource | None[source]

Gets an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • 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.

Returns:

IntegrationRuntimeResource or None or the result of cls(response)

Return type:

IntegrationRuntimeResource or None

Raises:

HttpResponseError –

get_connection_info(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → IntegrationRuntimeConnectionInfo[source]

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

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

IntegrationRuntimeConnectionInfo or the result of cls(response)

Return type:

IntegrationRuntimeConnectionInfo

Raises:

HttpResponseError –

get_monitoring_data(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → IntegrationRuntimeMonitoringData[source]

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

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

IntegrationRuntimeMonitoringData or the result of cls(response)

Return type:

IntegrationRuntimeMonitoringData

Raises:

HttpResponseError –

get_status(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → IntegrationRuntimeStatusResponse[source]

Gets detailed status information for an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

IntegrationRuntimeStatusResponse or the result of cls(response)

Return type:

IntegrationRuntimeStatusResponse

Raises:

HttpResponseError –

list_auth_keys(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → IntegrationRuntimeAuthKeys[source]

Retrieves the authentication keys for an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

IntegrationRuntimeAuthKeys or the result of cls(response)

Return type:

IntegrationRuntimeAuthKeys

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[IntegrationRuntimeResource][source]

Lists integration runtimes.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either IntegrationRuntimeResource or the result of cls(response)

Return type:

ItemPaged[IntegrationRuntimeResource]

Raises:

HttpResponseError –

list_outbound_network_dependencies_endpoints(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse[source]

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

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse or the result of cls(response)

Return type:

IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse

Raises:

HttpResponseError –

regenerate_auth_key(resource_group_name: str, factory_name: str, integration_runtime_name: str, regenerate_key_parameters: IntegrationRuntimeRegenerateKeyParameters | IO[bytes], **kwargs: Any) → IntegrationRuntimeAuthKeys[source]

Regenerates the authentication key for an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • regenerate_key_parameters (IntegrationRuntimeRegenerateKeyParameters or IO[bytes]) – The parameters for regenerating integration runtime authentication key. Is either a IntegrationRuntimeRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns:

IntegrationRuntimeAuthKeys or the result of cls(response)

Return type:

IntegrationRuntimeAuthKeys

Raises:

HttpResponseError –

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

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • linked_integration_runtime_request (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:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

sync_credentials(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → None[source]

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.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

update(resource_group_name: str, factory_name: str, integration_runtime_name: str, update_integration_runtime_request: UpdateIntegrationRuntimeRequest | IO[bytes], **kwargs: Any) → IntegrationRuntimeResource[source]

Updates an integration runtime.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

  • update_integration_runtime_request (UpdateIntegrationRuntimeRequest or IO[bytes]) – The parameters for updating an integration runtime. Is either a UpdateIntegrationRuntimeRequest type or a IO[bytes] type. Required.

Returns:

IntegrationRuntimeResource or the result of cls(response)

Return type:

IntegrationRuntimeResource

Raises:

HttpResponseError –

upgrade(resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any) → None[source]

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

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • integration_runtime_name (str) – The integration runtime name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.LinkedServicesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s linked_services attribute.

create_or_update(resource_group_name: str, factory_name: str, linked_service_name: str, linked_service: LinkedServiceResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → LinkedServiceResource[source]

Creates or updates a linked service.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • linked_service_name (str) – The linked service name. Required.

  • linked_service (LinkedServiceResource or IO[bytes]) – Linked service resource definition. Is either a LinkedServiceResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

LinkedServiceResource or the result of cls(response)

Return type:

LinkedServiceResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, linked_service_name: str, **kwargs: Any) → None[source]

Deletes a linked service.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • linked_service_name (str) – The linked service name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, linked_service_name: str, if_none_match: str | None = None, **kwargs: Any) → LinkedServiceResource | None[source]

Gets a linked service.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • linked_service_name (str) – The linked service name. Required.

  • if_none_match (str) – ETag of the linked service 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.

Returns:

LinkedServiceResource or None or the result of cls(response)

Return type:

LinkedServiceResource or None

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[LinkedServiceResource][source]

Lists linked services.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either LinkedServiceResource or the result of cls(response)

Return type:

ItemPaged[LinkedServiceResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.ManagedPrivateEndpointsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s managed_private_endpoints attribute.

create_or_update(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_private_endpoint_name: str, managed_private_endpoint: ManagedPrivateEndpointResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → ManagedPrivateEndpointResource[source]

Creates or updates a managed private endpoint.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • managed_virtual_network_name (str) – Managed virtual network name. Required.

  • managed_private_endpoint_name (str) – Managed private endpoint name. Required.

  • managed_private_endpoint (ManagedPrivateEndpointResource or IO[bytes]) – Managed private endpoint resource definition. Is either a ManagedPrivateEndpointResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

ManagedPrivateEndpointResource or the result of cls(response)

Return type:

ManagedPrivateEndpointResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_private_endpoint_name: str, **kwargs: Any) → None[source]

Deletes a managed private endpoint.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • managed_virtual_network_name (str) – Managed virtual network name. Required.

  • managed_private_endpoint_name (str) – Managed private endpoint name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_private_endpoint_name: str, if_none_match: str | None = None, **kwargs: Any) → ManagedPrivateEndpointResource[source]

Gets a managed private endpoint.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • managed_virtual_network_name (str) – Managed virtual network name. Required.

  • managed_private_endpoint_name (str) – Managed private endpoint name. Required.

  • if_none_match (str) – ETag of the managed private endpoint 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.

Returns:

ManagedPrivateEndpointResource or the result of cls(response)

Return type:

ManagedPrivateEndpointResource

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, **kwargs: Any) → Iterable[ManagedPrivateEndpointResource][source]

Lists managed private endpoints.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • managed_virtual_network_name (str) – Managed virtual network name. Required.

Returns:

An iterator like instance of either ManagedPrivateEndpointResource or the result of cls(response)

Return type:

ItemPaged[ManagedPrivateEndpointResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.ManagedVirtualNetworksOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s managed_virtual_networks attribute.

create_or_update(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_virtual_network: ManagedVirtualNetworkResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → ManagedVirtualNetworkResource[source]

Creates or updates a managed Virtual Network.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • managed_virtual_network_name (str) – Managed virtual network name. Required.

  • managed_virtual_network (ManagedVirtualNetworkResource or IO[bytes]) – Managed Virtual Network resource definition. Is either a ManagedVirtualNetworkResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the managed Virtual Network entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

ManagedVirtualNetworkResource or the result of cls(response)

Return type:

ManagedVirtualNetworkResource

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, if_none_match: str | None = None, **kwargs: Any) → ManagedVirtualNetworkResource[source]

Gets a managed Virtual Network.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • managed_virtual_network_name (str) – Managed virtual network name. Required.

  • if_none_match (str) – ETag of the managed Virtual Network 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.

Returns:

ManagedVirtualNetworkResource or the result of cls(response)

Return type:

ManagedVirtualNetworkResource

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[ManagedVirtualNetworkResource][source]

Lists managed Virtual Networks.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either ManagedVirtualNetworkResource or the result of cls(response)

Return type:

ItemPaged[ManagedVirtualNetworkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[Operation][source]

Lists the available Azure Data Factory API operations.

Returns:

An iterator like instance of either Operation or the result of cls(response)

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.PipelineRunsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s pipeline_runs attribute.

cancel(resource_group_name: str, factory_name: str, run_id: str, is_recursive: bool | None = None, **kwargs: Any) → None[source]

Cancel a pipeline run by its run ID.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • run_id (str) – The pipeline run identifier. Required.

  • is_recursive (bool) – If true, cancel all the Child pipelines that are triggered by the current pipeline. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, run_id: str, **kwargs: Any) → PipelineRun[source]

Get a pipeline run by its run ID.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • run_id (str) – The pipeline run identifier. Required.

Returns:

PipelineRun or the result of cls(response)

Return type:

PipelineRun

Raises:

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: RunFilterParameters | IO[bytes], **kwargs: Any) → PipelineRunsQueryResponse[source]

Query pipeline runs in the factory based on input filter conditions.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • filter_parameters (RunFilterParameters or IO[bytes]) – Parameters to filter the pipeline run. Is either a RunFilterParameters type or a IO[bytes] type. Required.

Returns:

PipelineRunsQueryResponse or the result of cls(response)

Return type:

PipelineRunsQueryResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.PipelinesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s pipelines attribute.

create_or_update(resource_group_name: str, factory_name: str, pipeline_name: str, pipeline: PipelineResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → PipelineResource[source]

Creates or updates a pipeline.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • pipeline_name (str) – The pipeline name. Required.

  • pipeline (PipelineResource or IO[bytes]) – Pipeline resource definition. Is either a PipelineResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

PipelineResource or the result of cls(response)

Return type:

PipelineResource

Raises:

HttpResponseError –

create_run(resource_group_name: str, factory_name: str, pipeline_name: str, reference_pipeline_run_id: str | None = None, is_recovery: bool | None = None, start_activity_name: str | None = None, start_from_failure: bool | None = None, parameters: Dict[str, MutableMapping[str, Any]] | IO[bytes] | None = None, **kwargs: Any) → CreateRunResponse[source]

Creates a run of a pipeline.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • pipeline_name (str) – The pipeline name. Required.

  • reference_pipeline_run_id (str) – The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. Default value is None.

  • is_recovery (bool) – Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. Default value is None.

  • start_activity_name (str) – In recovery mode, the rerun will start from this activity. If not specified, all activities will run. Default value is None.

  • start_from_failure (bool) – In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified. Default value is None.

  • parameters (dict[str, JSON] or IO[bytes]) – Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Is either a {str: JSON} type or a IO[bytes] type. Default value is None.

Returns:

CreateRunResponse or the result of cls(response)

Return type:

CreateRunResponse

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, pipeline_name: str, **kwargs: Any) → None[source]

Deletes a pipeline.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • pipeline_name (str) – The pipeline name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, pipeline_name: str, if_none_match: str | None = None, **kwargs: Any) → PipelineResource | None[source]

Gets a pipeline.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • pipeline_name (str) – The pipeline name. Required.

  • if_none_match (str) – ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

Returns:

PipelineResource or None or the result of cls(response)

Return type:

PipelineResource or None

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[PipelineResource][source]

Lists pipelines.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either PipelineResource or the result of cls(response)

Return type:

ItemPaged[PipelineResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.PrivateEndPointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s private_end_point_connections attribute.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnectionResource][source]

Lists Private endpoint connections.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either PrivateEndpointConnectionResource or the result of cls(response)

Return type:

ItemPaged[PrivateEndpointConnectionResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.PrivateEndpointConnectionOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s private_endpoint_connection attribute.

create_or_update(resource_group_name: str, factory_name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: PrivateLinkConnectionApprovalRequestResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → PrivateEndpointConnectionResource[source]

Approves or rejects a private endpoint connection.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • private_endpoint_connection_name (str) – The private endpoint connection name. Required.

  • private_endpoint_wrapper (PrivateLinkConnectionApprovalRequestResource or IO[bytes]) – Is either a PrivateLinkConnectionApprovalRequestResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the private endpoint connection entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

PrivateEndpointConnectionResource or the result of cls(response)

Return type:

PrivateEndpointConnectionResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, private_endpoint_connection_name: str, **kwargs: Any) → None[source]

Deletes a private endpoint connection.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • private_endpoint_connection_name (str) – The private endpoint connection name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, private_endpoint_connection_name: str, if_none_match: str | None = None, **kwargs: Any) → PrivateEndpointConnectionResource[source]

Gets a private endpoint connection.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • private_endpoint_connection_name (str) – The private endpoint connection name. Required.

  • if_none_match (str) – ETag of the private endpoint connection 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.

Returns:

PrivateEndpointConnectionResource or the result of cls(response)

Return type:

PrivateEndpointConnectionResource

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s private_link_resources attribute.

get(resource_group_name: str, factory_name: str, **kwargs: Any) → PrivateLinkResourcesWrapper[source]

Gets the private link resources.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

PrivateLinkResourcesWrapper or the result of cls(response)

Return type:

PrivateLinkResourcesWrapper

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.TriggerRunsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s trigger_runs attribute.

cancel(resource_group_name: str, factory_name: str, trigger_name: str, run_id: str, **kwargs: Any) → None[source]

Cancel a single trigger instance by runId.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

  • run_id (str) – The pipeline run identifier. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: RunFilterParameters | IO[bytes], **kwargs: Any) → TriggerRunsQueryResponse[source]

Query trigger runs.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • filter_parameters (RunFilterParameters or IO[bytes]) – Parameters to filter the pipeline run. Is either a RunFilterParameters type or a IO[bytes] type. Required.

Returns:

TriggerRunsQueryResponse or the result of cls(response)

Return type:

TriggerRunsQueryResponse

Raises:

HttpResponseError –

rerun(resource_group_name: str, factory_name: str, trigger_name: str, run_id: str, **kwargs: Any) → None[source]

Rerun single trigger instance by runId.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

  • run_id (str) – The pipeline run identifier. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>
class azure.mgmt.datafactory.operations.TriggersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DataFactoryManagementClient’s triggers attribute.

begin_start(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) → LROPoller[None][source]

Starts a trigger.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_stop(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) → LROPoller[None][source]

Stops a trigger.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_subscribe_to_events(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) → LROPoller[TriggerSubscriptionOperationStatus][source]

Subscribe event trigger to events.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

Returns:

An instance of LROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type:

LROPoller[TriggerSubscriptionOperationStatus]

Raises:

HttpResponseError –

begin_unsubscribe_from_events(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) → LROPoller[TriggerSubscriptionOperationStatus][source]

Unsubscribe event trigger from events.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

Returns:

An instance of LROPoller that returns either TriggerSubscriptionOperationStatus or the result of cls(response)

Return type:

LROPoller[TriggerSubscriptionOperationStatus]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, factory_name: str, trigger_name: str, trigger: TriggerResource | IO[bytes], if_match: str | None = None, **kwargs: Any) → TriggerResource[source]

Creates or updates a trigger.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

  • trigger (TriggerResource or IO[bytes]) – Trigger resource definition. Is either a TriggerResource type or a IO[bytes] type. Required.

  • if_match (str) – ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns:

TriggerResource or the result of cls(response)

Return type:

TriggerResource

Raises:

HttpResponseError –

delete(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) → None[source]

Deletes a trigger.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, factory_name: str, trigger_name: str, if_none_match: str | None = None, **kwargs: Any) → TriggerResource | None[source]

Gets a trigger.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

  • if_none_match (str) – ETag of the trigger 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.

Returns:

TriggerResource or None or the result of cls(response)

Return type:

TriggerResource or None

Raises:

HttpResponseError –

get_event_subscription_status(resource_group_name: str, factory_name: str, trigger_name: str, **kwargs: Any) → TriggerSubscriptionOperationStatus[source]

Get a trigger’s event subscription status.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • trigger_name (str) – The trigger name. Required.

Returns:

TriggerSubscriptionOperationStatus or the result of cls(response)

Return type:

TriggerSubscriptionOperationStatus

Raises:

HttpResponseError –

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[TriggerResource][source]

Lists triggers.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

Returns:

An iterator like instance of either TriggerResource or the result of cls(response)

Return type:

ItemPaged[TriggerResource]

Raises:

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: TriggerFilterParameters | IO[bytes], **kwargs: Any) → TriggerQueryResponse[source]

Query triggers.

Parameters:

  • resource_group_name (str) – The resource group name. Required.

  • factory_name (str) – The factory name. Required.

  • filter_parameters (TriggerFilterParameters or IO[bytes]) – Parameters to filter the triggers. Is either a TriggerFilterParameters type or a IO[bytes] type. Required.

Returns:

TriggerQueryResponse or the result of cls(response)

Return type:

TriggerQueryResponse

Raises:

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/datafactory/models/__init__.py'>