Unanswered

Transition to List Flows as Admin V2 action from deprecated List Flows as Admin action on the Power Automate Management connector, along with associated APIs

(1) Share

Report

Posted on by Chris Garty Microsoft Employee

Hi community!

What's changing?

The List flows as Admin action on the Power Automate Management connector has been deprecated in favor of the List Flows as Admin (V2) action. The List Flows as Admin (V2) action can list all flows in an environment. The V2 action and its backing API has higher performance, since it returns only the identifying information about the flow. To accomplish this performance increase, the flow definition and some other metadata isn't returned. If the flow definition or additional metadata is needed, then a subsequent call can be made to the Get Flow as Admin action.

The Get-AdminFlow PowerShell cmdlet is also being updated to call the V2 List Flows API instead of the V1 List Flows API. This change will remove support for the CreatedBy filter.

The underlying V1 List Flows API is also being deprecated. The Center of Excellence (CoE) Starter Kit was updated to call the V2 List Flows API instead of the V1 List Flows API and that change was in the May 2023 release.

Why is this change happening?

The V2 API has higher performance, since it returns only the identifying information about the flow. The transition away from the V1 API is being made to minimize future disruptions to customer services.

How do I adjust to the change?

If you don't use the Center of Excellence (CoE) Starter Kit, the List flows as Admin action on the Power Automate Management connector, or the Get-AdminFlow PowerShell cmdlet, then you won't need to make any changes.

Connector actions: To take advantage of the increased performance of the V2 action and move off the V1 action, simply transition to using the List Flows as Admin (V2) action instead.

PowerShell: The Get-AdminFlow PowerShell cmdlet has been updated in version 2.0.165. You can update your copy of the Power Platform PowerShell cmdlets using Update-Module -Name "Microsoft.PowerApps.Administration.PowerShell". You can check your version using Get-Module -Name "Microsoft.PowerApps.Administration.PowerShell".

CoE Starter Kit: Update to the latest release of the CoE Starter Kit.

How do I find connector actions?

If you aren’t sure which flows might be calling the List flows as Admin action, then you can create a flow to list those flows. The List flows as Admin action has an operation ID of “ListFlowsInEnvironment”, so call the List Flows as Admin (V2) action, iterate over those flows calling the Get Flows as Admin action for each, parse JSON on the “actions” result, and then look for a “swaggerOperationId” of “ListFlowsInEnvironment”.

What's the timeline?

Connector design-time: Enforcement of the connector action deprecation at design-time is currently happening, so new flows will need to use the List Flows as Admin (V2) action. The design-time change finished rolling out to production environments 6/15.

Runtime: In August, we'll evaluate migration progress and start enforcing the deprecation at runtime, so that calls to the backing API may begin to fail at runtime. In time this will affect the old PowerShell cmdlet versions, old CoE Starter Kit versions, and calls to the deprecated List flows as Admin action.

What if I miss something?

We'll be watching usage levels of the deprecated List flows as Admin action, and its backing API, and we will reach out to customers that continue to have significant usage by the end of July.

Where can I read more?

You can read the latest guidance in the Administer environments and Power Automate resources documentation.

Who can I contact for more information?

Please ask any questions that you may have here and we'll get you answers. Thanks!

*** Update October 19, 2023 ***

Thanks to community feedback, List Flows as Admin V2 + Get Flow as Admin APIs should now be functionally equivalent to List Flows as Admin V1 API.

List Flows as Admin V2 API is now:

- Working correctly in GCC

- Returning createdBy, createdTime, and lastModifiedTime

Get Flow as Admin API is now:

- Returning flow definition

Module Microsoft.PowerApps.Administration.PowerShell updated

We are going to start failing a small number of calls to the V1 List Flows as Admin API to encourage migration to the V2 API, the V2 action, and the latest PowerShell cmdlets module. For now, the failures will randomly occur on less than 1% of calls to the V1 API.

