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: _models.RunFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ActivityRunsQueryResponse[source]¶

query_by_pipeline_run(resource_group_name: str, factory_name: str, run_id: str, filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ActivityRunsQueryResponse

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) – Parameters to filter the activity runs. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.DataFlowDebugPackage, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AddDataFlowToDebugSessionResponse[source]¶

add_data_flow(resource_group_name: str, factory_name: str, request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AddDataFlowToDebugSessionResponse

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) – Data flow debug session definition with debug content. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AddDataFlowToDebugSessionResponse or the result of cls(response)

Return type

AddDataFlowToDebugSessionResponse

Raises

HttpResponseError –

begin_create(resource_group_name: str, factory_name: str, request: _models.CreateDataFlowDebugSessionRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CreateDataFlowDebugSessionResponse][source]¶

begin_create(resource_group_name: str, factory_name: str, request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CreateDataFlowDebugSessionResponse]

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) – Data flow debug session definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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: _models.DataFlowDebugCommandRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataFlowDebugCommandResponse][source]¶

begin_execute_command(resource_group_name: str, factory_name: str, request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataFlowDebugCommandResponse]

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) – Data flow debug command definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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: _models.DeleteDataFlowDebugSessionRequest, *, content_type: str = "'application/json'", **kwargs: Any) → None [source]¶

delete(resource_group_name: str, factory_name: str, request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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) – Data flow debug session definition for deletion. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) → Iterable[azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.DataFlowResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataFlowResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, data_flow_name: str, data_flow: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataFlowResource

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) – Data flow resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, data_flow_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.DataFlowResource][source]¶

Lists data flows.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.DatasetResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatasetResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, dataset_name: str, dataset: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatasetResource

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) – Dataset resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, dataset_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.datafactory.models._models_py3.DatasetResource][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.DatasetResource][source]¶

Lists datasets.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.ExposureControlRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExposureControlResponse[source]¶

get_feature_value(location_id: str, exposure_control_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExposureControlResponse

Get exposure control feature for specific location.

Parameters

location_id (str) – The location identifier. Required.
exposure_control_request (ExposureControlRequest or IO) – The exposure control request. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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: _models.ExposureControlRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExposureControlResponse[source]¶

get_feature_value_by_factory(resource_group_name: str, factory_name: str, exposure_control_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExposureControlResponse

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) – The exposure control request. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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: _models.ExposureControlBatchRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExposureControlBatchResponse[source]¶

query_feature_values_by_factory(resource_group_name: str, factory_name: str, exposure_control_batch_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExposureControlBatchResponse

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) – The exposure control request for list of features. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.FactoryRepoUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Factory[source]¶

configure_factory_repo(location_id: str, factory_repo_update: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Factory

Updates a factory’s repo information.

Parameters

location_id (str) – The location identifier. Required.
factory_repo_update (FactoryRepoUpdate or IO) – Update factory repo request definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Factory or the result of cls(response)

Return type

Raises

HttpResponseError –

create_or_update(resource_group_name: str, factory_name: str, factory: _models.Factory, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Factory[source]¶

create_or_update(resource_group_name: str, factory_name: str, factory: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Factory

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) – Factory resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Factory or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.datafactory.models._models_py3.Factory][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: _models.UserAccessPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessPolicyResponse[source]¶

get_data_plane_access(resource_group_name: str, factory_name: str, policy: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessPolicyResponse

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) – Data Plane user access policy definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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: _models.GitHubAccessTokenRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GitHubAccessTokenResponse[source]¶

get_git_hub_access_token(resource_group_name: str, factory_name: str, git_hub_access_token_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GitHubAccessTokenResponse

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) – Get GitHub access token request definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

GitHubAccessTokenResponse or the result of cls(response)

Return type

GitHubAccessTokenResponse

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.datafactory.models._models_py3.Factory][source]¶

Lists factories under the specified subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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[azure.mgmt.datafactory.models._models_py3.Factory][source]¶

Lists factories.

Parameters: resource_group_name (str) – The resource group name. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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: _models.FactoryUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Factory[source]¶

update(resource_group_name: str, factory_name: str, factory_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Factory

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) – The parameters for updating a factory. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Factory or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.9/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: _models.GlobalParameterResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GlobalParameterResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, global_parameter_name: str, default: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GlobalParameterResource

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) – Global parameter resource definition. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, global_parameter_name: str, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.GlobalParameterResource][source]¶

Lists Global parameters.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, node_name: str, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: _models.UpdateIntegrationRuntimeNodeRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SelfHostedIntegrationRuntimeNode[source]¶

update(resource_group_name: str, factory_name: str, integration_runtime_name: str, node_name: str, update_integration_runtime_node_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SelfHostedIntegrationRuntimeNode

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) – The parameters for updating an integration runtime node. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.9/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) → azure.core.polling._poller.LROPoller[azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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: Optional[_models.GetSsisObjectMetadataRequest] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SsisObjectMetadataListResponse[source]¶

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, get_metadata_request: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SsisObjectMetadataListResponse

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) – The parameters for getting a SSIS object metadata. Is either a model type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.9/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) → azure.core.polling._poller.LROPoller[azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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: _models.CreateLinkedIntegrationRuntimeRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeStatusResponse[source]¶

create_linked_integration_runtime(resource_group_name: str, factory_name: str, integration_runtime_name: str, create_linked_integration_runtime_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeStatusResponse

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

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) – The linked integration runtime properties. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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: _models.IntegrationRuntimeResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, integration_runtime_name: str, integration_runtime: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeResource

Creates or updates an integration runtime.

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) – Integration runtime resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

