AzuredatafactoryClient

Classes

CreatePipelineRunResponse dataclass

CreatePipelineRunResponse(run_id: Optional[str] = None)

Response for Create a pipeline run

Attributes

run_id class-attribute instance-attribute

run_id: Optional[str] = field(default=None, metadata={'wire_name': 'runId'})

runId

PipelineRun dataclass

PipelineRun(run_id: Optional[str] = None, pipeline_name: Optional[str] = None, parameters: Optional[Dict[str, Any]] = None, invoked_by: Optional[Dict[str, Any]] = None, run_start: Optional[str] = None, run_end: Optional[str] = None, duration_in_ms: Optional[int] = None, status: Optional[str] = None, message: Optional[str] = None, last_updated: Optional[str] = None, annotations: Optional[List[str]] = None)

Response for Get a pipeline run

Attributes

run_id class-attribute instance-attribute

run_id: Optional[str] = field(default=None, metadata={'wire_name': 'runId'})

Identifier of a run

pipeline_name class-attribute instance-attribute

pipeline_name: Optional[str] = field(default=None, metadata={'wire_name': 'pipelineName'})

The pipeline name

parameters class-attribute instance-attribute

parameters: Optional[Dict[str, Any]] = None

The full of partial list of parameter name, value pair used in the pipeline run.

invoked_by class-attribute instance-attribute

invoked_by: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'invokedBy'})

Entity that started the pipeline.

run_start class-attribute instance-attribute

run_start: Optional[str] = field(default=None, metadata={'wire_name': 'runStart'})

The start time of a pipeline run in ISO8601 format.

run_end class-attribute instance-attribute

run_end: Optional[str] = field(default=None, metadata={'wire_name': 'runEnd'})

The end time of a pipeline run in ISO8601 format.

duration_in_ms class-attribute instance-attribute

duration_in_ms: Optional[int] = field(default=None, metadata={'wire_name': 'durationInMs'})

The duration of a pipeline run in milliseconds.

status class-attribute instance-attribute

status: Optional[str] = None

The status of the pipeline run.

message class-attribute instance-attribute

message: Optional[str] = None

The message from a pipeline run.

last_updated class-attribute instance-attribute

last_updated: Optional[str] = field(default=None, metadata={'wire_name': 'lastUpdated'})

The last updated timestamp for the pipeline run event in ISO8601 format.

annotations class-attribute instance-attribute

annotations: Optional[List[str]] = None

The annotations for the pipeline run.

SubscriptionListResult dataclass

SubscriptionListResult(value: Optional[List[Subscription]] = None, next_link: Optional[str] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute

value: Optional[List[Subscription]] = None

The subscriptions.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ResourceGroupListResult dataclass

ResourceGroupListResult(value: Optional[List[ResourceGroup]] = None, next_link: Optional[str] = None)

Response for List resource groups

Attributes

value class-attribute instance-attribute

value: Optional[List[ResourceGroup]] = None

The list of resource groups.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

DataFactoryListResult dataclass

DataFactoryListResult(value: Optional[List[DataFactory]] = None, next_link: Optional[str] = None)

Response for List Factories

Attributes

value class-attribute instance-attribute

value: Optional[List[DataFactory]] = None

The list of Data Factories.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

PipelineListResult dataclass

PipelineListResult(value: Optional[List[Pipeline]] = None, next_link: Optional[str] = None)

Response for List pipelines

Attributes

value class-attribute instance-attribute

value: Optional[List[Pipeline]] = None

The list of Data Factories.

next_link class-attribute instance-attribute

next_link: Optional[str] = field(default=None, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

DataFactory dataclass

DataFactory(name: Optional[str] = None, tags: Optional[Dict[str, Any]] = None, properties: Optional[Dict[str, Any]] = None, identity: Optional[Dict[str, Any]] = None, id: Optional[str] = None, type_: Optional[str] = None, location: Optional[str] = None)

Definition: DataFactory

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

The resource name.

tags class-attribute instance-attribute

tags: Optional[Dict[str, Any]] = None

The resource tags.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

Data Factory additional properties.

identity class-attribute instance-attribute

identity: Optional[Dict[str, Any]] = None

Managed service identity of the factory.

id class-attribute instance-attribute

id: Optional[str] = None

The resource identitfier.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The resource type.

location class-attribute instance-attribute

location: Optional[str] = None

The resource location

Pipeline dataclass

Pipeline(id: Optional[str] = None, name: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, etag: Optional[str] = None)

Definition: Pipeline

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The resource identifier.

name class-attribute instance-attribute

name: Optional[str] = None

The resource name of the pipeline.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = None

The pipeline properties.

etag class-attribute instance-attribute

etag: Optional[str] = None

Etag identifies change in the resource.

Activity dataclass

Activity(additional_properties: Dict[str, Any] = dict())

Definition: Activity

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ActivityFull dataclass

ActivityFull(name: Optional[str] = None, type_: Optional[str] = None, inputs: Optional[List[Dict[str, Any]]] = None, outputs: Optional[List[Dict[str, Any]]] = None, type_properties: Optional[Dict[str, Any]] = None, policy: Optional[Dict[str, Any]] = None)

Definition: Activity-Full

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

name

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

type

inputs class-attribute instance-attribute

inputs: Optional[List[Dict[str, Any]]] = None

inputs

outputs class-attribute instance-attribute

outputs: Optional[List[Dict[str, Any]]] = None

outputs

type_properties class-attribute instance-attribute

type_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'typeProperties'})