This is the error that would be returned to calls to the API directly or via the connector:
The List Flows as Admin API is no longer supported. Please use the List Flows as Admin (V2) action
And this is the error message that will be returned from the PowerShell cmdlet:
The List Flows as Admin API used by this PowerShell cmdlet version is no longer supported. Please update to the latest PowerShell cmdlet using Update-Module

This change will roll out as RP/2310.3: Preview ~Oct 17, Canada ~Oct 24, Early regions ~Oct 25, Asia ~Oct 27, Europe ~Oct 31, North America ~Nov 2, GCC ~Nov 6.

If you encounter these error messages, then please take the remediation actions described.

*** Update February 1, 2024 ***

The transition to the V2 API is progressing well and we continue to advance the process of randomly failing calls to the V1 List Flows as Admin API as a reminder to move to the V2 API.

An update to fail 20% of calls is releasing now as RP/2401.4: Preview ~Jan 23, Canada ~Jan 30, Early regions ~Jan 31, Asia ~Feb 2, Europe ~Feb 6, North America ~Feb 8, GCC ~Feb 12.

An update to fail 40% of calls will release out as RP/2402.1: Preview ~Feb 6, Canada ~Feb 13, Early regions ~Feb 14, Asia ~Feb 16, Europe ~Feb 20, North America ~Feb 22, GCC ~Feb 26.

Updates to move the failure rates up are planned for the near future:

- 60%: Canada ~Feb 27, North America ~March 7

- 80%: Canada ~March 12, North America ~March 21

- 100%: Canada ~March 26, North America ~April 4

These dates are subject to change, but can be used as a guide. If you encounter the error messages detailed above, then please take the remediation actions described.

*** Update April 22, 2024 ***

Calls to the List flows as Admin API are now fully deprecated via the Power Automate Management connector or PowerShell. There is some direct use of the API from other clients, so we will begin failing those calls as well to complete full deprecation of the API by July 15th.

Categories:

Using connectors

I have the same question (0)

All responses (68)

Answers (0)

Chris Garty Microsoft Employee on at

Like (1)

Report
Additionally, here is a PowerApps admin module PowerShell script that an admin can run to get a list of flows that are using the deprecated action:

#Find flows using a specific action within all cloud flows in the tenant $startTime = Get-Date #The name for the Power Automate Management connector is shared_flowmanagement $targetConnectorName = "shared_flowmanagement" #The name for the List Flows as Admin action is ListFlowsInEnvironment $targetActionName = "ListFlowsInEnvironment" $myStrings = @() $totalFlowCount = 0 $targetFlowActionCount = 0 $totalFlowActionCount = 0 $environments = Get-AdminPowerAppEnvironment foreach ($environment in $environments) { $environmentName = $environment.EnvironmentName $environmentDisplayName = $environment.DisplayName $flows = Get-AdminFlow -EnvironmentName $environmentName $totalFlowCount = $totalFlowCount + $flows.Count foreach ($flow in $flows) { $flowName = $flow.FlowName #Call Get-AdminFlow again with the FlowName parameter so it retrieves the definitionSummary $detailedFlow = Get-AdminFlow -EnvironmentName $environmentName -FlowName $flowName foreach ($action in $detailedFlow.Internal.properties.definitionSummary.actions) { # Make sure it is a valid action if ($action.swaggerOperationId) { $totalFlowActionCount++ # Check if action name and connector name are a match if (($action.swaggerOperationId -eq $targetActionName) -and ($action.api.name -eq $targetConnectorName)) { $targetFlowActionCount++ $flowDisplayName = $flow.DisplayName $connectorName = $action.api.name $actionName = $action.swaggerOperationId $jsonOutput = @" { "environmentName": "$environmentName", "environmentDisplayName": "$environmentDisplayName", "flowName": "$flowName", "flowDisplayName": "$flowDisplayName", "connectorName": "$connectorName", "actionName": "$actionName" } "@ $myStrings += $jsonOutput } } } } } # Output the captured strings foreach ($string in $myStrings) { Write-Host $string } Write-Host "Target connector was $targetConnectorName and target action was $targetActionName" Write-Host "Target flows actions count: $targetFlowActionCount" Write-Host "Total flows actions count: $totalFlowActionCount" Write-Host "Total cloud flows count: $totalFlowCount" $endTime = Get-Date $duration = $endTime - $startTime Write-Host "Script execution time: $duration"

