Power platform for Admins (Preview)

Power platform for Admins (Preview)

Power platform for Admins Connector

This connector is available in the following products and regions:

Service Class Regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create CDS Database

Creates a new CDS instance in the specified Environment.

Required Parameters

Environment
string
Name of the Environment.

Optional Parameters

Base language
integer
Any language returned from List Environment Languages.
Currency code
string
Any currency code returned from List Environment Currencies.
Templates
string

Returns

Body
Environment

Environment object.

Create Environment

Creates a new Environment.

Required Parameters

Location
string
Region the Environment is deployed in.
Display Name
string
Vanity name of the Environment.
Environment Sku
string
Type of Environment.

Returns

Body
Environment

Environment object.

Create Environment DLP Policy

Creates an Environment DLP Policy.

Required Parameters

Environment
string
Name of the Environment.
Display Name
string
Api Policy display name.
Schema Version
string
Api Policy definition $schema.
Name
string
Policy Environment name field.
ID
string
Policy Environment ID field.
Type
string
Policy Environment type field.
Default Group
string
Group a new connector is automatically added to.

Optional Parameters

API Version
string
The date value of the API.
Business Data description
string
Policy Hbi description.
Connector ID
string
Business Data connector ID field.
Connector Name
string
Business Data connector name field.
Connector Type
string
Business Data connector type field.
Non Business Data description
string
Api Policy apiGroup lbi description.
Connector ID
string
Non Business Data connector ID field.
Connector Name
string
Non Business Data connector name field.
Connector Type
string
Non Business Data connector type field.

Returns

Body
Policy

Create Tenant DLP Policy

Creates a new Tenant DLP Policy.

Required Parameters

Display Name
string
Api Policy display name.
Schema Version
string
Api Policy definition $schema.
Constraint Type
string
Policy constraint type, leave blank to apply policy to all Environments.
Name
string
Policy Environment name field.
ID
string
Policy Environment ID field.
Type
string
Policy Environment type field.
Environment Filter Type
string
Api Policy constraint environmentFilter1 parameter filterType.
Default Group
string
Group a new connector is automatically added to.

Optional Parameters

API Version
string
The date value of the API.
Business Data description
string
Policy Hbi description.
Connector ID
string
Business Data connector ID field.
Connector Name
string
Business Data connector name field.
Connector Type
string
Business Data connector type field.
Non Business Data description
string
Api Policy apiGroup lbi description.
Connector ID
string
Non Business Data connector ID field.
Connector Name
string
Non Business Data connector name field.
Connector Type
string
Non Business Data connector type field.

Returns

Body
Policy

Delete Environment

Deletes an Environment.

Required Parameters

Environment
string
Name of the Environment.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Environment

Environment object.

Delete Environment DLP Policy

Deletes an Environment DLP Policy.

Required Parameters

Environment
string
Name of the Environment.
Policy
string
The name field of the Policy.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Environment

Environment object.

Delete Tenant DLP Policy

Deletes a Tenant DLP Policy.

Required Parameters

Policy
string
The name field of the Policy.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Environment

Environment object.

Edit Environment Role Assignment

Sets permissions for an Environment.

Required Parameters

Environment
string
Name of the Environment.

Optional Parameters

API Version
string
The date value of the API.
Principal Email
string
The principal email of the user.
Principal Tenant ID
string
The principal tenant ID of the user.
Principal Object ID
string
The principal object ID of the user.
Principal Type
string
The principal type of the user.
Role Definition ID
string
The role definition ID. Format: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}.
id
string
The id field.

Returns

Get CDS Provisioning Status

Used to check the status of a provisioning operation.

Required Parameters

Environment
string
Name of the Environment.
Operation
string
Name of the Operation.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Environment

Environment object.

Get Environment DLP Policy

Returns an Environment DLP Policy.

Required Parameters

Environment
string
Name of the Environment.
Policy
string
The name field of the Policy.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Policy

Get Environment Operation Status

Used to check the status of an environment operation, sucn as deletion.

Required Parameters

Environment
string
Name of the Environment.
Operation
string
Name of the Operation.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Environment

Environment object.

Get Environment as Admin

Returns a single Environment as Admin.

Required Parameters

Environment
string
Name of the Environment.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Environment

Environment object.

Get Tenant DLP Policy

Returns a Tenant DLP Policy.

Required Parameters

Policy
string
The name field of the Policy.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Policy

List DLP Policies

Returns a list of all Tenant and Environment DLP Policies.

Optional Parameters

API Version
string
The date value of the API.

Returns

List Environment Role Assignments

Returns a list of permissions for an Environment without CDS for Apps.

Required Parameters

Environment
string
Name of the Environment.

Optional Parameters

API Version
string
The date value of the API.

Returns

List Environments as Admin

Returns a list of Environments.

Optional Parameters

API Version
string
The date value of the API.
Skip Token
string
The input used to get the next page of the response.
Page size
integer
Number of Environments in the response.

Returns

List Supported Environment Currencies

Returns a list of supported Currencies based on the location.

