Dataflows are a self-service, cloud-based, data preparation technology that allows you to ingest, transform and load data into Common Data Service environments, Power BI workspaces or your organization's Azure Data Lake Gen2 account.
Status: Preview |
Tier: Premium |
Version: v1 |
Name |
Summary |
When a dataflow refresh completes |
Name |
Summary |
|
|
|
|
|
|
|
Summary:
Description: Get workspaces or environments
Syntax:
PowerQueryDataflows.ListGroupsForRefreshDataflow (string workspaceType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceType |
string (Group Type)Values: [Workspace, Environment] |
Select workspace or environment |
True |
Returns:
Type:Groups
Summary:
Description: Get workspaces or environments
Syntax:
PowerQueryDataflows.ListGroupsForOnRefreshComplete (string workspaceType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceType |
string (Group Type)Values: [Workspace, Environment] |
Select workspace or environment |
True |
Returns:
Type:Groups
Summary:
Description: Get dataflows
Syntax:
PowerQueryDataflows.ListDataflowsForRefreshDataflow (string workspaceType, string groupIdForRefreshDataflow)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceType |
string (Group Type)Values: [Workspace, Environment] |
Select workspace or environment |
True |
|
groupIdForRefreshDataflow |
string (Group) |
The unique identifier of the workspace or environment |
True |
Returns:
Type:Dataflows
Summary:
Description: Get dataflows
Syntax:
PowerQueryDataflows.ListDataflowsForOnRefreshComplete (string workspaceType, string groupIdForOnRefreshComplete)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceType |
string (Group Type)Values: [Workspace, Environment] |
Select workspace or environment |
True |
|
groupIdForOnRefreshComplete |
string (Group) |
The unique identifier of the workspace or environment |
True |
Returns:
Type:Dataflows
Summary: Refresh a dataflow
Description: Initiate a dataflow refresh operation.
Syntax:
PowerQueryDataflows.RefreshDataflow (string workspaceType, string groupIdForRefreshDataflow, string dataflowIdForRefreshDataflow)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceType |
string (Group Type)Values: [Workspace, Environment] |
Select workspace or environment |
True |
|
groupIdForRefreshDataflow |
string (Group) |
The unique identifier of the workspace or environment |
True |
|
dataflowIdForRefreshDataflow |
string (Dataflow) |
The unique identifier of the dataflow |
True |
Returns:
Type:DataflowModel
Description: The dataflow being refreshed
Summary: When a dataflow refresh completes
Description: This operation triggers when a dataflow refresh completes.
Syntax:
PowerQueryDataflows.OnRefreshComplete (string workspaceType, string groupIdForOnRefreshComplete, string dataflowIdForOnRefreshComplete)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceType |
string (Group Type)Values: [Workspace, Environment] |
Select workspace or environment |
True |
|
groupIdForOnRefreshComplete |
string (Group) |
The unique identifier of the workspace or environment |
True |
|
dataflowIdForOnRefreshComplete |
string (Dataflow) |
The unique identifier of the dataflow |
True |
Returns:
Type:RefreshModel
Description: An individual dataflow refresh
Summary:
Description: The dataflow being refreshed
Properties:
Name |
Type |
Summary |
dataflowName |
string Dataflow Name |
Name of the dataflow |
dataflowId |
string Dataflow Id |
Id of the dataflow |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Dataflows ID |
The unique identifier of the dataflow |
name |
string Dataflows name |
The display name of the dataflow |
description |
string description |
The discription of the dataflow |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Group ID |
The unique identifier of the group the dataflow was created in. A group can either be a workspace or environment. |
name |
string Group name |
The display name of the group |
Summary:
Description: An individual dataflow refresh
Properties:
Name |
Type |
Summary |
dataflowId |
string Dataflow Id |
Id of the dataflow |
dataflowName |
string Dataflow Name |
Name of the dataflow |
refreshType |
string Refresh Type |
Type of the dataflow refresh |
startTime |
string Start Time |
Start time of the dataflow refresh |
endTime |
string End Time |
Completion time of the dataflow refresh |
status |
string Refresh Status |
Status of the dataflow refresh. Possible values are: 'Success', 'Failed', 'Cancelled' |