Get-AdminFlow

Returns information about one or more flows.

Syntax

Get-AdminFlow
   [[-Filter] <String[]>]
   [-EnvironmentName <String>]
   [-IncludeDeleted <Boolean>]
   [-ApiVersion <String>]
   [<CommonParameters>]
Get-AdminFlow
   [-EnvironmentName <String>]
   -CreatedBy <String>
   [-IncludeDeleted <Boolean>]
   [-ApiVersion <String>]
   [<CommonParameters>]
Get-AdminFlow
   [-EnvironmentName <String>]
   -FlowName <String>
   [-ApiVersion <String>]
   [<CommonParameters>]

Description

The Get-AdminFlow cmdlet looks up information about one or more Power Automate flows depending on parameters. Use Get-Help Get-AdminFlow -Examples for more detail.

Examples

EXAMPLE 1

Get-AdminFlow

Returns all flows from all environments where the current user is an Environment Admin. For Global admins, this will search across all environments in the tenant.

EXAMPLE 2

Get-AdminFlow -CreatedBy dbfad833-1e1e-4665-a20c-96391a1a39f0

Returns all flows created by the user with an object of "dbfad833-1e1e-4665-a20c-96391a1a39f0" from all environments where the calling user is an Environment Admin. For global admins, this cmdlet searches across all environments in the tenant.

EXAMPLE 3

Get-AdminFlow *Flows*

Returns all flows with the text "Flows" from all environments where the current user is an Environment Admin. For global admins, this searches across all environments in the tenant.

EXAMPLE 4

Get-AdminFlow -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239

Finds flows within the 3c2f7648-ad60-4871-91cb-b77d7ef3c239 environment.

EXAMPLE 5

Get-AdminFlow -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239 -IncludeDeleted $true

Finds flows within the 3c2f7648-ad60-4871-91cb-b77d7ef3c239 environment, including any that are soft-deleted.

EXAMPLE 6

Get-AdminFlow *Foobar* -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239

Finds all flows in environment 3c2f7648-ad60-4871-91cb-b77d7ef3c239 that contain the string "Foobar" in their display name.

EXAMPLE 7

Get-AdminFlow -FlowName 4d1f7648-ad60-4871-91cb-b77d7ef3c239 -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239

Returns the details for the flow named 4d1f7648-ad60-4871-91cb-b77d7ef3c239 in environment 3c2f7648-ad60-4871-91cb-b77d7ef3c239.

Parameters

-ApiVersion

The api version to call with.

Type:String
Position:Named
Default value:2016-11-01
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CreatedBy

Limit flows returned to those created by the specified user (you must specify a user's object ID).

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-EnvironmentName

Optionally specify an environment ID to limit flows returned to those in a particular environment.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Filter

Finds flows matching the specified filter (wildcards supported).

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FlowName

Finds a specific ID.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IncludeDeleted

Include soft-deleted flows in the returned list.

Type:Boolean
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False