Connectors Reference
Power Automate Management connector enables interaction with Power Automate Management service. For example: creating, editing, and updating flows. Administrators who want to perform operations with admin privileges should call actions with the 'as Admin' suffix.
|
Status: Production |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
List Connectors |
|
|
Get Connector |
|
|
CreateConnection (string environmentName, string apiName, [Optional]Connection connection) |
Create Connection |
|
List My Connections |
|
|
List My Environments |
|
|
List Flow Owners |
|
|
ModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions) |
Modify Flow Owners |
|
List Flow Run-Only Users |
|
|
Modify Run-Only Users |
|
|
List My Flows |
|
|
CreateFlow (string environmentName, FlowWithConnectionReferences Flow) |
Create Flow |
|
Get Flow |
|
|
Delete Flow |
|
|
UpdateFlow (string environmentName, string flowName, FlowWithConnectionReferences Flow) |
Update Flow |
|
Turn Off Flow |
|
|
Turn On Flow |
|
|
ListFlowsInEnvironment (string environmentName, [advanced][Optional]integer $top) |
List Flows as Admin |
|
Modify Flow Owners as Admin |
|
|
Get Flow as Admin |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List Connectors
Description: Lists all of the connectors available in the given environment. This list will include custom connectors as well as the built-in connectors.
Syntax:
PowerAutomateManagement.ListApis (string environmentName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
Returns:
Type:ResourceArray[ApiWithoutConnectionParameters]
Summary: Get Connector
Description: Get the given connector in an environment.
Syntax:
PowerAutomateManagement.GetApi (string environmentName, string apiName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
apiName |
string (Connector) |
Select connector |
True |
Returns:
Type:Api
Summary: Create Connection
Description: Create a connection for the given connector in an environment.
Syntax:
PowerAutomateManagement.CreateConnection (string environmentName, string apiName, [Optional]Connection connection)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
apiName |
string (Connector) |
Select connector |
True |
|
|
connection |
|
|
False |
Returns:
Type:Connection
Summary: List My Connections
Description: Lists all your connection available in the given environment.
Syntax:
PowerAutomateManagement.ListConnections (string environmentName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
Returns:
Type:ResourceArray[ConnectionWithoutConnectionParameters]
Summary: List My Environments
Description: List the environments you have access to.
Syntax:
PowerAutomateManagement.ListUserEnvironments ()
Returns:
Type:ResourceArray[Environment]
Summary: List Flow Owners
Description: List all owners of the given flow in an environment.
Syntax:
PowerAutomateManagement.ListFlowOwners (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Type:ResourceArray[FlowPermission]
Summary: Modify Flow Owners
Description: Modify owners of the given flow in an environment.
Syntax:
PowerAutomateManagement.ModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
|
|
permissions |
|
|
True |
Returns:
Summary: List Flow Run-Only Users
Description: List all run only users of the given flow in an environment.
Syntax:
PowerAutomateManagement.ListFlowUsers (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Type:ResourceArray[FlowPermission]
Summary: Modify Run-Only Users
Description: Modify run-only users of the given flow in an environment.
Syntax:
PowerAutomateManagement.ModifyRunOnlyUsers (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
|
|
permissions |
|
|
True |
Returns:
Summary: List My Flows
Description: List all flows you created in the given environment.
Syntax:
PowerAutomateManagement.ListMyFlows (string environmentName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
Returns:
Summary: Create Flow
Description: Create flow
Syntax:
PowerAutomateManagement.CreateFlow (string environmentName, FlowWithConnectionReferences Flow)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
Flow |
|
|
True |
Returns:
Type:Flow
Summary: Get Flow
Description: Get the given flow in an environment.
Syntax:
PowerAutomateManagement.GetFlow (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Type:FlowWithConnectionReferences
Summary: Delete Flow
Description: Delete the given flow in an environment
Syntax:
PowerAutomateManagement.DeleteFlow (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Summary: Update Flow
Description: Update the given flow in an environment.
Syntax:
PowerAutomateManagement.UpdateFlow (string environmentName, string flowName, FlowWithConnectionReferences Flow)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
|
|
Flow |
|
|
True |
Returns:
Type:Flow
Summary: Turn Off Flow
Description: Stop the given flow in an environment.
Syntax:
PowerAutomateManagement.StopFlow (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Summary: Turn On Flow
Description: Start the given flow in an environment.
Syntax:
PowerAutomateManagement.StartFlow (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Summary: List Flows as Admin
Description: List all flows in the given environment you have admin access to.
Syntax:
PowerAutomateManagement.ListFlowsInEnvironment (string environmentName, [advanced][Optional]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
$top |
integer (Top count) |
Top count |
False |
Returns:
Summary: Modify Flow Owners as Admin
Description: Modify owners of the given flow created in an environment you have admin access to.
Syntax:
PowerAutomateManagement.AdminModifyFlowOwners (string environmentName, string flowName, ModifyFlowPermissionPayload permissions)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
|
|
permissions |
|
|
True |
Returns:
Summary: Get Flow as Admin
Description: Get the given flow from an environment you have admin access to.
Syntax:
PowerAutomateManagement.AdminGetFlow (string environmentName, string flowName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environmentName |
string (Environment) |
Select environment |
True |
|
|
flowName |
string (Flow) |
Select flow |
True |
Returns:
Type:AdminFlowWithConnectionReferences
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Flow Name |
|
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Flow Display Name |
|
|
state |
string Flow State |
Values: [Started, Stopped] |
|
connectionReferences |
ConnectionReferencesDictionary
|
|
|
createdTime |
string(date-time) Flow Created Time |
|
|
lastModifiedTime |
string(date-time) Flow Modified Time |
|
|
templateName |
string Flow Template Name |
|
|
flowTriggerUri |
string Flow Trigger Uri |
|
|
installationStatus |
string Flow Installation Status |
Values: [NotApplicable, Uninstalled, Broken, Installed] |
|
creator |
|
|
|
definitionSummary |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Flow Name |
|
|
properties |
AdminFlowWithConnectionReferencesProperties
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Flow Display Name |
|
|
state |
string Flow State |
Values: [Started, Stopped] |
|
connectionReferences |
array of (ConnectionReference)
|
|
|
createdTime |
string(date-time) Flow Created Time |
|
|
lastModifiedTime |
string(date-time) Flow Modified Time |
|
|
templateName |
string Flow Template Name |
|
|
flowTriggerUri |
string Flow Trigger Uri |
|
|
installationStatus |
string Flow Installation Status |
Values: [NotApplicable, Uninstalled, Broken, Installed] |
|
creator |
|
|
|
definitionSummary |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Connector Name |
|
|
properties |
|
|
Summary:
Description: API connection parameters
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Connector Display Name |
|
|
createdTime |
string(date-time) Connection Created Time |
|
|
connectionParameters |
|
API connection parameters |
|
primaryRuntimeUrl |
string Connector Runtime Url |
|
|
iconUri |
string Connector Icon Url |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Connector Display Name |
|
|
createdTime |
string(date-time) Connection Created Time |
|
|
primaryRuntimeUrl |
string Connector Runtime Url |
|
|
iconUri |
string Connector Icon Url |
|
|
isCustomApi |
boolean Connector is Custom Api |
|
|
tier |
string Connector Tier |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Connector Name |
|
|
properties |
ApiPropertiesWithoutConnectionParameters
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Connection Name |
|
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Connector Display Name |
|
|
apiId |
string Connector Id |
|
|
createdTime |
string(date-time) Connection Created Time |
|
|
lastModifiedTime |
string(date-time) Connection Last Modified Time |
|
|
connectionParameters |
|
API connection parameters |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Connector Display Name |
|
|
apiId |
string Connector Id |
|
|
createdTime |
string(date-time) Connection Created Time |
|
|
lastModifiedTime |
string(date-time) Connection Last Modified Time |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
connectionName |
string Connection Name |
|
|
displayName |
string Connection Display Name |
|
|
id |
string Connector Id |
|
|
apiDefinition |
ApiWithoutConnectionParameters
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Connection Name |
|
|
properties |
ConnectionPropertiesWithoutConnectionParameters
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
triggers |
array of (TriggersItem)
|
|
|
actions |
array of (ActionsItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string Flow trigger type |
|
|
kind |
string Flow trigger kind |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string Action type |
|
|
swaggerOperationId |
string Swagger operation Id |
|
|
api |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Action Api name |
|
|
id |
string Action Api id |
|
|
type |
string Action Api type |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Environment Name |
|
|
location |
string Environment Location |
|
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Environment Display Name |
|
|
description |
string Environment Description |
|
|
createdTime |
string(date-time) Environment Created Time |
|
|
lastModifiedTime |
string(date-time) Environment Last Modified Time |
|
|
provisioningState |
string Environment Provisioning State |
Values: [NotSpecified, Succeeded, Deleting, Deleted, Failed, FailedDeleting] |
|
creationType |
string Environment Creation Type |
Values: [NotSpecified, Legacy, DefaultTenant, User, CommonDataModelLegacy, Partner, Developer] |
|
environmentSku |
string Environment Sku |
Values: [NotSpecified, Standard, Premium, Developer, Basic] |
|
environmentType |
string Environment Type |
Values: [NotSpecified, Production, Sandbox] |
|
isDefault |
boolean Is Default Environment |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Flow Name |
|
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Permission Name |
|
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Flow Display Name |
|
|
definition |
Flow Definition |
|
|
state |
string Flow State |
Values: [Started, Stopped] |
|
connectionReferences |
ConnectionReferencesDictionary
|
|
|
createdTime |
string(date-time) Flow Created Time |
|
|
lastModifiedTime |
string(date-time) Flow Modified Time |
|
|
templateName |
string Flow Template Name |
|
|
flowTriggerUri |
string Flow Trigger Uri |
|
|
installationStatus |
string Flow Installation Status |
Values: [NotApplicable, Uninstalled, Broken, Installed] |
Summary: Flow Definition
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Flow Name |
|
|
properties |
FlowWithConnectionReferencesProperties
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Flow Display Name |
|
|
definition |
Flow Definition |
|
|
state |
string Flow State |
Values: [Started, Stopped] |
|
connectionReferences |
array of (ConnectionReference)
|
|
|
createdTime |
string(date-time) Flow Created Time |
|
|
lastModifiedTime |
string(date-time) Flow Modified Time |
|
|
templateName |
string Flow Template Name |
|
|
flowTriggerUri |
string Flow Trigger Uri |
|
|
installationStatus |
string Flow Installation Status |
Values: [NotApplicable, Uninstalled, Broken, Installed] |
|
creator |
|
|
|
definitionSummary |
|
|
Summary: Flow Definition
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
put |
array of (FlowPermission[Add])
|
|
|
delete |
array of (FlowPermission[Remove])
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
roleName |
string
|
Values: [Owner, CanEdit, CanView] |
|
principal |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
principal |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
principal |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Object Id |
|
|
displayName |
string Display Name |
|
|
|
string |
|
|
type |
string Type |
Values: [User, Group] |
|
tenantId |
string Tenant Id |
|
|
userPrincipalName |
string Principal Name |
|
|
thumbnailPhoto |
string Owner Thumbnail Photo |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Add User Object Id |
|
|
type |
string Add User Type |
Values: [User, Group] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Remove User Object Id |
|
|
type |
string Remove User Type |
Values: [User, Group] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (AdminFlow)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ApiWithoutConnectionParameters)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ConnectionWithoutConnectionParameters)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Environment)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (FlowPermission)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tenantId |
string Creator tenant ID |
|
|
objectId |
string Creator object ID |
|
|
userId |
string Creator user ID |
|
|
userType |
string Creator user type |
|