Power Platform for Admins

Power Platform Management Connector provides access to environment lifecycle management capabilities, DLP policy management, and other admin capabilities provided in the BAP API.

Status: Production

Tier: Standard

Version: 1.0

Actions:

Name	Summary
Get-AdminEnvironment ([advanced][Optional]string api-version, [advanced][Optional]string $skiptoken, [advanced][Optional]integer $top, [advanced][Optional]string $expand)	List Environments as Admin
NewAdminEnvironment ([advanced]string api-version, [internal]string id, NewAdminEnvironmentParameterBody body)	Create Environment
GetSingleEnvironment (string environment, [advanced][Optional]string api-version)	Get Environment as Admin
Remove-AdminEnvironment (string environment, [advanced][Optional]string api-version)	Delete Environment
Get-AdminEnvironmentRoleAssignment (string environment, [advanced][Optional]string api-version)	List Environment Role Assignments
Edit-AdminEnvironmentRoleAssignment (string environment, [advanced][Optional]string api-version, [Optional]ManageRoleAssignment body)	Edit Environment Role Assignment
Get-AdminDlpPolicies ([advanced][Optional]string api-version)	List DLP Policies
NewTenantPolicy ([advanced][Optional]string api-version, [Optional]ManagedTenantPolicy body)	Create Tenant DLP Policy
Edit-AdminDlpPolicy (string policy, [advanced][Optional]string api-version, [Optional]ManagedTenantPolicy body)	Update Tenant DLP Policy
GetTenantPolicy (string policy, [advanced][Optional]string api-version)	Get Tenant DLP Policy
RemoveTenantPolicy (string policy, [advanced][Optional]string api-version)	Delete Tenant DLP Policy
ListSupportedLocations ([advanced][Optional]string api-version)	List Supported Locations
ListEnvironmentLanguages (string environmentLocation, [advanced][Optional]string api-version)	List Supported Environment Languages
ListEnvironmentCurrencies (string environmentLocation, [advanced][Optional]string api-version)	List Supported Environment Currencies
ProvisionInstance ([internal]string api-version, string environment, [Optional]ProvisionInstanceParameterBody body)	Create CDS Database
GetProvisionOperation (string environment, string operationName, [advanced][Optional]string api-version)	Get CDS Provisioning Status
GetProvisionOperationV2 (string environment, string operationName, [advanced][Optional]string api-version)	Get database provisioning status
GetEnvironmentOperation (string environment, string operationName, [advanced][Optional]string api-version)	Get Environment Operation Status
Add-AdminPowerAppsSyncUser (string environment, UserIdentity body, [advanced][Optional]string api-version)	Force Sync user
ValidateDelete (string environment, [advanced][Optional]string api-version)	Validate Environment Delete
NewEnvironmentPolicy ([advanced][Optional]string api-version, string environment, ManagedEnvironmentPolicy body)	Create Environment DLP Policy
GetEnvironmentPolicy (string environment, string policy, [advanced][Optional]string api-version)	Get Environment DLP Policy
EditEnvironmentPolicy (string environment, string policy, [advanced][Optional]string api-version, ManagedEnvironmentPolicy body)	Update Environment DLP Policy
RemoveEnvironmentPolicy (string environment, string policy, [advanced][Optional]string api-version)	Delete Environment DLP Policy
ListPoliciesV2 ()	List DLP Policies V2
CreatePolicyV2 ([Optional]ManagedPolicyV2 body)	Create DLP Policy V2
GetPolicyV2 (string policy)	Get DLP Policy V2
UpdatePolicyV2 (string policy, [advanced][Optional]string api-version, ManagedPolicyV2 body)	Update DLP Policy V2
DeletePolicyV2 (string policy)	Delete DLP Policy V2

Triggers:

Name

Summary

Objects:

Name	Summary
Currencies
DeletePolicyV2Response
Environment
Languages
Locations
ManagedEnvironmentPolicy
ManagedPolicyV2
ManagedTenantPolicy
ManageRoleAssignment
NewAdminEnvironmentParameterBody
Policy
PolicyApiGroups
PolicyHbi
PolicyLbi
PolicyRules
PolicyV2
Principal[CreatedBy]	Created by
Principal[ModifiedBy]	Modified by
ProvisionInstanceParameterBody
RemoveEnvironmentPolicyResponse
RemoveTenantPolicyResponse
ResourceArray[Environment]
ResourceArray[PolicyV2]
ResourceArray[Policy]
ResourceArray[RoleAssignment]
RoleAssignment
UserIdentity
ValidateDeleteResponse

Actions:

Get-AdminEnvironment

Summary: List Environments as Admin

Description: Returns a list of Environments.

Syntax:

