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

[ChrisGarty]

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.

[ChrisGarty]

@ziv_dh , The change to provide flow definition from Get Flow as Admin 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.

We are beginning to fail a small percentage of calls to warn people that the deprecation is beginning/proceeding. If you do not have migration in place then a second call to the List Flows as Admin V1 API will likely succeed since only a small percentage of calls are failing as a warning.

[DeeTronSEAM]

[UPDATE to this] : MSFT Support confirmed the problem (i.e. variable inclusion/exclusion of state, createdTime, lastModifiedTime properties/attributes) and said a fix is scheduled for release (at least in my N.A. non-GCC region) around October 25th.  

Additionally they suggested a workaround that did NOT work. I.e. turn the flow off, make a minor edit and re-save the flow, turn the flow back on.

We'll see what happens towards the end of this week.

[ChrisGarty]

@DeeTronSEAM , are things working for you now? 

[DeeTronSEAM]

@ChrisGarty ,  Yep, last week the issue was resolved for us.  FWIW, it took a few days after Support told us the fix was released and from the subsequent discussions, we did a minor flow modification (i.e. we simply changed our "version stamp" we store in a Set Variable action) and resaved the flow, as well as turning the flow off then back on.

I'm not 100% convinced that was necessary but the List Flows action's output was correct after all the dialog and mods so I mention it in case others are still seeing the problem but might want to try the mod+save and/or the on/off toggle.

Please pass along our gratitude for the way the Product Team seemed to be working with the Support team so that we felt the issue was understood, important, and going to be resolved quickly.  Even though it took longer than originally thought, that sense of give-a-**bleep** goes a long way.  The posts here on this thread helped with that too.  Thank you, Chris and everyone else who provided observations here.

[Clasho]

For flows contained in a newly imported solution sometimes some of the flows do not start up automatically.  When this happens List Flows as Admin V2 does not return these flows in the listing.  this prevents us being able the write a flow that will automatically turn these flows on.  Is this a bug?

[ChrisGarty]

Hi @Clasho, in the past the List Flows APIs (V1 or V2) did not return solution flows that had never been turned on. There is a change rolling out now that will return those flows as well.

[ChrisGarty]

After failing up to 80% of calls to the List flows as Admin action on the Power Automate Management connector. The action and its corresponding API will be fully deprecated in the next couple of weeks. The release of the change to enforce full deprecation began in Canada and some other small regions today, and ends with Europe on April 2nd, USA on April 4th, and Government Clouds on April 8th.

[ChrisGarty]

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.

[No_Code]

Hi @ChrisGarty , 
I am still only getting the "Definition Summary" in the "get flow as admin" API (single flow). Is there any timeframe for when the response will also include the "Definition"?
Thanks