IntegrationRuntimeResource or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, integration_runtime_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeResource][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.IntegrationRuntimeResource][source]¶

Lists integration runtimes.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: _models.IntegrationRuntimeRegenerateKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeAuthKeys[source]¶

regenerate_auth_key(resource_group_name: str, factory_name: str, integration_runtime_name: str, regenerate_key_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeAuthKeys

Regenerates the authentication key for an integration runtime.

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) – The parameters for regenerating integration runtime authentication key. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

IntegrationRuntimeAuthKeys or the result of cls(response)

Return type

IntegrationRuntimeAuthKeys

Raises

HttpResponseError –

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 [source]¶

remove_links(resource_group_name: str, factory_name: str, integration_runtime_name: str, linked_integration_runtime_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

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) – The data factory name for the linked integration runtime. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

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[source]¶

update(resource_group_name: str, factory_name: str, integration_runtime_name: str, update_integration_runtime_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IntegrationRuntimeResource

Updates an integration runtime.

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) – The parameters for updating an integration runtime. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

IntegrationRuntimeResource or the result of cls(response)

Return type

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.9/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: _models.LinkedServiceResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkedServiceResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, linked_service_name: str, linked_service: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkedServiceResource

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) – Linked service resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, linked_service_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.datafactory.models._models_py3.LinkedServiceResource][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.LinkedServiceResource][source]¶

Lists linked services.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.ManagedPrivateEndpointResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedPrivateEndpointResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_private_endpoint_name: str, managed_private_endpoint: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedPrivateEndpointResource

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) – Managed private endpoint resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_private_endpoint_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.ManagedVirtualNetworkResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedVirtualNetworkResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, managed_virtual_network_name: str, managed_virtual_network: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedVirtualNetworkResource

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) – Managed Virtual Network resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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: Optional[str] = None, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.ManagedVirtualNetworkResource][source]¶

Lists managed Virtual Networks.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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[azure.mgmt.datafactory.models._models_py3.Operation][source]¶

Lists the available Azure Data Factory API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.9/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: Optional[bool] = 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, run_id: str, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PipelineRun or the result of cls(response)

Return type

Raises

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: _models.RunFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PipelineRunsQueryResponse[source]¶

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PipelineRunsQueryResponse

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) – Parameters to filter the pipeline run. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.PipelineResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PipelineResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, pipeline_name: str, pipeline: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PipelineResource

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) – Pipeline resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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: Optional[str] = None, is_recovery: Optional[bool] = None, start_activity_name: Optional[str] = None, start_from_failure: Optional[bool] = None, parameters: Optional[Dict[str, JSON]] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CreateRunResponse[source]¶

create_run(resource_group_name: str, factory_name: str, pipeline_name: str, reference_pipeline_run_id: Optional[str] = None, is_recovery: Optional[bool] = None, start_activity_name: Optional[str] = None, start_from_failure: Optional[bool] = None, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CreateRunResponse

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) – Parameters of the pipeline run. These parameters will be used only if the runId is not specified. Is either a dict type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, pipeline_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.datafactory.models._models_py3.PipelineResource][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.PipelineResource][source]¶

Lists pipelines.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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[azure.mgmt.datafactory.models._models_py3.PrivateEndpointConnectionResource][source]¶

Lists Private endpoint connections.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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: _models.PrivateLinkConnectionApprovalRequestResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnectionResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, private_endpoint_connection_name: str, private_endpoint_wrapper: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PrivateEndpointConnectionResource

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) – Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, private_endpoint_connection_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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) → azure.mgmt.datafactory.models._models_py3.PrivateLinkResourcesWrapper[source]¶

Gets the private link resources.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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.9/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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: _models.RunFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerRunsQueryResponse[source]¶

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerRunsQueryResponse

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) – Parameters to filter the pipeline run. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.datafactory.models' from '/mnt/vss/_work/1/s/sdk/datafactory/azure-mgmt-datafactory/.tox/sphinx/lib/python3.9/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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.LROPoller[azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) → azure.core.polling._poller.LROPoller[azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

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: _models.TriggerResource, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerResource[source]¶

create_or_update(resource_group_name: str, factory_name: str, trigger_name: str, trigger: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerResource

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) – Trigger resource definition. Is either a model type or a IO 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.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, factory_name: str, trigger_name: str, if_none_match: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.datafactory.models._models_py3.TriggerResource][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.datafactory.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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[azure.mgmt.datafactory.models._models_py3.TriggerResource][source]¶

Lists triggers.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: _models.TriggerFilterParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerQueryResponse[source]¶

query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TriggerQueryResponse

Query triggers.

Parameters

resource_group_name (str) – The resource group name. Required.
factory_name (str) – The factory name. Required.
filter_parameters (TriggerFilterParameters or IO) – Parameters to filter the triggers. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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.9/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