AzuredatafactoryClient
Classes
dataclass
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
class-attribute
instance-attribute
run_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'runId'})
Identifier of a run
class-attribute
instance-attribute
pipeline_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pipelineName'})
The pipeline name
class-attribute
instance-attribute
The full of partial list of parameter name, value pair used in the pipeline run.
class-attribute
instance-attribute
invoked_by: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'invokedBy'})
Entity that started the pipeline.
class-attribute
instance-attribute
run_start: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'runStart'})
The start time of a pipeline run in ISO8601 format.
class-attribute
instance-attribute
run_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'runEnd'})
The end time of a pipeline run in ISO8601 format.
class-attribute
instance-attribute
duration_in_ms: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'durationInMs'})
The duration of a pipeline run in milliseconds.
class-attribute
instance-attribute
The status of the pipeline run.
class-attribute
instance-attribute
The message from a pipeline run.
dataclass
SubscriptionListResult(*, value: Optional[List[Subscription | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
dataclass
ResourceGroupListResult(*, value: Optional[List[ResourceGroup | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
dataclass
DataFactoryListResult(*, value: Optional[List[DataFactory | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
dataclass
PipelineListResult(*, value: Optional[List[Pipeline | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
Response for List pipelines
Attributes
class-attribute
instance-attribute
The list of Data Factories.
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
class-attribute
instance-attribute
The resource name.
class-attribute
instance-attribute
The resource tags.
class-attribute
instance-attribute
Data Factory additional properties.
class-attribute
instance-attribute
Managed service identity of the factory.
class-attribute
instance-attribute
The resource identitfier.
class-attribute
instance-attribute
The resource type.
dataclass
Pipeline(*, id: Optional[str] = None, name: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, etag: Optional[str] = None)
Definition: Pipeline
Attributes
class-attribute
instance-attribute
The resource identifier.
class-attribute
instance-attribute
The resource name of the pipeline.
class-attribute
instance-attribute
The pipeline properties.
dataclass
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
class-attribute
instance-attribute
name
class-attribute
instance-attribute
type
class-attribute
instance-attribute
inputs
class-attribute
instance-attribute
outputs
dataclass
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 | Mapping[str, Any]] = None, authorization_source: Optional[str] = None)
Definition: Subscription
Attributes
class-attribute
instance-attribute
The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.
class-attribute
instance-attribute
subscription_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subscriptionId'})
The subscription Id.
class-attribute
instance-attribute
tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})
The tenant Id.
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
The subscription display name.
class-attribute
instance-attribute
The subscription state.
class-attribute
instance-attribute
authorization_source: Optional[str] = dataclass_field(default=None, kw_only=True, 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'.
dataclass
SubscriptionPolicies(*, location_placement_id: Optional[str] = None, quota_id: Optional[str] = None, spending_limit: Optional[str] = None)
Definition: SubscriptionPolicies
Attributes
class-attribute
instance-attribute
location_placement_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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.
dataclass
ResourceGroup(location: str, *, id: Optional[str] = None, name: Optional[str] = None, managed_by: Optional[str] = None, tags: Optional[Dict[str, str]] = None, properties: Optional[ResourceGroupProperties | Mapping[str, Any]] = None)
Definition: ResourceGroup
Attributes
class-attribute
instance-attribute
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).
class-attribute
instance-attribute
The Name of the resource group.
instance-attribute
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.
dataclass
AzuredatafactoryClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
create_pipeline_run(input: ParameterValueSpecification | Mapping[str, Any], subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_name: str, *, reference_pipeline_run_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a pipeline run
This operation creates a new pipeline run in your factory
Swagger operation ID: CreatePipelineRun.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ParameterValueSpecification | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
subscription_id
|
str
|
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
required |
resource_group_name
|
str
|
Resource group name. |
required |
data_factory_name
|
str
|
The name of the Data Factory. |
required |
pipeline_name
|
str
|
The name of the Data Factory pipeline. |
required |
reference_pipeline_run_id
|
Optional[str]
|
The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
cancel_pipeline_run(subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_run_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Cancel a pipeline run
This operation cancels a pipeline run by its run ID.
Swagger operation ID: CancelPipelineRun.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subscription_id
|
str
|
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
required |
resource_group_name
|
str
|
Resource group name. |
required |
data_factory_name
|
str
|
The name of the Data Factory. |
required |
pipeline_run_name
|
str
|
The id of the Data Factory pipeline run. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_pipeline_run(subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_run_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a pipeline run
Get a particular pipeline run execution
Swagger operation ID: GetPipelineRun.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subscription_id
|
str
|
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
required |
resource_group_name
|
str
|
Resource group name. |
required |
data_factory_name
|
str
|
The name of the Data Factory. |
required |
pipeline_run_name
|
str
|
The id of the Data Factory pipeline run. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_subscriptions(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List subscriptions
Gets a list of all the subscriptions to which the principal has access.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListSubscriptions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_resource_groups(subscription_id: str, *, filter: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List resource groups
Lists all the resource groups within the subscription. The results are paginated at 1,000+ records.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListResourceGroups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subscription_id
|
str
|
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
required |
filter
|
Optional[str]
|
The filter to apply on the operation. |
None
|
top
|
Optional[int]
|
Query parameters. If nothing is passed returns all values. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_data_factories(subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Factories
Get the list of Data Factories
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListDataFactories.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subscription_id
|
str
|
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
required |
resource_group_name
|
str
|
Resource group name. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_pipelines(subscription_id: str, resource_group_name: str, data_factory_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List pipelines
List the list of pipelines from a particular factory
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListPipelines.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subscription_id
|
str
|
The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource. |
required |
resource_group_name
|
str
|
Resource group name. |
required |
data_factory_name
|
str
|
The name of the Data Factory. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |