< Back
Get-AdminFlow
Post
NAME Get-AdminFlow
SYNOPSIS
Returns information about one or more flows.
SYNTAX
Get-AdminFlow [[-Filter] <String[]>] [-EnvironmentName <String>] [-ApiVersion <String>] [<CommonParameters>]
Get-AdminFlow [-EnvironmentName <String>] -CreatedBy <String> [-ApiVersion <String>] [<CommonParameters>]
Get-AdminFlow [-EnvironmentName <String>] -FlowName <String> [-ApiVersion <String>] [<CommonParameters>]
DESCRIPTION
The Get-AdminFlow looks up information about one or more flows depending on parameters.
Use Get-Help Get-AdminFlow -Examples for more detail.
PARAMETERS
-Filter <String[]>
Finds flows matching the specified filter (wildcards supported).
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnvironmentName <String>
Limit flows returned to those in a specified environment.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-FlowName <String>
Finds a specific id.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CreatedBy <String>
Limit flows returned to those created by the specified user (you must specify a user's object id)
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApiVersion <String>
Required? false
Position? named
Default value 2016-11-01
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-AdminFlow
Returns all flow 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 --------------------------
PS C:\\>Get-AdminFlow -CreatedBy dbfad833-1e1e-4665-a20c-96391a1a39f0
Returns all apps created by the user with an object of "dbfad833-1e1e-4665-a20c-96391a1a39f0" from all environment
where the calling user is an Environment Admin. For Global admins, this will search across all environments in
the tenant.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>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 will search across all environments in the tenant.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-AdminFlow -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239
Finds flows within the 3c2f7648-ad60-4871-91cb-b77d7ef3c239 environment
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>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 6 --------------------------
PS C:\\>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
RELATED LINKS
SYNOPSIS
Returns information about one or more flows.
SYNTAX
Get-AdminFlow [[-Filter] <String[]>] [-EnvironmentName <String>] [-ApiVersion <String>] [<CommonParameters>]
Get-AdminFlow [-EnvironmentName <String>] -CreatedBy <String> [-ApiVersion <String>] [<CommonParameters>]
Get-AdminFlow [-EnvironmentName <String>] -FlowName <String> [-ApiVersion <String>] [<CommonParameters>]
DESCRIPTION
The Get-AdminFlow looks up information about one or more flows depending on parameters.
Use Get-Help Get-AdminFlow -Examples for more detail.
PARAMETERS
-Filter <String[]>
Finds flows matching the specified filter (wildcards supported).
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnvironmentName <String>
Limit flows returned to those in a specified environment.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-FlowName <String>
Finds a specific id.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CreatedBy <String>
Limit flows returned to those created by the specified user (you must specify a user's object id)
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApiVersion <String>
Required? false
Position? named
Default value 2016-11-01
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-AdminFlow
Returns all flow 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 --------------------------
PS C:\\>Get-AdminFlow -CreatedBy dbfad833-1e1e-4665-a20c-96391a1a39f0
Returns all apps created by the user with an object of "dbfad833-1e1e-4665-a20c-96391a1a39f0" from all environment
where the calling user is an Environment Admin. For Global admins, this will search across all environments in
the tenant.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>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 will search across all environments in the tenant.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-AdminFlow -EnvironmentName 3c2f7648-ad60-4871-91cb-b77d7ef3c239
Finds flows within the 3c2f7648-ad60-4871-91cb-b77d7ef3c239 environment
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>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 6 --------------------------
PS C:\\>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
RELATED LINKS