Required Parameters

Location
string
The location of the Environment.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Currencies

List Supported Environment Languages

Returns a list of supported Languages based on the location.

Required Parameters

Location
string
The location of the Environment.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Languages

List Supported Locations

Returns a list of Locations where BAP service is supported.

Optional Parameters

API Version
string
The date value of the API.

Returns

Body
Locations

Update Environment DLP Policy

Updates an Environment DLP Policy.

Required Parameters

Environment
string
Name of the Environment.
Policy
string
The name field of the Policy.
Display Name
string
Api Policy display name.
Schema Version
string
Api Policy definition $schema.
Name
string
Policy Environment name field.
ID
string
Policy Environment ID field.
Type
string
Policy Environment type field.
Default Group
string
Group a new connector is automatically added to.

Optional Parameters

API Version
string
The date value of the API.
Business Data description
string
Policy Hbi description.
Connector ID
string
Business Data connector ID field.
Connector Name
string
Business Data connector name field.
Connector Type
string
Business Data connector type field.
Non Business Data description
string
Api Policy apiGroup lbi description.
Connector ID
string
Non Business Data connector ID field.
Connector Name
string
Non Business Data connector name field.
Connector Type
string
Non Business Data connector type field.

Returns

Body
Policy

Update Tenant DLP Policy

Updates the fields in a DLP Policy.

Required Parameters

Policy
string
The name field of the Policy.
Display Name
string
Api Policy display name.
Schema Version
string
Api Policy definition $schema.
Constraint Type
string
Policy constraint type, leave blank to apply policy to all Environments.
Name
string
Policy Environment name field.
ID
string
Policy Environment ID field.
Type
string
Policy Environment type field.
Environment Filter Type
string
Api Policy constraint environmentFilter1 parameter filterType.
Default Group
string
Group a new connector is automatically added to.

Optional Parameters

API Version
string
The date value of the API.
Business Data description
string
Policy Hbi description.
Connector ID
string
Business Data connector ID field.
Connector Name
string
Business Data connector name field.
Connector Type
string
Business Data connector type field.
Non Business Data description
string
Api Policy apiGroup lbi description.
Connector ID
string
Non Business Data connector ID field.
Connector Name
string
Non Business Data connector name field.
Connector Type
string
Non Business Data connector type field.

Returns

Body
Policy

Validate Environment Delete

Used to check if an Environment can be deleted.

Required Parameters

Environment
string
Name of the Environment.

Optional Parameters

API Version
string
The date value of the API.

Returns

Definitions

ResourceArray[Policy]

value
array of Policy

Policy

Created by
Principal[CreatedBy]
Policy created by principal object.
Created time
date-time
Api Policy created time.
Default Group
PolicyDefaultApiGroup
Group a new connector is automatically added to.
Display Name
string
Api Policy display name.
Environments
PolicyEnvironments
Policy Environment.
Filter Type
string
Api Policy constraint environmentFilter1 parameter filterType.
Modified by
Principal[ModifiedBy]
Policy modified by principal object.
Modified time
date-time
Api Policy modified time.
Policy ID
string
Policy ID field.
Policy Name
string
Policy name field.
Policy Type
string
Policy type field.
Schema Version
PolicySchema
Api Policy definition $schema.
Type
string
Policy environmentFilter type.
apiGroups
PolicyApiGroups
rules
PolicyRules
Policy rules object.

ResourceArray[Environment]

Next Link
string
The URL to get the next page of the Environments list.
value
array of Environment
Environment value object array.

Environment

Environment object.

Azure Region Hint
string
Environment azureRegionHint field.
BAP Solution Id
string
Environment linkedEnvironmentMetadata bapSolutionId.
Base Language
integer
Environment linkedEnvironmentMetadata baseLanguage.
Business App Platform
string
BusinessAppPlatform runtime endpoint.
Common Data Model
string
CommonDataModel runtime endpoint.
Created Time
date-time
Created Time of Environment.
Created Time
date-time
Environment linkedEnvironmentMetadata createdTime.
Created by
Principal[CreatedBy]
Policy created by principal object.
Creation Templates
array of string
Environment linkedEnvironmentMetadata creationTemplates.
Creation Type
string
Creation Type of Environment.
Display Name
string
Display Name of Environment.
Domain Name
string
Environment linkedEnvironmentMetadata domainName.
Environment Sku
string
Sku ID of Environment.
Environment Type
string
Type of Environment.
Flow
string
Flow runtime endpoint.
Friendly Name
string
Environment linkedEnvironmentMetadata friendlyName.
Host Name Suffix
string
Environment linkedEnvironmentMetadata hostNameSuffix.
ID
string
Environment ID field.
Instance API URL
string
Environment linkedEnvironmentMetadata instanceApiUrl.
Instance State
string
Environment linkedEnvironmentMetadata instanceState.
Instance URL
string
Environment linkedEnvironmentMetadata instanceUrl.
Is Default
boolean
Is Default Environment or not.
Location
string
Environment location field.
Management Package Version
string
Environment linkedEnvironmentMetadata managementPackageVersion.
Modified Time
date-time
Environment linkedEnvironmentMetadata modifiedTime.
Modified by
Principal[ModifiedBy]
Policy modified by principal object.
Name
string
Environment name field.
PowerApps
string
PowerApps runtime endpoint.
Provisioning State
string
Environment provisioningState.
Resource Id
string
Environment linkedEnvironmentMetadata resourceId.
Soft Deleted Time
date-time
Environment softDeletedTime.
Type
string
Environment linkedEnvironmentMetadata type.
Type
string
Environment type field.
Unique Name
string
Environment linkedEnvironmentMetadata uniqueName.
Version
string
Environment linkedEnvironmentMetadata version.
lastModifiedTime
date-time
Environment lastModified date and time.