PowerPlatformforAdmins.Get-AdminEnvironment ([advanced][Optional]string api-version, [advanced][Optional]string $skiptoken, [advanced][Optional]integer $top, [advanced][Optional]string $expand)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	The date value of the API.	False
$skiptoken	string (Skip Token)	The input used to get the next page of the response.	False
$top	integer (Page size)	Number of Environments in the response.	False
$expand	string (Expand properties)	Allows access to expand response properties.	False

Returns:

Type:ResourceArray[Environment]

NewAdminEnvironment

Summary: Create Environment

Description: Creates a new Environment.

Syntax:

PowerPlatformforAdmins.NewAdminEnvironment ([advanced]string api-version, [internal]string id, NewAdminEnvironmentParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	The date value of the API.	True
id	string (Environment Id)	Environment Id to create a new environment.	True
body	NewAdminEnvironmentParameterBody		True

Returns:

Type:Environment

Description: Environment object.

GetSingleEnvironment

Summary: Get Environment as Admin

Description: Returns a single Environment as Admin.

Syntax:

PowerPlatformforAdmins.GetSingleEnvironment (string environment, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

environment

string

(Environment)

Name of the Environment.

True

Get-AdminEnvironment

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:Environment

Description: Environment object.

Remove-AdminEnvironment

Summary: Delete Environment

Description: Deletes an Environment.

Syntax:

PowerPlatformforAdmins.Remove-AdminEnvironment (string environment, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

environment

string

(Environment)

Name of the Environment.

True

Get-AdminEnvironment

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:Environment

Description: Environment object.

Get-AdminEnvironmentRoleAssignment

Summary: List Environment Role Assignments

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

Syntax:

PowerPlatformforAdmins.Get-AdminEnvironmentRoleAssignment (string environment, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

environment

string

(Environment)

Name of the Environment.

True

Get-AdminEnvironment

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:ResourceArray[RoleAssignment]

Edit-AdminEnvironmentRoleAssignment

Summary: Edit Environment Role Assignment

Description: Sets permissions for an Environment.

Syntax:

PowerPlatformforAdmins.Edit-AdminEnvironmentRoleAssignment (string environment, [advanced][Optional]string api-version, [Optional]ManageRoleAssignment body)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
api-version	string (API Version)	The date value of the API.	False
body	ManageRoleAssignment		False

Returns:

Type:RoleAssignment

Get-AdminDlpPolicies

Summary: List DLP Policies

Description: Returns a list of all Tenant and Environment DLP Policies.

Syntax:

PowerPlatformforAdmins.Get-AdminDlpPolicies ([advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:ResourceArray[Policy]

NewTenantPolicy

Summary: Create Tenant DLP Policy

Description: Creates a new Tenant DLP Policy.

Syntax:

PowerPlatformforAdmins.NewTenantPolicy ([advanced][Optional]string api-version, [Optional]ManagedTenantPolicy body)

Parameters:

Name

Type

Summary

Required

Related Action

api-version

string

(API Version)

The date value of the API.

False

body

ManagedTenantPolicy

False

Returns:

Type:Policy

Edit-AdminDlpPolicy

Summary: Update Tenant DLP Policy

Description: Updates the fields in a DLP Policy.

Syntax:

PowerPlatformforAdmins.Edit-AdminDlpPolicy (string policy, [advanced][Optional]string api-version, [Optional]ManagedTenantPolicy body)

Parameters:

Name	Type	Summary	Required	Related Action
policy	string (Policy)	The name field of the Policy.	True	Get-AdminDlpPolicies
api-version	string (API Version)	The date value of the API.	False
body	ManagedTenantPolicy		False

Returns:

Type:Policy

GetTenantPolicy

Summary: Get Tenant DLP Policy

Description: Returns a Tenant DLP Policy.

Syntax:

PowerPlatformforAdmins.GetTenantPolicy (string policy, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

policy

string

(Policy)

The name field of the Policy.

True

Get-AdminDlpPolicies

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:Policy

RemoveTenantPolicy

Summary: Delete Tenant DLP Policy

Description: Deletes a Tenant DLP Policy.

Syntax:

PowerPlatformforAdmins.RemoveTenantPolicy (string policy, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

policy

string

(Policy)

The name field of the Policy.

True

Get-AdminDlpPolicies

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:RemoveTenantPolicyResponse

ListSupportedLocations

Summary: List Supported Locations

Description: Returns a list of Locations where BAP service is supported.

Syntax:

PowerPlatformforAdmins.ListSupportedLocations ([advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:Locations

ListEnvironmentLanguages

Summary: List Supported Environment Languages

Description: Returns a list of supported Languages based on the location.

Syntax:

PowerPlatformforAdmins.ListEnvironmentLanguages (string environmentLocation, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

environmentLocation

string

(Location)

The location of the Environment.

True

ListSupportedLocations

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:Languages

ListEnvironmentCurrencies

Summary: List Supported Environment Currencies

Description: Returns a list of supported Currencies based on the location.

Syntax:

PowerPlatformforAdmins.ListEnvironmentCurrencies (string environmentLocation, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

environmentLocation

string

(Location)

The location of the Environment.

True

ListSupportedLocations

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:Currencies

ProvisionInstance

Summary: Create CDS Database

Description: Creates a new CDS instance in the specified Environment.

Syntax:

PowerPlatformforAdmins.ProvisionInstance ([internal]string api-version, string environment, [Optional]ProvisionInstanceParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	The date value of the API.	True
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
body	ProvisionInstanceParameterBody		False

Returns:

Type:Environment

Description: Environment object.

GetProvisionOperation

Summary: Get CDS Provisioning Status

Description: Used to check the status of a provisioning operation.

Syntax:

PowerPlatformforAdmins.GetProvisionOperation (string environment, string operationName, [advanced][Optional]string api-version)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
operationName	string (Operation)	Name of the Operation.	True
api-version	string (API Version)	The date value of the API.	False

Returns:

GetProvisionOperationV2

Summary: Get database provisioning status

Description: Used to check the status of a provisioning operation.

Syntax:

PowerPlatformforAdmins.GetProvisionOperationV2 (string environment, string operationName, [advanced][Optional]string api-version)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
operationName	string (Operation)	The name of the operation. This entire URI will be returned as the Location header from /provisionInstance, and will include this value.	True
api-version	string (API Version)	The date value of the API.	False

Returns:

GetEnvironmentOperation

Summary: Get Environment Operation Status

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

Syntax:

PowerPlatformforAdmins.GetEnvironmentOperation (string environment, string operationName, [advanced][Optional]string api-version)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
operationName	string (Operation)	Name of the Operation.	True
api-version	string (API Version)	The date value of the API.	False

Returns:

Add-AdminPowerAppsSyncUser

Summary: Force Sync user

Description: Used to sync PowerApps user to CRM.

Syntax:

PowerPlatformforAdmins.Add-AdminPowerAppsSyncUser (string environment, UserIdentity body, [advanced][Optional]string api-version)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
body	UserIdentity		True
api-version	string (API Version)	The date value of the API.	False

Returns:

ValidateDelete

Summary: Validate Environment Delete

Description: Used to check if an Environment can be deleted.

Syntax:

PowerPlatformforAdmins.ValidateDelete (string environment, [advanced][Optional]string api-version)

Parameters:

Name

Type

Summary

Required

Related Action

environment

string

(Environment)

Name of the Environment.

True

Get-AdminEnvironment

api-version

string

(API Version)

The date value of the API.

False

Returns:

Type:ValidateDeleteResponse

NewEnvironmentPolicy

Summary: Create Environment DLP Policy

Description: Creates an Environment DLP Policy.

Syntax:

PowerPlatformforAdmins.NewEnvironmentPolicy ([advanced][Optional]string api-version, string environment, ManagedEnvironmentPolicy body)

Parameters:

Name	Type	Summary	Required	Related Action
api-version	string (API Version)	The date value of the API.	False
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
body	ManagedEnvironmentPolicy		True

Returns:

Type:Policy

GetEnvironmentPolicy

Summary: Get Environment DLP Policy

Description: Returns an Environment DLP Policy.

Syntax:

PowerPlatformforAdmins.GetEnvironmentPolicy (string environment, string policy, [advanced][Optional]string api-version)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
policy	string (Policy)	The name field of the Policy.	True	Get-AdminDlpPolicies
api-version	string (API Version)	The date value of the API.	False

Returns:

Type:Policy

EditEnvironmentPolicy

Summary: Update Environment DLP Policy

Description: Updates an Environment DLP Policy.

Syntax:

PowerPlatformforAdmins.EditEnvironmentPolicy (string environment, string policy, [advanced][Optional]string api-version, ManagedEnvironmentPolicy body)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
policy	string (Policy)	The name field of the Policy.	True	Get-AdminDlpPolicies
api-version	string (API Version)	The date value of the API.	False
body	ManagedEnvironmentPolicy		True

Returns:

Type:Policy

RemoveEnvironmentPolicy

Summary: Delete Environment DLP Policy

Description: Deletes an Environment DLP Policy.

Syntax:

PowerPlatformforAdmins.RemoveEnvironmentPolicy (string environment, string policy, [advanced][Optional]string api-version)

Parameters:

Name	Type	Summary	Required	Related Action
environment	string (Environment)	Name of the Environment.	True	Get-AdminEnvironment
policy	string (Policy)	The name field of the Policy.	True	Get-AdminDlpPolicies
api-version	string (API Version)	The date value of the API.	False

Returns:

Type:RemoveEnvironmentPolicyResponse

ListPoliciesV2

Summary: List DLP Policies V2

Description: Returns an list of all DLP policies the account can access.

Syntax:

PowerPlatformforAdmins.ListPoliciesV2 ()

Returns:

Type:ResourceArray[PolicyV2]

CreatePolicyV2

Summary: Create DLP Policy V2

Description: Creates a new DLP policy.

Syntax:

PowerPlatformforAdmins.CreatePolicyV2 ([Optional]ManagedPolicyV2 body)

Parameters:

Name

Type

Summary

Required

Related Action

body

ManagedPolicyV2

False

Returns:

Type:PolicyV2

GetPolicyV2

Summary: Get DLP Policy V2

Description: Returns a DLP Policy.

Syntax:

PowerPlatformforAdmins.GetPolicyV2 (string policy)

Parameters:

Name

Type

Summary

Required

Related Action

policy

string

(Policy)

The name field of the Policy.

True

Get-AdminDlpPolicies

Returns:

Type:PolicyV2

UpdatePolicyV2

Summary: Update DLP Policy V2

Description: Updates a DLP Policy.

Syntax:

PowerPlatformforAdmins.UpdatePolicyV2 (string policy, [advanced][Optional]string api-version, ManagedPolicyV2 body)

Parameters:

Name	Type	Summary	Required	Related Action
policy	string (Policy)	The name field of the Policy.	True	Get-AdminDlpPolicies
api-version	string (API Version)	The date value of the API.	False
body	ManagedPolicyV2		True

Returns:

Type:PolicyV2

DeletePolicyV2

Summary: Delete DLP Policy V2

Description: Deletes a DLP Policy.

Syntax:

PowerPlatformforAdmins.DeletePolicyV2 (string policy)

Parameters:

Name

Type

Summary

Required

Related Action

policy

string

(Policy)

The name field of the Policy.

True

Get-AdminDlpPolicies

Returns:

Type:DeletePolicyV2Response

Currencies

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (ValueItem)

ValueItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string Currency ID	Currency ID.
name	string Currency name	Currency name.
properties	Properties

Properties

Summary:

Description:

Properties:

Name	Type	Summary
localeId	integer Locale ID	Locale ID of the currency.
localizedName	string Localized Name	Localized name of the currency.
displayName	string Display Name	Currency display name.

DeletePolicyV2Response

Summary:

Description:

Properties:

Name

Type

Summary

Environment

Summary:

Description: Environment object.

Properties:

Name	Type	Summary
id	string ID	Environment ID field.
type	string Type	Environment type field.
name	string Name	Environment name field.
location	string Location	Environment location field.
properties	Properties	Environment properties object.

Properties

Summary:

Description: Environment properties object.

Properties:

Name	Type	Summary
azureRegionHint	string	Environment azureRegionHint field.
displayName	string	Display Name of Environment.
createdTime	string(date-time)	Created Time of Environment.
createdBy	Principal[CreatedBy] Created by	Policy created by principal object.
lastModifiedTime	string(date-time)	Environment lastModified date and time.
lastModifiedBy	Principal[ModifiedBy] Modified by	Policy modified by principal object.
provisioningState	string	Environment provisioningState.
capacity	array of (CapacityItem)
creationType	string	Creation Type of Environment.
environmentSku	string	Sku ID of Environment.
environmentType	string	Type of Environment.
isDefault	boolean	Is Default Environment or not.
runtimeEndpoints	RuntimeEndpoints	Environment runtimeEndpoints object.
softDeletedTime	string(date-time)	Environment softDeletedTime.
linkedEnvironmentMetadata	LinkedEnvironmentMetadata	Environment linkedEnvironmentMetadata object.

CapacityItem

Summary:

Description:

Properties:

Name	Type	Summary
capacityType	string
actualConsumption	integer
ratedConsumption	integer
capacityUnit	string
updatedOn	string

RuntimeEndpoints

Summary:

Description: Environment runtimeEndpoints object.

Properties:

Name	Type	Summary
microsoft.BusinessAppPlatform	string	BusinessAppPlatform runtime endpoint.
microsoft.CommonDataModel	string	CommonDataModel runtime endpoint.
microsoft.PowerApps	string	PowerApps runtime endpoint.
microsoft.Flow	string	Flow runtime endpoint.

LinkedEnvironmentMetadata

Summary:

Description: Environment linkedEnvironmentMetadata object.

Properties:

Name	Type	Summary
type	string	Environment linkedEnvironmentMetadata type.
resourceId	string	Environment linkedEnvironmentMetadata resourceId.
friendlyName	string	Environment linkedEnvironmentMetadata friendlyName.
uniqueName	string	Environment linkedEnvironmentMetadata uniqueName.
domainName	string	Environment linkedEnvironmentMetadata domainName.
version	string	Environment linkedEnvironmentMetadata version.
instanceUrl	string	Environment linkedEnvironmentMetadata instanceUrl.
instanceApiUrl	string	Environment linkedEnvironmentMetadata instanceApiUrl.
baseLanguage	integer(int32)	Environment linkedEnvironmentMetadata baseLanguage.
instanceState	string	Environment linkedEnvironmentMetadata instanceState.
createdTime	string(date-time)	Environment linkedEnvironmentMetadata createdTime.
modifiedTime	string(date-time)	Environment linkedEnvironmentMetadata modifiedTime.
hostNameSuffix	string	Environment linkedEnvironmentMetadata hostNameSuffix.
bapSolutionId	string	Environment linkedEnvironmentMetadata bapSolutionId.
creationTemplates	array of (string)	Environment linkedEnvironmentMetadata creationTemplates.
managementPackageVersion	string	Environment linkedEnvironmentMetadata managementPackageVersion.

Languages

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (ValueItem)

ValueItem

Summary: Language

Description: Language object.

Properties:

Name	Type	Summary
name	string Language Name	Language name field.
id	string Language ID	Language ID field.
type	string Language Type	Language type field.
properties	Properties

Properties

Summary:

Description:

Properties:

Name	Type	Summary
localeId	integer Locale ID	Language locale ID field.
localizedName	string Localized Name	Language localized name field.
displayName	string Language Display Name	Language display name field.
isTenantDefault	boolean Is Tenant Default	Language is tenant default field.

Locations

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (ValueItem)

ValueItem

Summary: Location

Description: Location object.

Properties:

Name	Type	Summary
id	string Location ID	Location ID.
name	string Location Name	Location Name.
properties	Properties

Properties

Summary:

Description:

Properties:

Name	Type	Summary
displayName	string Display Name	Location display name.
isDefault	boolean Is Default	Is the default location.
isDisabled	boolean Is Disabled	Location is Disabled.

ManagedEnvironmentPolicy

Summary:

Description:

Properties:

Name

Type

Summary

type

string

Policy Type

Api Policy type field.

properties

Properties

Summary:

Description:

Properties:

Name

Type

Summary

displayName

string

Display Name

Api Policy display name.

definition

Definition

Summary:

Description:

Properties:

Name	Type	Summary
$schema	string Schema Version	Api Policy definition $schema. Values: [https://schema.management.azure.com/providers/Microsoft.BusinessAppPlatform/schemas/2016-10-01-preview/apiPolicyDefinition.json#, https://schema.management.azure.com/providers/Microsoft.BusinessAppPlatform/schemas/2018-11-01/apiPolicyDefinition.json#]
constraints	Constraints
apiGroups	PolicyApiGroups
defaultApiGroup	string Default Group	Group a new connector is automatically added to. Values: [hbi, lbi]
rules	PolicyRules	Policy rules object.

Constraints

Summary:

Description:

Properties:

Name

Type

Summary

environmentFilter1

EnvironmentFilter1

Summary:

Description:

Properties:

Name

Type

Summary

type

string

Api Policy environmentFilter type. Values: [environmentFilter]

parameters

Parameters

Summary:

Description:

Properties:

Name

Type

Summary

environments

array of (EnvironmentsItem)

Environments

Policy Environment.

filterType

string

Filter Type

Api Policy constraint environmentFilter1 parameter filterType. Values: [include, exclude]

EnvironmentsItem

Summary: Environment

Description:

Properties:

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

ManagedPolicyV2

Summary:

Description:

Properties:

Name	Type	Summary
displayName	string Display name
defaultConnectorsClassification	string Default connectors classification	Values: [Confidential, General, Blocked]
connectorGroups	array of (ConnectorGroupsItem)
environmentType	string Policy environment type	Values: [AllEnvironments, OnlyEnvironments, ExceptEnvironments, SingleEnvironment]
environments	array of (EnvironmentsItem)

ConnectorGroupsItem

Summary:

Description:

Properties:

Name

Type

Summary

classification

string

connectors

array of (ConnectorsItem)

ConnectorsItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string
type	string
name	string

EnvironmentsItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string
type	string
name	string

ManagedTenantPolicy

Summary:

Description:

Properties:

Name	Type	Summary
type	string	Api Policy type field.
name	string Policy Name	Policy name field (optional).
id	string Policy ID	Api Policy type field.
properties	Properties

Properties

Summary:

Description:

Properties:

Name

Type

Summary

displayName

string

Display Name

Api Policy display name.

definition

Definition

Summary:

Description:

Properties:

Name	Type	Summary
$schema	string Schema Version	Api Policy definition $schema. Values: [https://schema.management.azure.com/providers/Microsoft.BusinessAppPlatform/schemas/2016-10-01-preview/apiPolicyDefinition.json#, https://schema.management.azure.com/providers/Microsoft.BusinessAppPlatform/schemas/2018-11-01/apiPolicyDefinition.json#]
constraints	Constraints
apiGroups	PolicyApiGroups
defaultApiGroup	string Default Group	Group a new connector is automatically added to. Values: [hbi, lbi]
rules	PolicyRules	Policy rules object.

Constraints

Summary:

Description:

Properties:

Name

Type

Summary

environmentFilter1

EnvironmentFilter1

Environment Filter

EnvironmentFilter1

Summary: Environment Filter

Description:

Properties:

Name

Type

Summary

type

string

Constraint Type

Policy constraint type, leave blank to apply policy to all Environments. Values: [environmentFilter]

parameters

Parameters

Summary:

Description:

Properties:

Name

Type

Summary

environments

array of (EnvironmentsItem)

Environments

Policy Environment.

filterType

string

Environment Filter Type

Api Policy constraint environmentFilter1 parameter filterType. Values: [include, exclude]

EnvironmentsItem

Summary: Environment

Description:

Properties:

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

ManageRoleAssignment

Summary:

Description:

Properties:

Name

Type

Summary

add

array of (AddItem)

add.

remove

array of (RemoveItem)

remove.

AddItem

Summary:

Description:

Properties:

Name

Type

Summary

properties

Properties

properties.

Properties

Summary:

Description: properties.

Properties:

Name

Type

Summary

principal

Principal

principal

roleDefinition

RoleDefinition

roleDefinition.

Principal

Summary:

Description: principal

Properties:

Name	Type	Summary
email	string	The principal email of the user.
tenantId	string	The principal tenant ID of the user.
id	string	The principal object ID of the user.
type	string	The principal type of the user.

RoleDefinition

Summary:

Description: roleDefinition.

Properties:

Name

Type

Summary

string

The role definition ID. Format: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}.

RemoveItem

Summary:

Description:

Properties:

Name

Type

Summary

string

The id field.

NewAdminEnvironmentParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

location

string

Location

Region the Environment is deployed in.

properties

Properties

Summary:

Description:

Properties:

Name

Type

Summary

displayName

string

Display Name

Vanity name of the Environment.

environmentSku

string

Environment Sku

Type of Environment. Values: [Production, Sandbox, Trial]

Policy

Summary:

Description:

Properties:

Name	Type	Summary
id	string Policy ID	Policy ID field.
type	string Policy Type	Policy type field.
name	string Policy Name	Policy name field.
properties	Properties	Api Policy properties object.

Properties

Summary:

Description: Api Policy properties object.

Properties:

Name	Type	Summary
displayName	string Display Name	Api Policy display name.
createdTime	string(date-time) Created time	Api Policy created time.
createdBy	Principal[CreatedBy] Created by	Policy created by principal object.
lastModifiedTime	string(date-time) Modified time	Api Policy modified time.
lastModifiedBy	Principal[ModifiedBy] Modified by	Policy modified by principal object.
definition	Definition	Api Policy definition object.

Definition

Summary:

Description: Api Policy definition object.

Properties:

Name	Type	Summary
$schema	string Schema Version	Api Policy definition $schema. Values: [https://schema.management.azure.com/providers/Microsoft.BusinessAppPlatform/schemas/2016-10-01-preview/apiPolicyDefinition.json#, https://schema.management.azure.com/providers/Microsoft.BusinessAppPlatform/schemas/2018-11-01/apiPolicyDefinition.json#]
constraints	Constraints Policy contstraints	Policy constraints object.
apiGroups	PolicyApiGroups
defaultApiGroup	string Default Group	Group a new connector is automatically added to. Values: [hbi, lbi]
rules	PolicyRules	Policy rules object.

Constraints

Summary: Policy contstraints

Description: Policy constraints object.

Properties:

Name

Type

Summary

environmentFilter1

EnvironmentFilter1

Policy Environment filter

Policy constraint environmentFilter object.

EnvironmentFilter1

Summary: Policy Environment filter

Description: Policy constraint environmentFilter object.

Properties:

Name

Type

Summary

type

string

Constraint type

Policy environmentFilter type.

parameters

Parameters

Constraint parameters

Constraints parameters object.

Parameters

Summary: Constraint parameters

Description: Constraints parameters object.

Properties:

Name

Type

Summary

environments

array of (EnvironmentsItem)

Environments

Policy Environment.

filterType

string

Environment filter type

Api Policy constraint environmentFilter1 parameter filterType.

EnvironmentsItem

Summary: Environment

Description:

Properties:

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

PolicyApiGroups

Summary:

Description:

Properties:

Name

Type

Summary

hbi

PolicyHbi

Policy Hbi group.

lbi

PolicyLbi

PolicyHbi

Summary:

Description: Policy Hbi group.

Properties:

Name

Type

Summary

description

string

Business Data description

Policy business data group description.

apis

array of (ApisItem)

Business Data

Business Data APIs.

ApisItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string Connector ID	Business Data connector ID field.
name	string Connector Name	Business Data connector name field.
type	string Connector Type	Business Data connector type field.

PolicyLbi

Summary:

Description:

Properties:

Name

Type

Summary

description

string

Policy non business data group description.

apis

array of (ApisItem)

Non Business Data

Non Business Data APIs.

ApisItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string Connector ID	Non Business Data connector ID field.
name	string Connector Name	Non Business Data connector name field.
type	string Connector Type	Non Business Data connector type field.

PolicyRules

Summary:

Description: Policy rules object.

Properties:

Name

Type

Summary

dataFlowRule

DataFlowRule

Policy rule dataFlowRule object.

apiGroupRule

ApiGroupRule

Policy rule apiGroupRule object.

DataFlowRule

Summary:

Description: Policy rule dataFlowRule object.

Properties:

Name	Type	Summary
type	string	Policy rule dataFlowRule type.
parameters	Parameters	Api Policy rule dataFlowRule parameters object.
actions	Actions	Policy rule dataFlowRule actions object.

Parameters

Summary:

Description: Api Policy rule dataFlowRule parameters object.

Properties:

Name

Type

Summary

sourceApiGroup

string

Policy rule dataFlowRule parameter sourceApiGroup.

destinationApiGroup

string

Policy rule dataFlowRule parameter destinationApiGroup.

Actions

Summary:

Description: Policy rule dataFlowRule actions object.

Properties:

Name

Type

Summary

blockAction

BlockAction

Policy rule dataFlowRule action blockAction object.

BlockAction

Summary:

Description: Policy rule dataFlowRule action blockAction object.

Properties:

Name

Type

Summary

type

string

Policy rule dataFlowRule action blockAction type.

ApiGroupRule

Summary:

Description: Policy rule apiGroupRule object.

Properties:

Name	Type	Summary
type	string	Policy rule apiGroupRule type.
parameters	Parameters	Api Policy rule apiGroupRule parameters object.
actions	Actions	Policy rule apiGroupRule actions object.

Parameters

Summary:

Description: Api Policy rule apiGroupRule parameters object.

Properties:

Name

Type

Summary

apiGroup

string

Policy rule apiGroupRule parameter apiGroup.

Actions

Summary:

Description: Policy rule apiGroupRule actions object.

Properties:

Name

Type

Summary

blockAction

BlockAction

Policy rule apiGroupRule action blockAction object.

BlockAction

Summary:

Description: Policy rule apiGroupRule action blockAction object.

Properties:

Name

Type

Summary

type

string

Block Action Type

Block action type, leave blank if adding a block is not desired. Values: [Block]

PolicyV2

Summary:

Description:

Properties:

Name	Type	Summary
name	string
displayName	string
defaultConnectorsClassification	string
connectorGroups	array of (ConnectorGroupsItem)
environmentType	string
environments	array of (EnvironmentsItem)
createdBy	CreatedBy
createdTime	string
lastModifiedBy	LastModifiedBy
lastModifiedTime	string
isLegacySchemaVersion	boolean

ConnectorGroupsItem

Summary:

Description:

Properties:

Name

Type

Summary

classification

string

connectors

array of (ConnectorsItem)

ConnectorsItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string
name	string
type	string

EnvironmentsItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string
type	string
name	string

CreatedBy

Summary:

Description:

Properties:

Name

Type

Summary

displayName

string

LastModifiedBy

Summary:

Description:

Properties:

Name

Type

Summary

displayName

string

Principal[CreatedBy]

Summary: Created by

Description: Policy created by principal object.

Properties:

Name	Type	Summary
id	string Created by user ID	Api Policy creator principal object ID.
displayName	string Created by display name	Api Policy creator principal displayName.
email	string Created by email	Api Policy creator principal email.
type	string Created by type	Api Policy creator principal type.
tenantId	string Created by tenant ID	Api Policy creator principal tenant ID.
userPrincipalName	string Created by UPN	Api Policy creator userPrincipalName.

Principal[ModifiedBy]

Summary: Modified by

Description: Policy modified by principal object.

Properties:

Name	Type	Summary
id	string Modified by ID	Modified by principal object ID.
displayName	string Modified by display name	Modified by principal displayName.
email	string Modified by email	Modified by principal.
type	string Modified by type	Modified by principal type.
tenantId	string Modified by tenant ID	Modified by principal tenant ID.
userPrincipalName	string Modified by UPN	Modified by userPrincipalName.

ProvisionInstanceParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
baseLanguage	integer Base language	Any language returned from List Environment Languages.
currency	Currency
templates	array of (string) Templates	Validated list of CRM templates to pass to the provision call.

Currency

Summary:

Description:

Properties:

Name

Type

Summary

code

string

Currency code

Any currency code returned from List Environment Currencies.

RemoveEnvironmentPolicyResponse

Summary:

Description:

Properties:

Name

Type

Summary

RemoveTenantPolicyResponse

Summary:

Description:

Properties:

Name

Type

Summary

ResourceArray[Environment]

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (Environment)

Environment value object array.

nextLink

string

The URL to get the next page of the Environments list.

ResourceArray[PolicyV2]

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (PolicyV2)

ResourceArray[Policy]

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (Policy)

ResourceArray[RoleAssignment]

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (ValueItem)

Environment Role Assignment value object array.

ValueItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string	Environment Role Assignment ID field.
type	string	Environment Role Assignment type field.
name	string	Environment Role Assignment field name.
properties	Properties	Environment Role Assignment properties object.

Properties

Summary:

Description: Environment Role Assignment properties object.

Properties:

Name	Type	Summary
scope	string	Environment Role Assignment scope.
roleDefinition	RoleDefinition	Environment Role Assignment roleDefinition object.
principal	Principal	Environment Role Assignment principal object.

RoleDefinition

Summary:

Description: Environment Role Assignment roleDefinition object.

Properties:

Name	Type	Summary
id	string	Environment Role Assignment roleDefinition ID field.
type	string	Environment Role Assignment roleDefinition type field.
name	string	Environment Role Assignment roleDefinition field name.

Principal

Summary:

Description: Environment Role Assignment principal object.

Properties:

Name	Type	Summary
id	string	Environment Role Assignment principal object ID.
displayName	string	Environment Role Assignment principal displayName.
email	string	Environment Role Assignment principal email.
type	string	Environment Role Assignment principal type.

RoleAssignment

Summary:

Description:

Properties:

Name

Type

Summary

add

array of (AddItem)

Environment Role Assignment add object.

AddItem

Summary:

Description:

Properties:

Name

Type

Summary

roleAssignment

RoleAssignment

Environment Role Assignment roleAssignment object.

httpStatus

string

Environment Role Assignment httpStatus.

RoleAssignment

Summary:

Description: Environment Role Assignment roleAssignment object.

Properties:

Name	Type	Summary
id	string	Environment Role Assignment roleAssignment ID field.
type	string	Environment Role Assignment roleAssignment type field.
name	string	Environment Role Assignment roleAssignment name field.
properties	Properties	Environment Role Assignment roleAssignment properties object.

Properties

Summary:

Description: Environment Role Assignment roleAssignment properties object.

Properties:

Name	Type	Summary
scope	string	Environment Role Assignment scope.
roleDefinition	RoleDefinition	Environment Role Assignment roleDefinition object.
principal	Principal	Environment Role Assignment principal object.

RoleDefinition

Summary:

Description: Environment Role Assignment roleDefinition object.

Properties:

Name	Type	Summary
id	string	Environment Role Assignment roleDefinition ID field.
type	string	Environment Role Assignment roleDefinition ID field.
name	string	Environment Role Assignment roleDefinition name field.

Principal

Summary:

Description: Environment Role Assignment principal object.

Properties:

Name	Type	Summary
id	string	Environment Role Assignment principal object ID.
displayName	string	Environment Role Assignment principal displayName.
email	string	Environment Role Assignment principal email.
type	string	Environment Role Assignment principal type.

UserIdentity

Summary:

Description:

Properties:

Name

Type

Summary

ObjectId

string

User object Id.

ValidateDeleteResponse

Summary:

Description:

Properties:

Name	Type	Summary
canInitiateDelete	boolean Can Delete	Environment can be deleted.
errors	array of (ErrorsItem) Errors	Errors array
resourcesToBeDeleted	array of (ResourcesToBeDeletedItem)

ErrorsItem

Summary:

Description:

Properties:

Name

Type

Summary

error

Error

Error object.

Error

Summary: Error

Description: Error object.

Properties:

Name

Type

Summary

code

string

Error code

Error code for validate delete.

message

string

Error message

Error message.

ResourcesToBeDeletedItem

Summary: Resource

Description: Resource to be deleted.

Properties:

Name	Type	Summary
id	string Resource ID	Resource to be deleted ID.
name	string Resource Name	Resource to be deleted name.
type	string Resource Type	Resource to be deleted type.