ExecuteSSISPackageActivity Class

Reference

Execute SSIS package activity.

All required parameters must be populated in order to send to server.

Constructor

ExecuteSSISPackageActivity(*, name: str, package_location: _models.SSISPackageLocation, connect_via: _models.IntegrationRuntimeReference, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy | None = None, runtime: MutableMapping[str, Any] | None = None, logging_level: MutableMapping[str, Any] | None = None, environment_path: MutableMapping[str, Any] | None = None, execution_credential: _models.SSISExecutionCredential | None = None, project_parameters: Dict[str, _models.SSISExecutionParameter] | None = None, package_parameters: Dict[str, _models.SSISExecutionParameter] | None = None, project_connection_managers: Dict[str, Dict[str, _models.SSISExecutionParameter]] | None = None, package_connection_managers: Dict[str, Dict[str, _models.SSISExecutionParameter]] | None = None, property_overrides: Dict[str, _models.SSISPropertyOverride] | None = None, log_location: _models.SSISLogLocation | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection. Default value: None
name	str Activity name. Required.
description	str Activity description. Default value: None
state	str or ActivityState Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive". Default value: None
on_inactive_mark_as	str or ActivityOnInactiveMarkAs Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped". Default value: None
depends_on	list[ActivityDependency] Activity depends on condition. Default value: None
user_properties	list[UserProperty] Activity user properties. Default value: None
linked_service_name	LinkedServiceReference Linked service reference. Default value: None
policy	ActivityPolicy Activity policy. Default value: None
package_location	SSISPackageLocation SSIS package location. Required.
runtime	<xref:JSON> Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string). Default value: None
logging_level	<xref:JSON> The logging level of SSIS package execution. Type: string (or Expression with resultType string). Default value: None
environment_path	<xref:JSON> The environment path to execute the SSIS package. Type: string (or Expression with resultType string). Default value: None
execution_credential	SSISExecutionCredential The package execution credential. Default value: None
connect_via	IntegrationRuntimeReference The integration runtime reference. Required.
project_parameters	dict[str, SSISExecutionParameter] The project level parameters to execute the SSIS package. Default value: None
package_parameters	dict[str, SSISExecutionParameter] The package level parameters to execute the SSIS package. Default value: None
project_connection_managers	dict[str, dict[str, SSISExecutionParameter]] The project level connection managers to execute the SSIS package. Default value: None
package_connection_managers	dict[str, dict[str, SSISExecutionParameter]] The package level connection managers to execute the SSIS package. Default value: None
property_overrides	dict[str, SSISPropertyOverride] The property overrides to execute the SSIS package. Default value: None
log_location	SSISLogLocation SSIS package execution log location. Default value: None

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
name	str Activity name. Required.
type	str Type of activity. Required.
description	str Activity description.
state	str or ActivityState Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".
on_inactive_mark_as	str or ActivityOnInactiveMarkAs Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".
depends_on	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
package_location	SSISPackageLocation SSIS package location. Required.
runtime	<xref:JSON> Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).
logging_level	<xref:JSON> The logging level of SSIS package execution. Type: string (or Expression with resultType string).
environment_path	<xref:JSON> The environment path to execute the SSIS package. Type: string (or Expression with resultType string).
execution_credential	SSISExecutionCredential The package execution credential.
connect_via	IntegrationRuntimeReference The integration runtime reference. Required.
project_parameters	dict[str, SSISExecutionParameter] The project level parameters to execute the SSIS package.
package_parameters	dict[str, SSISExecutionParameter] The package level parameters to execute the SSIS package.
project_connection_managers	dict[str, dict[str, SSISExecutionParameter]] The project level connection managers to execute the SSIS package.
package_connection_managers	dict[str, dict[str, SSISExecutionParameter]] The package level connection managers to execute the SSIS package.
property_overrides	dict[str, SSISPropertyOverride] The property overrides to execute the SSIS package.
log_location	SSISLogLocation SSIS package execution log location.

Share via

ExecuteSSISPackageActivity Class

Constructor

Keyword-Only Parameters

Variables