azure.mgmt.datafactory.operations module¶
-
class
azure.mgmt.datafactory.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists the available Azure Data Factory API operations.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
OperationListResponse or ClientRawResponse if raw=true
- Return type
OperationListResponse or ClientRawResponse
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
class
azure.mgmt.datafactory.operations.
FactoriesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
FactoriesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
cancel_pipeline_run
(resource_group_name, factory_name, run_id, custom_headers=None, raw=False, **operation_config)[source]¶ Cancel a pipeline run by its run ID.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
run_id (str) – The pipeline run identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, factory_name, factory, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a factory.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
factory (Factory) – Factory resource definition.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Factory or ClientRawResponse if raw=true
- Return type
Factory or ClientRawResponse
- Raises
-
delete
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a factory.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a factory.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Factory or ClientRawResponse if raw=true
- Return type
Factory or ClientRawResponse
- Raises
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists factories under the specified subscription.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Factory
- Return type
- Raises
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists factories.
- Parameters
resource_group_name (str) – The resource group name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Factory
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
update
(resource_group_name, factory_name, tags=None, identity=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates a factory.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
tags (dict[str, str]) – The resource tags.
identity (FactoryIdentity) – Managed service identity of the factory.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Factory or ClientRawResponse if raw=true
- Return type
Factory or ClientRawResponse
- Raises
-
class
azure.mgmt.datafactory.operations.
IntegrationRuntimesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IntegrationRuntimesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
create_or_update
(resource_group_name, factory_name, integration_runtime_name, properties, if_match=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
properties (IntegrationRuntime) – Integration runtime properties.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeResource or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeResource or ClientRawResponse
- Raises
-
delete
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeResource or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeResource or ClientRawResponse
- Raises
-
get_connection_info
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[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.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeConnectionInfo or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeConnectionInfo or ClientRawResponse
- Raises
-
get_monitoring_data
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[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.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeMonitoringData or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeMonitoringData or ClientRawResponse
- Raises
-
get_status
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets detailed status information for an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeStatusResponse or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeStatusResponse or ClientRawResponse
- Raises
-
list_auth_keys
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieves the authentication keys for an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeAuthKeys or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeAuthKeys or ClientRawResponse
- Raises
-
list_by_factory
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists integration runtimes.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IntegrationRuntimeResource
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
regenerate_auth_key
(resource_group_name, factory_name, integration_runtime_name, key_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ Regenerates the authentication key for an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
key_name (str or IntegrationRuntimeAuthKeyName) – The name of the authentication key to regenerate. Possible values include: ‘authKey1’, ‘authKey2’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeAuthKeys or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeAuthKeys or ClientRawResponse
- Raises
-
remove_node
(resource_group_name, factory_name, integration_runtime_name, additional_properties=None, node_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ Remove a node from integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
additional_properties (dict[str, object]) – Unmatched properties from the message are deserialized this collection
node_name (str) – The name of the node to be removed.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
start
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Starts a ManagedReserved type integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
- Returns
An instance of AzureOperationPoller that returns IntegrationRuntimeStatusResponse or ClientRawResponse if raw=true
- Return type
AzureOperationPoller[IntegrationRuntimeStatusResponse] or ClientRawResponse
- Raises
-
stop
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Stops a ManagedReserved type integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
- Returns
An instance of AzureOperationPoller that returns None or ClientRawResponse if raw=true
- Return type
AzureOperationPoller[None] or ClientRawResponse
- Raises
-
sync_credentials
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[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.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, factory_name, integration_runtime_name, auto_update=None, update_delay_offset=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an integration runtime.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
auto_update (str or IntegrationRuntimeAutoUpdate) – Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. Possible values include: ‘On’, ‘Off’
update_delay_offset (str) – The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeStatusResponse or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeStatusResponse or ClientRawResponse
- Raises
-
upgrade
(resource_group_name, factory_name, integration_runtime_name, custom_headers=None, raw=False, **operation_config)[source]¶ Upgrade self-hosted integration runtime to latest version if availably.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
class
azure.mgmt.datafactory.operations.
IntegrationRuntimeNodesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IntegrationRuntimeNodesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
delete
(resource_group_name, factory_name, integration_runtime_name, node_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a self-hosted integration runtime node.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
node_name (str) – The integration runtime node name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get_ip_address
(resource_group_name, factory_name, integration_runtime_name, node_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get the IP address of self-hosted integration runtime node.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
node_name (str) – The integration runtime node name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IntegrationRuntimeNodeIpAddress or ClientRawResponse if raw=true
- Return type
IntegrationRuntimeNodeIpAddress or ClientRawResponse
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
update
(resource_group_name, factory_name, integration_runtime_name, node_name, concurrent_jobs_limit=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates a self-hosted integration runtime node.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
integration_runtime_name (str) – The integration runtime name.
node_name (str) – The integration runtime node name.
concurrent_jobs_limit (int) – The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SelfHostedIntegrationRuntimeNode or ClientRawResponse if raw=true
- Return type
SelfHostedIntegrationRuntimeNode or ClientRawResponse
- Raises
-
class
azure.mgmt.datafactory.operations.
LinkedServicesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LinkedServicesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
create_or_update
(resource_group_name, factory_name, linked_service_name, properties, if_match=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a linked service.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
linked_service_name (str) – The linked service name.
properties (LinkedService) – Properties of linked service.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
LinkedServiceResource or ClientRawResponse if raw=true
- Return type
LinkedServiceResource or ClientRawResponse
- Raises
-
delete
(resource_group_name, factory_name, linked_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a linked service.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
linked_service_name (str) – The linked service name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, factory_name, linked_service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a linked service.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
linked_service_name (str) – The linked service name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
LinkedServiceResource or ClientRawResponse if raw=true
- Return type
LinkedServiceResource or ClientRawResponse
- Raises
-
list_by_factory
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists linked services.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of LinkedServiceResource
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
class
azure.mgmt.datafactory.operations.
DatasetsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatasetsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
create_or_update
(resource_group_name, factory_name, dataset_name, properties, if_match=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a dataset.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
dataset_name (str) – The dataset name.
properties (Dataset) – Dataset properties.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatasetResource or ClientRawResponse if raw=true
- Return type
DatasetResource or ClientRawResponse
- Raises
-
delete
(resource_group_name, factory_name, dataset_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a dataset.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
dataset_name (str) – The dataset name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, factory_name, dataset_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a dataset.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
dataset_name (str) – The dataset name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatasetResource or ClientRawResponse if raw=true
- Return type
DatasetResource or ClientRawResponse
- Raises
-
list_by_factory
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists datasets.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DatasetResource
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
class
azure.mgmt.datafactory.operations.
PipelinesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PipelinesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
create_or_update
(resource_group_name, factory_name, pipeline_name, pipeline, if_match=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a pipeline.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
pipeline_name (str) – The pipeline name.
pipeline (PipelineResource) – Pipeline resource definition.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PipelineResource or ClientRawResponse if raw=true
- Return type
PipelineResource or ClientRawResponse
- Raises
-
create_run
(resource_group_name, factory_name, pipeline_name, parameters=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a run of a pipeline.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
pipeline_name (str) – The pipeline name.
parameters (dict[str, object]) – Parameters of the pipeline run.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CreateRunResponse or ClientRawResponse if raw=true
- Return type
CreateRunResponse or ClientRawResponse
- Raises
-
delete
(resource_group_name, factory_name, pipeline_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a pipeline.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
pipeline_name (str) – The pipeline name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, factory_name, pipeline_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a pipeline.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
pipeline_name (str) – The pipeline name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PipelineResource or ClientRawResponse if raw=true
- Return type
PipelineResource or ClientRawResponse
- Raises
-
list_by_factory
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists pipelines.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of PipelineResource
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
class
azure.mgmt.datafactory.operations.
PipelineRunsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PipelineRunsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
get
(resource_group_name, factory_name, run_id, custom_headers=None, raw=False, **operation_config)[source]¶ Get a pipeline run by its run ID.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
run_id (str) – The pipeline run identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PipelineRun or ClientRawResponse if raw=true
- Return type
PipelineRun or ClientRawResponse
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
query_by_factory
(resource_group_name, factory_name, filter_parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Query pipeline runs in the factory based on input filter conditions.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
filter_parameters (PipelineRunFilterParameters) – Parameters to filter the pipeline run.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PipelineRunQueryResponse or ClientRawResponse if raw=true
- Return type
PipelineRunQueryResponse or ClientRawResponse
- Raises
-
class
azure.mgmt.datafactory.operations.
ActivityRunsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ActivityRunsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
list_by_pipeline_run
(resource_group_name, factory_name, run_id, start_time, end_time, status=None, activity_name=None, linked_service_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ List activity runs based on input filter conditions.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
run_id (str) – The pipeline run identifier.
start_time (datetime) – The start time of activity runs in ISO8601 format.
end_time (datetime) – The end time of activity runs in ISO8601 format.
status (str) – The status of the pipeline run.
activity_name (str) – The name of the activity.
linked_service_name (str) – The linked service name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ActivityRun
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
class
azure.mgmt.datafactory.operations.
TriggersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TriggersOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version. Constant value: “2017-09-01-preview”.
-
create_or_update
(resource_group_name, factory_name, trigger_name, properties, if_match=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a trigger.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
trigger_name (str) – The trigger name.
properties (Trigger) – Properties of the trigger.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TriggerResource or ClientRawResponse if raw=true
- Return type
TriggerResource or ClientRawResponse
- Raises
-
delete
(resource_group_name, factory_name, trigger_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a trigger.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
trigger_name (str) – The trigger name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, factory_name, trigger_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a trigger.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
trigger_name (str) – The trigger name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TriggerResource or ClientRawResponse if raw=true
- Return type
TriggerResource or ClientRawResponse
- Raises
-
list_by_factory
(resource_group_name, factory_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists triggers.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TriggerResource
- Return type
- Raises
-
list_runs
(resource_group_name, factory_name, trigger_name, start_time, end_time, custom_headers=None, raw=False, **operation_config)[source]¶ List trigger runs.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
trigger_name (str) – The trigger name.
start_time (datetime) – Start time for trigger runs.
end_time (datetime) – End time for trigger runs.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TriggerRun
- Return type
- Raises
-
models
= <module 'azure.mgmt.datafactory.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/datafactory/models/__init__.py'>¶
-
start
(resource_group_name, factory_name, trigger_name, custom_headers=None, raw=False, **operation_config)[source]¶ Starts a trigger.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
trigger_name (str) – The trigger name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
- Returns
An instance of AzureOperationPoller that returns None or ClientRawResponse if raw=true
- Return type
AzureOperationPoller[None] or ClientRawResponse
- Raises
-
stop
(resource_group_name, factory_name, trigger_name, custom_headers=None, raw=False, **operation_config)[source]¶ Stops a trigger.
- Parameters
resource_group_name (str) – The resource group name.
factory_name (str) – The factory name.
trigger_name (str) – The trigger name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
- Returns
An instance of AzureOperationPoller that returns None or ClientRawResponse if raw=true
- Return type
AzureOperationPoller[None] or ClientRawResponse
- Raises