Was this reply helpful? Yes No
Mx81 860 on at

Like (3)

Report

Did I miss the Message Center News about this?
So I have now to update several flows in just a few weeks?

I'm not happy...

By the way: there are still active templates that using this action. 🙄

Was this reply helpful? Yes No
Chris Garty Microsoft Employee on at

Like (1)

Report

@max81, Hopefully the flows are easy to transition! Message center communication was a little delayed, but just went out. We’ll watch the migration progress to try to ensure the impact is minimal. We will get the templates switched over, but let us know if you see any needing attention.
Thanks!

Was this reply helpful? Yes No
Mx81 860 on at

Like (2)

Report

@ChrisGarty : thanks for your feedback.
It depends on your definition for "easy". But it will take some time to migrate these flows. Summer time and holiday season and the short time period doesn't really help 😉

Is there a possibility to get some additional weeks for migration?

Was this reply helpful? Yes No
mzandegiacomo 92 on at

Like (3)

Report

Hello @ChrisGarty
Thanks for your message. I definitely think that the transition period is too short and we need more time. Especially in large environments, upgrading the CoE Toolkit is not done so quickly as it needs some testing and environment-specific adjustments before a new version can be used. Especially since the transition period falls in summertime and was announced at far too short notice.
I think the start of enforcing the deprecation at runtime should be postponed until the end of september.
Thanks, Martin

Was this reply helpful? Yes No
Mx81 860 on at

Like (1)

Report

Message Center Info has been released a few days ago - just adding it so other users can find this post more easily

MC624197

Was this reply helpful? Yes No
Nazul 61 on at

Like (3)

Report

This is very disappointing.

First, this was started back in June, and MC624197 was published July 4, so we find out about this weeks later when it was published in MC. And it is going to be enforced in August. Poor communication in my perspective.

And about the change, it is reducing the data is sending back to improve your process, but making ours more complicated and slower. We have over 4K+ flows, so it was enough for most of the scenarios to do a simple Get-AdminFlow -EnvironmentName $defaultEnvName, but now we are forcing to get all flows, and then run the slower version per each flow. Like this.

$flows = Get-AdminFlow -EnvironmentName $defaultEnvName
$tmpFlows = @()
foreach ($tmpFlow in $flows) {
$tmpFlows += Get-AdminFlow -EnvironmentName $tmpFlow.EnvironmentName -FlowName $tmpFlow.FlowName
}
$flows = $tmpFlows

It might be improved if we try to run some paralelism here, but if so, we might reach some thresholds because too many API calls at the same time.

We have an increased time from just a few seconds for the Get-AdminFlow to 3 hours to get all details just because of the missing CreatedBy data.

Was this reply helpful? Yes No
Chris Garty Microsoft Employee on at

Like (1)

Report

@Nazul, the CreatedBy data is something we are trying to add into the V2 result. Is that the only piece of data that is causing you to call “Get-AdminFlow -FlowName” for each flow?

Was this reply helpful? Yes No
Chris Garty Microsoft Employee on at

Like (0)

Report

@max81 and @mzandegiacomo , thanks for the feedback on the timeline. We’ll watch usage of the older API and evaluate where we are in August. Thanks for starting your transitions now to provide us with feedback!

Was this reply helpful? Yes No
IAmIntractable 278 on at

Like (1)

Report

This new action is not working properly. The displayName should not contain a GUID but the actual current name of the flow. Also, I do not believe it is returning flows that are considered soft-removed.

Was this reply helpful? Yes No