typeProperties

policy class-attribute instance-attribute

policy: Optional[Dict[str, Any]] = None

policy

ParameterValueSpecification dataclass

ParameterValueSpecification(additional_properties: Dict[str, Any] = dict())

Definition: ParameterValueSpecification

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Subscription dataclass

Subscription(id: Optional[str] = None, subscription_id: Optional[str] = None, tenant_id: Optional[str] = None, display_name: Optional[str] = None, state: Optional[str] = None, subscription_policies: Optional[SubscriptionPolicies] = None, authorization_source: Optional[str] = None)

Definition: Subscription

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.

subscription_id class-attribute instance-attribute

subscription_id: Optional[str] = field(default=None, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = field(default=None, metadata={'wire_name': 'tenantId'})

The tenant Id.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The subscription display name.

state class-attribute instance-attribute

state: Optional[str] = None

The subscription state.

authorization_source class-attribute instance-attribute

authorization_source: Optional[str] = field(default=None, metadata={'wire_name': 'authorizationSource'})

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

SubscriptionPolicies dataclass

SubscriptionPolicies(location_placement_id: Optional[str] = None, quota_id: Optional[str] = None, spending_limit: Optional[str] = None)

Definition: SubscriptionPolicies

Attributes

location_placement_id class-attribute instance-attribute

location_placement_id: Optional[str] = field(default=None, metadata={'wire_name': 'locationPlacementId'})

The subscription location placement Id. The Id indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions.

quota_id class-attribute instance-attribute

quota_id: Optional[str] = field(default=None, metadata={'wire_name': 'quotaId'})

The subscription quota Id.

spending_limit class-attribute instance-attribute

spending_limit: Optional[str] = field(default=None, metadata={'wire_name': 'spendingLimit'})

The subscription spending limit.

ResourceGroup dataclass

ResourceGroup(id: Optional[str] = None, name: Optional[str] = None, location: Optional[str] = None, managed_by: Optional[str] = None, tags: Optional[Dict[str, Any]] = None, properties: Optional[ResourceGroupProperties] = None)

Definition: ResourceGroup

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).

name class-attribute instance-attribute

name: Optional[str] = None

The Name of the resource group.

location class-attribute instance-attribute

location: Optional[str] = None

The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc.

managed_by class-attribute instance-attribute

managed_by: Optional[str] = field(default=None, metadata={'wire_name': 'managedBy'})

Id of the resource that manages this resource group.

tags class-attribute instance-attribute

tags: Optional[Dict[str, Any]] = None

The tags attached to the resource group.

ResourceGroupProperties dataclass

ResourceGroupProperties(provisioning_state: Optional[str] = None)

Definition: ResourceGroupProperties

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = field(default=None, metadata={'wire_name': 'provisioningState'})

The provisioning state.

AzuredatafactoryClient

AzuredatafactoryClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for azuredatafactory connector.

Initialize a AzuredatafactoryClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

create_pipeline_run_async async

create_pipeline_run_async(input: ParameterValueSpecification, subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_name: str, reference_pipeline_run_id: Optional[str] = None) -> dict[str, Any] | None

Create a pipeline run

This operation creates a new pipeline run in your factory

cancel_pipeline_run_async async

cancel_pipeline_run_async(subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_run_name: str) -> None

Cancel a pipeline run

This operation cancels a pipeline run by its run ID.

get_pipeline_run_async async

get_pipeline_run_async(subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_run_name: str) -> dict[str, Any] | None

Get a pipeline run

Get a particular pipeline run execution

list_subscriptions_async async

list_subscriptions_async() -> dict[str, Any] | None

List subscriptions

Gets a list of all the subscriptions to which the principal has access.

list_resource_groups_async async

list_resource_groups_async(subscription_id: str, filter: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List resource groups

Lists all the resource groups within the subscription. The results are paginated at 1,000+ records.

list_data_factories_async async

list_data_factories_async(subscription_id: str, resource_group_name: str) -> dict[str, Any] | None

List Factories

Get the list of Data Factories

list_pipelines_async async

list_pipelines_async(subscription_id: str, resource_group_name: str, data_factory_name: str) -> dict[str, Any] | None

List pipelines

List the list of pipelines from a particular factory