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 |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Created by |
|
Modified by |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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]
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.
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:Environment
Description: Environment object.
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:Environment
Description: Environment object.
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:ResourceArray[RoleAssignment]
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
|
body |
|
|
False |
Returns:
Type:RoleAssignment
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:
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 |
|
|
False |
Returns:
Type:Policy
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
|
body |
|
|
False |
Returns:
Type:Policy
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:Policy
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:RemoveTenantPolicyResponse
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
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:Languages
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:Currencies
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 |
|
body |
ProvisionInstanceParameterBody
|
|
False |
Returns:
Type:Environment
Description: Environment object.
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 |
|
operationName |
string (Operation) |
Name of the Operation. |
True |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
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 |
|
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:
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 |
|
operationName |
string (Operation) |
Name of the Operation. |
True |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
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 |
|
body |
|
|
True |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
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 |
|
body |
|
|
True |
Returns:
Type:Policy
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 |
|
policy |
string (Policy) |
The name field of the Policy. |
True |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:Policy
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 |
|
policy |
string (Policy) |
The name field of the Policy. |
True |
|
api-version |
string (API Version) |
The date value of the API. |
False |
|
body |
|
|
True |
Returns:
Type:Policy
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 |
|
policy |
string (Policy) |
The name field of the Policy. |
True |
|
api-version |
string (API Version) |
The date value of the API. |
False |
Returns:
Type:RemoveEnvironmentPolicyResponse
Summary: List DLP Policies V2
Description: Returns an list of all DLP policies the account can access.
Syntax:
PowerPlatformforAdmins.ListPoliciesV2 ()
Returns:
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 |
|
|
False |
Returns:
Type:PolicyV2
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 |
Returns:
Type:PolicyV2
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 |
|
api-version |
string (API Version) |
The date value of the API. |
False |
|
body |
|
|
True |
Returns:
Type:PolicyV2
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 |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Currency ID |
Currency ID. |
name |
string Currency name |
Currency name. |
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
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 |
|
Environment properties object. |
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 |
Created by |
Policy created by principal object. |
lastModifiedTime |
string(date-time)
|
Environment lastModified date and time. |
lastModifiedBy |
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 |
|
Environment runtimeEndpoints object. |
softDeletedTime |
string(date-time)
|
Environment softDeletedTime. |
linkedEnvironmentMetadata |
|
Environment linkedEnvironmentMetadata object. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
capacityType |
string
|
|
actualConsumption |
integer
|
|
ratedConsumption |
integer
|
|
capacityUnit |
string
|
|
updatedOn |
string
|
|
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. |
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (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 |
|
|
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
|
Summary: Location
Description: Location object.
Properties:
Name |
Type |
Summary |
id |
string Location ID |
Location ID. |
name |
string Location Name |
Location Name. |
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string Policy Type |
Api Policy type field. |
properties |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Api Policy display name. |
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 |
|
|
apiGroups |
|
|
defaultApiGroup |
string Default Group |
Group a new connector is automatically added to. Values: [hbi, lbi] |
rules |
|
Policy rules object. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
environmentFilter1 |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string
|
Api Policy environmentFilter type. Values: [environmentFilter] |
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] |
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. |
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)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
classification |
string
|
|
connectors |
array of (ConnectorsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
type |
string
|
|
name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
type |
string
|
|
name |
string
|
|
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 |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string Display Name |
Api Policy display name. |
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 |
|
|
apiGroups |
|
|
defaultApiGroup |
string Default Group |
Group a new connector is automatically added to. Values: [hbi, lbi] |
rules |
|
Policy rules object. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
environmentFilter1 |
Environment Filter |
|
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 |
|
|
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] |
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
add |
array of (AddItem)
|
add. |
remove |
array of (RemoveItem)
|
remove. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
properties |
|
properties. |
Summary:
Description: properties.
Properties:
Name |
Type |
Summary |
principal |
|
principal |
roleDefinition |
|
roleDefinition. |
Summary:
Description: principal
Properties:
Name |
Type |
Summary |
|
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. |
Summary:
Description: roleDefinition.
Properties:
Name |
Type |
Summary |
id |
string
|
The role definition ID. Format: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
The id field. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
location |
string Location |
Region the Environment is deployed in. |
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] |
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 |
|
Api Policy properties object. |
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 |
Created by |
Policy created by principal object. |
lastModifiedTime |
string(date-time) Modified time |
Api Policy modified time. |
lastModifiedBy |
Modified by |
Policy modified by principal object. |
definition |
|
Api Policy definition object. |
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 |
Policy contstraints |
Policy constraints object. |
apiGroups |
|
|
defaultApiGroup |
string Default Group |
Group a new connector is automatically added to. Values: [hbi, lbi] |
rules |
|
Policy rules object. |
Summary: Policy contstraints
Description: Policy constraints object.
Properties:
Name |
Type |
Summary |
environmentFilter1 |
Policy Environment filter |
Policy constraint environmentFilter object. |
Summary: Policy Environment filter
Description: Policy constraint environmentFilter object.
Properties:
Name |
Type |
Summary |
type |
string Constraint type |
Policy environmentFilter type. |
parameters |
Constraint parameters |
Constraints parameters object. |
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. |
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
hbi |
|
Policy Hbi group. |
lbi |
|
|
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. |
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. |
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. |
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. |
Summary:
Description: Policy rules object.
Properties:
Name |
Type |
Summary |
dataFlowRule |
|
Policy rule dataFlowRule object. |
apiGroupRule |
|
Policy rule apiGroupRule object. |
Summary:
Description: Policy rule dataFlowRule object.
Properties:
Name |
Type |
Summary |
type |
string
|
Policy rule dataFlowRule type. |
parameters |
|
Api Policy rule dataFlowRule parameters object. |
actions |
|
Policy rule dataFlowRule actions object. |
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. |
Summary:
Description: Policy rule dataFlowRule actions object.
Properties:
Name |
Type |
Summary |
blockAction |
|
Policy rule dataFlowRule action blockAction object. |
Summary:
Description: Policy rule dataFlowRule action blockAction object.
Properties:
Name |
Type |
Summary |
type |
string
|
Policy rule dataFlowRule action blockAction type. |
Summary:
Description: Policy rule apiGroupRule object.
Properties:
Name |
Type |
Summary |
type |
string
|
Policy rule apiGroupRule type. |
parameters |
|
Api Policy rule apiGroupRule parameters object. |
actions |
|
Policy rule apiGroupRule actions object. |
Summary:
Description: Api Policy rule apiGroupRule parameters object.
Properties:
Name |
Type |
Summary |
apiGroup |
string
|
Policy rule apiGroupRule parameter apiGroup. |
Summary:
Description: Policy rule apiGroupRule actions object.
Properties:
Name |
Type |
Summary |
blockAction |
|
Policy rule apiGroupRule action blockAction object. |
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] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
displayName |
string
|
|
defaultConnectorsClassification |
string
|
|
connectorGroups |
array of (ConnectorGroupsItem)
|
|
environmentType |
string
|
|
environments |
array of (EnvironmentsItem)
|
|
createdBy |
|
|
createdTime |
string
|
|
lastModifiedBy |
|
|
lastModifiedTime |
string
|
|
isLegacySchemaVersion |
boolean
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
classification |
string
|
|
connectors |
array of (ConnectorsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
name |
string
|
|
type |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
type |
string
|
|
name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
displayName |
string
|
|
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. |
|
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. |
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. |
|
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
baseLanguage |
integer Base language |
Any language returned from List Environment Languages. |
currency |
|
|
templates |
array of (string) Templates |
Validated list of CRM templates to pass to the provision call. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
code |
string Currency code |
Any currency code returned from List Environment Currencies. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
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. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (PolicyV2)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (Policy)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
array of (ValueItem)
|
Environment Role Assignment value object array. |
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 |
|
Environment Role Assignment properties object. |
Summary:
Description: Environment Role Assignment properties object.
Properties:
Name |
Type |
Summary |
scope |
string
|
Environment Role Assignment scope. |
roleDefinition |
|
Environment Role Assignment roleDefinition object. |
principal |
|
Environment Role Assignment principal object. |
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. |
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. |
|
string
|
Environment Role Assignment principal email. |
type |
string
|
Environment Role Assignment principal type. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
add |
array of (AddItem)
|
Environment Role Assignment add object. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
roleAssignment |
|
Environment Role Assignment roleAssignment object. |
httpStatus |
string
|
Environment Role Assignment httpStatus. |
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 |
|
Environment Role Assignment roleAssignment properties object. |
Summary:
Description: Environment Role Assignment roleAssignment properties object.
Properties:
Name |
Type |
Summary |
scope |
string
|
Environment Role Assignment scope. |
roleDefinition |
|
Environment Role Assignment roleDefinition object. |
principal |
|
Environment Role Assignment principal object. |
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. |
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. |
|
string
|
Environment Role Assignment principal email. |
type |
string
|
Environment Role Assignment principal type. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
ObjectId |
string
|
User object Id. |
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)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
error |
Error |
Error object. |
Summary: Error
Description: Error object.
Properties:
Name |
Type |
Summary |
code |
string Error code |
Error code for validate delete. |
message |
string Error message |
Error message. |
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. |