PolicyEnvironments

Policy Environment.

ID
string
Policy Environment ID field.
Name
string
Policy Environment name field.
Type
string
Policy Environment type field.

PolicyRules

Policy rules object.

value
array of Policy
Policy rules object.

PolicySchema

Api Policy definition $schema.

value
array of Policy
Api Policy definition $schema.

PolicyApiGroups

hbi
PolicyHbi
Policy Hbi group.
lbi
PolicyLbi

PolicyHbi

Policy Hbi group.

Business Data
array of object
Business Data APIs.
Business Data description
string
Policy Hbi description.
Connector ID
string
Business Data connector ID field.
Connector Name
string
Business Data connector name field.
Connector Type
string
Business Data connector type field.

PolicyLbi

Connector ID
string
Non Business Data connector ID field.
Connector Name
string
Non Business Data connector name field.
Connector Type
string
Non Business Data connector type field.
Non Business Data
array of object
Non Business Data APIs.
Non Business Data description
string
Api Policy apiGroup lbi description.

PolicyDefaultApiGroup

Group a new connector is automatically added to.

value
array of Policy
Group a new connector is automatically added to.

ValidateDeleteResponse

Can Delete
boolean
Environment can be deleted.
Code
string
Error code for validate delete.
Errors array
array of object
Errors array
ID
string
Resource to be deleted ID.
Message
string
Error message.
Name
string
Resource to be deleted name.
Type
string
Resource to be deleted type.
resourcesToBeDeleted
array of object

ResourceArray[RoleAssignment]

displayName
string
Environment Role Assignment principal displayName.
email
string
Environment Role Assignment principal email.
id
string
Environment Role Assignment ID field.
id
string
Environment Role Assignment roleDefinition ID field.
id
string
Environment Role Assignment principal object ID.
name
string
Environment Role Assignment field name.
name
string
Environment Role Assignment roleDefinition field name.
scope
string
Environment Role Assignment scope.
type
string
Environment Role Assignment type field.
type
string
Environment Role Assignment roleDefinition type field.
type
string
Environment Role Assignment principal type.
value
array of object
Environment Role Assignment value object array.

RoleAssignment

add
array of object
Environment Role Assignment add object.
displayName
string
Environment Role Assignment principal displayName.
email
string
Environment Role Assignment principal email.
httpStatus
string
Environment Role Assignment httpStatus.
id
string
Environment Role Assignment roleAssignment ID field.
id
string
Environment Role Assignment roleDefinition ID field.
id
string
Environment Role Assignment principal object ID.
name
string
Environment Role Assignment roleAssignment name field.
name
string
Environment Role Assignment roleDefinition name field.
scope
string
Environment Role Assignment scope.
type
string
Environment Role Assignment roleAssignment type field.
type
string
Environment Role Assignment roleDefinition ID field.
type
string
Environment Role Assignment principal type.

Principal[ModifiedBy]

Policy modified by principal object.

Display name
string
Modified by principal displayName.
Email
string
Modified by principal.
ID
string
Modified by principal object ID.
Tenant ID
string
Modified by principal tenant ID.
Type
string
Modified by principal type.
UPN
string
Modified by userPrincipalName.

Principal[CreatedBy]

Policy created by principal object.

Display name
string
Api Policy creator principal displayName.
Email
string
Api Policy creator principal email.
ID
string
Api Policy creator principal object ID.
Tenant ID
string
Api Policy creator principal tenant ID.
Type
string
Api Policy creator principal type.
UPN
string
Api Policy creator userPrincipalName.

Locations

Display Name
string
Location display name.
ID
string
Location ID.
Is Default
boolean
Is the default location.
Is Disabled
boolean
Location is Disabled.
Name
string
Location Name.
value
array of object

Currencies

Display Name
string
Currency display name.
ID
string
Currency ID.
Locale ID
integer
Locale ID of the currency.
Localized Name
string
Localized name of the currency.
Name
string
Currency name.
value
array of object

Languages

Display Name
string
Language display name field.
ID
string
Language ID field.
Is Tenant Default
boolean
Language is tenant default field.
Locale ID
integer
Language locale ID field.
Localized Name
string
Language localized name field.
Name
string
Language name field.
Type
string
Language type field.
value
array of object