Power Platform for Admins V2

Unified connector for all administrative capabilities in Microsoft Power Platform

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Standard	All Power Automate regions
Logic Apps	Standard	All Logic Apps regions
Power Apps	Standard	All Power Apps regions
Power Automate	Standard	All Power Automate regions

Contact
Name	Microsoft Support
URL	https://admin.powerplatform.microsoft.com/support
Email	support@microsoft.com

Connector Metadata
Publisher	Microsoft
Website	https://admin.powerplatform.com
Privacy policy	https://admin.powerplatform.com/privacy
Categories	IT Operations

Power Platform for Admins V2

The Power Platform for Admins V2 connector is the next evolution in admin and control plane management for Power Platform customers. Leveraging all of the capabilities available from Microsoft Power Platform API, this connector will be routinely refreshed to have the latest and greatest capabilities from Power Platform admin center.

Note

This connector is currently in Public Preview until the underlying Power Platform API becomes generally available.

Service Principal authentication

Service Principal authentication is supported for most actions, however it does require additional setup before you make the connection using this connector. For more information, visit Creating a service principal application using PowerShell.

Known issues and limitations

Service Principal authentication is not supported when creating Billing Policies. You will need to use OAuth connections for these actions.
Some actions like Recommendations require Managed Environments to be enabled for at least one environment in your tenant.

Creating a connection

The connector supports the following authentication types:


OAuth Connection	OAuth Connection	All regions	Not shareable
Service Principal Connection	Service Principal Connection	All regions	Shareable
Default [DEPRECATED]	This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.	All regions	Not shareable

OAuth Connection

Auth ID: oauth2-auth

Applicable: All regions

OAuth Connection

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Service Principal Connection

Auth ID: oAuthClientCredentials

Applicable: All regions

Service Principal Connection

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name	Type	Required
Client ID	string	True
Client Secret	securestring	True
Tenant	string	True

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add the environment to the environment group	Ability to Add the environment to the environment group.
Allocate and deallocate the currencies for the environment	Ability to Allocate and deallocate the currencies for the environment.
Apply the system administrator role	Ability for a tenant administrator to assign themselves the system administrator role within Dataverse in the environment.
Create a Power Pages website	Trigger the creation of a new website.
Create an ISV contract	Create an ISV contract.
Create environment group rule based assignment	Create new rule based policy assignment for an environment group. The input includes rule sets, inputs, and other metadata related to the policy.
Create environment management settings	Ability to Create environment management settings.
Create rule based policy	Create new rule based policy. The input includes rule sets, inputs, and other metadata related to the policy.
Create the environment group	Ability to Create the environment group.
Creates the billing policy at tenant level	Ability to Creates the billing policy at tenant level.
Delete a Power Pages website	Trigger the deletion of a website by specifying the website ID.
Delete an ISV contract	Delete an ISV contract.
Delete billing policy	Ability to Delete billing policy.
Delete the environment by ID	Delete the environment specified by ID.
Delete the environment group	Ability to Delete the environment group.
Enable web application firewall on a Power Pages website	Enable web application firewall on the given website.
Execute recommendation action	Execute a recommended action on a set of recommendation resource(s).
Generate or fetch a cross-tenant connection report	Ability to Create a request to generate a cross-tenant connection report for a tenant or return an existing report.
Get a cross-tenant connection report by report ID for a tenant	Ability to Get a cross-tenant connection report by report ID for a tenant.
Get an ISV contract by its identifier (ID)	Get an ISV contract by its identifier (ID).
Get app as administrator	Returns a PowerApp.
Get apps as administrator	Returns a list of apps.
Get currency allocations for the environment	Ability to Get currency allocations for the environment.
Get environment management setting by ID	Ability to Gets Environment Management Setting by ID. Only columns provided in the $select queryOption will be returned. A list of selectable properties is defined in the Microsoft.Dynamics.Artemis.Infrastructure.Models.EnvironmentManagementSetting typeGets environment management setting by ID. Only columns provided in the $select queryOption will be returned. A list of selectable properties is defined in the Microsoft.Dynamics.Artemis.Infrastructure.Models.EnvironmentManagementSetting type.
Get operation status	Ability to Get operation status.
Get recommendation resources	Gets the list of resources for a recommendation for the tenant.
Get recommendations	Gets the list of recommendations for the tenant.
Get rule based policy by ID	Retrieves details about a specific policy based on the policy ID. The response includes rule sets, inputs, and other metadata related to the policy.
Get the billing policy at tenant level by policy ID	Ability to Get the billing policy at tenant level by policy ID.
Get the currency report for the tenant	Ability to Get the currency report for the tenant.
Get the environment group	Ability to Get the environment group.
Get the environment linked to the billing policy	Ability to Get the environment linked to the billing policy.
Get the linked billing policy details for an environment	Ability to Get the linked billing policy details for an environment.
Get the list of application packages that are available for a tenant	Get the list of available application packages for a tenant.
Get the list of billing policies for the tenant	Ability to Get the list of billing policies for the tenant.
Get the list of environments linked to the billing policy	Ability to Get the list of environments linked to the billing policy.
Get the list of ISV contracts for the tenant	Get the list of ISV contracts for the tenant.
Get the polling status for a previously triggered installation	Get the polling status to check on the progress of a previously triggered installation based on the operation ID.
Get the Power Pages website details by specifying its unique identifier (ID)	Get website details using a specified website ID.
Get the temporary currency count and limit for the month by type	Ability to Gets the number of temporary currency entitlements that have been requested this month, and the maximum allowed per month, for the provided currency type.
Get the tenant capacity details for the tenant	Ability to Get the tenant capacity details for the tenant.
Get the web application firewall status	Get the status of web application firewall associated with the given website.
Link billing policy ID with environments	Ability to Link billing policy ID with environments.
List cross-tenant connection reports for a tenant	Ability to List cross-tenant connection reports for a tenant.
List Power Pages websites	Get a list of all the websites in your environment.
List rule based policies	List rule based policies available in the tenant.
List rule based policy assignments	Retrieves a list of rule assignments for a tenant. This operation provides details about the policy assignments, including rule sets and associated resource types.
List the available operations for an environment	Returns a list of the available operations for an environment.
List the environment groups	Ability to List the environment groups.
List the installable application packages for a target environment	Get the list of available application packages that are relevant in the context of a target environment. The client can filter the application packages based on install state (NotInstalled, Installed, All) and any other response parameters utilizing standard OData capabilities.
Refresh the billing policy provisioning status	Ability to Refresh the billing policy provisioning status.
Remove the environment from the environment group	Ability to Remove the environment from the environment group.
Restart a Power Pages website	Restart the website for the given site ID.
Retrieve a list of environments	Returns a list of environments available for the authenticated user.
Retrieve the operation by ID	Retrieve the operation specified by ID.
Retrieves a single environment by ID	Ability to Retrieves a single environment by ID.
Stamp bootstrap version five (5) status as enabled for website	Stamp bootstrap version five (5) status as enabled for website.
Stamp data model version for website	Stamp data model version for website.
Start a Power Pages website	Start the website for the given site ID.
Start the install of application package in target environment	Trigger the installation of an application package, based on the package unique name, to be installed into a target environment. The client can also include a custom payload when requesting installation of an application package.
Stop a Power Pages website	Stop the website for the given site ID.
Storage warning thresholds	Ability to Storage warning thresholds.
Storage warning thresholds filtered by category	Ability to Storage warning thresholds filtered by category.
Storage warning thresholds filtered by category and storage entity name	Ability to Storage warning thresholds filtered by category and storage entity name.
Unlink billing policy ID from environments	Ability to Unlink billing policy ID from environments.
Update an ISV contract	Update an ISV contract.
Update fields on the environment management setting	Ability to Updates fields on the EnvironmentManagementSetting. This API currently doesn't return any entity data in the response body.
Update rule based policy by ID	Updates details about a specific policy based on the policy ID. The input includes rule sets, inputs, and other metadata related to the policy.
Update security group for site visibility for a website	Update security group for site visibility for a website.
Update site visibility for a website	Update site visibility for a website.
Update the environment group	Ability to Update the environment group.
Updates the billing policy at tenant level	Ability to Updates the billing policy at tenant level.

Add the environment to the environment group

Operation ID:: AddEnvironmentToGroup

Ability to Add the environment to the environment group.

Parameters

Name	Key	Required	Type	Description
Group Id	groupId	True	uuid	The group ID.
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Allocate and deallocate the currencies for the environment

Operation ID:: PatchCurrencyAllocationByEnvironment

Ability to Allocate and deallocate the currencies for the environment.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.
currencyType	currencyType		string	Available currency type which can be allocated to environment.
allocated	allocated		integer	Specify the currency count.

Returns

The response body includes environment ID and allocated currencies.

Body: AllocationsByEnvironmentResponseModelV1

Apply the system administrator role

Operation ID:: ApplyAdminRole

Ability for a tenant administrator to assign themselves the system administrator role within Dataverse in the environment.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Create a Power Pages website

Operation ID:: CreateWebsite

Trigger the creation of a new website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.
dataverseOrganizationId	dataverseOrganizationId	True	uuid	Dataverse organization's unique identifier (ID)
name	name	True	string	Name of the website
templateName	templateName	True	string	Website template name
selectedBaseLanguage	selectedBaseLanguage	True	integer	Language unique identifier (ID) of the website - https://go.microsoft.com/fwlink/?linkid=2208135
subdomain	subdomain	True	string	Subdomain for the website URL
websiteRecordId	websiteRecordId		string	Dataverse record unique identifier (ID) of the website

Create an ISV contract

Operation ID:: CreateISVContract

Create an ISV contract.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.
name	name	True	string
status	status	True	string	The desired ISV contract status.
geo	geo	True	string	Specify the desired resource ___location for creation of an Azure Power Platform account for billing. Once set, this property cannot be updated. Power Platform environments using this ISV Contract for pay-as-you-go billing must be in the same ___location.
tenantId	tenantId		uuid	The ID of the customer tenant.
allowOtherPremiumConnectors	allowOtherPremiumConnectors		boolean	A flag indicating whether metered usage that involves premium connectors may be attributed.
name	name		string	The name of an API connector.
subscriptionId	subscriptionId		uuid	The tenant subscription Id.
resourceGroup	resourceGroup		string	The resource group within the tenant subscription.
id	id		string
cloudFlowRunsPayAsYouGoState	cloudFlowRunsPayAsYouGoState		string

Returns

Body: IsvContractResponseModel

Create environment group rule based assignment

Operation ID:: CreateEnviornmentGroupRuleBasedAssignment

Create new rule based policy assignment for an environment group. The input includes rule sets, inputs, and other metadata related to the policy.

Parameters

Name	Key	Required	Type	Description
Policy Id	policyId	True	string	The unique identifier of the policy.
Group Id	groupId	True	string	The unique identifier of the environment group.
Api-version	api-version	True	string	The API version.

Returns

Body: RuleAssignment

Create environment management settings

Operation ID:: CreateEnvironmentManagementSettings

Ability to Create environment management settings.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.
			object

Returns

Represents the response object for APIs in this service.

Body: CreateEnvironmentManagementSettingResponse

Create rule based policy

Operation ID:: CreateRuleBasedPolicy

Create new rule based policy. The input includes rule sets, inputs, and other metadata related to the policy.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.
name	name		string	The name of the policy.
id	id		string	The unique identifier of the rule set.
version	version		string	The version of the rule set.
inputs	inputs		object	The inputs for the rule set, which may vary based on the rule.

Returns

Body: RuleAssignment

Create the environment group

Operation ID:: CreateEnvironmentGroup

Ability to Create the environment group.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.
id	id		uuid
displayName	displayName		string
description	description		string
parentGroupId	parentGroupId		uuid
childrenGroupIds	childrenGroupIds		array of uuid
createdTime	createdTime		date-time
id	id		string
displayName	displayName		string
email	email		string
type	type		string
tenantId	tenantId		string
userPrincipalName	userPrincipalName		string
lastModifiedTime	lastModifiedTime		date-time
id	id		string
displayName	displayName		string
email	email		string
type	type		string
tenantId	tenantId		string
userPrincipalName	userPrincipalName		string

Returns

Body: EnvironmentGroup

Creates the billing policy at tenant level

Operation ID:: CreateBillingPolicy

Ability to Creates the billing policy at tenant level.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.
name	name		string
___location	___location		string
subscriptionId	subscriptionId		uuid	The tenant subscription Id.
resourceGroup	resourceGroup		string	The resource group within the tenant subscription.
id	id		string
status	status		string	The desired ISV contract status.

Returns

Body: BillingPolicyResponseModel

Delete a Power Pages website

Operation ID:: DeleteWebsite

Trigger the deletion of a website by specifying the website ID.

Parameters

Name	Key	Required	Type	Description
Operation- Location	Operation-Location	True	string	Operation ___location.
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Delete an ISV contract

Operation ID:: DeleteISVContract

Delete an ISV contract.

Parameters

Name	Key	Required	Type	Description
Isv Contract Id	isvContractId	True	string	The ISV contract ID.
Api-version	api-version	True	string	The API version.

Delete billing policy

Operation ID:: DeleteBillingPolicy

Ability to Delete billing policy.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.

Delete the environment by ID

Operation ID:: DeleteEnvironmentByID

Delete the environment specified by ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Validate Only	ValidateOnly		boolean	Boolean flag indicating to validate instead of executing the delete operation.
Api-version	api-version	True	string	The API version.

Delete the environment group

Operation ID:: DeleteEnvironmentGroup

Ability to Delete the environment group.

Parameters

Name	Key	Required	Type	Description
Group Id	groupId	True	string	The group ID.
Api-version	api-version	True	string	The API version.

Enable web application firewall on a Power Pages website

Operation ID:: EnableWAF

Enable web application firewall on the given website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Execute recommendation action

Operation ID:: ExecuteRecommendationAction

Execute a recommended action on a set of recommendation resource(s).

Parameters

Name	Key	Required	Type	Description
body	body	True	dynamic	Request body for the action to execute
Action Name	actionName	True	string	The name of the action to execute.
Api-version	api-version	True	string	The API version.

Returns

The response for action performed on resources

Body: AdvisorActionResponse

Generate or fetch a cross-tenant connection report

Operation ID:: CreateCrossTenantConnectionReport

Ability to Create a request to generate a cross-tenant connection report for a tenant or return an existing report.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: CrossTenantConnectionReport

Get a cross-tenant connection report by report ID for a tenant

Operation ID:: GetCrossTenantConnectionReport

Ability to Get a cross-tenant connection report by report ID for a tenant.

Parameters

Name	Key	Required	Type	Description
Report Id	reportId	True	string	The report ID.
Api-version	api-version	True	string	The API version.

Returns

Body: CrossTenantConnectionReport

Get an ISV contract by its identifier (ID)

Operation ID:: GetISVContract

Get an ISV contract by its identifier (ID).

Parameters

Name	Key	Required	Type	Description
Isv Contract Id	isvContractId	True	string	The ISV contract ID.
Api-version	api-version	True	string	The API version.

Returns

Body: IsvContractResponseModel

Get app as administrator

Operation ID:: Get-AdminApp

Returns a PowerApp.

Parameters

Name	Key	Required	Type	Description
Environment name	environmentId	True	string	Name field of the environment.
PowerApp name	app	True	string	Name field of the PowerApp.
Api-version	api-version	True	string	The API version.

Returns

Body: PowerApp

Get apps as administrator

Operation ID:: Get-AdminApps

Returns a list of apps.

Parameters

Name	Key	Required	Type	Description
Environment name	environmentId	True	string	Name field of the environment.
Page size	$top		integer	Number of apps in the response.
Skip token	$skiptoken		string	Get next page of responses.
Api-version	api-version	True	string	The API version.

Returns

Body: ResourceArrayPowerApp

Get currency allocations for the environment

Operation ID:: GetCurrencyAllocationByEnvironment

Ability to Get currency allocations for the environment.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Returns

The response body includes environment ID and allocated currencies.

Body: AllocationsByEnvironmentResponseModelV1

Get environment management setting by ID

Operation ID:: ListEnvironmentManagementSettings

Ability to Gets Environment Management Setting by ID. Only columns provided in the $select queryOption will be returned. A list of selectable properties is defined in the Microsoft.Dynamics.Artemis.Infrastructure.Models.EnvironmentManagementSetting typeGets environment management setting by ID. Only columns provided in the $select queryOption will be returned. A list of selectable properties is defined in the Microsoft.Dynamics.Artemis.Infrastructure.Models.EnvironmentManagementSetting type.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	ID for the environment management setting.
$top	$top		integer	Number of records to retrieve. If not set, five humdred (500) records are returned.
$select	$select		string	List of properties to select for this entity.
Api-version	api-version	True	string	The API version.

Returns

Represents the response object for APIs in this service.

Body: GetEnvironmentManagementSettingResponse

Get operation status

Operation ID:: GetEnvironmentGroupOperation

Ability to Get operation status.

Parameters

Name	Key	Required	Type	Description
Operation Id	operationId	True	uuid	The operation ID.
Api-version	api-version	True	string	The API version.

Get recommendation resources

Operation ID:: GetRecommendationResources

Gets the list of resources for a recommendation for the tenant.

Parameters

Name	Key	Required	Type	Description
Recommendation Name	scenario	True	string	The recommendation name.
Api-version	api-version	True	string	The API version.

Returns

Paged list of recommendation resources

Body: AdvisorRecommendationResourceIEnumerableResponseWithContinuation

Get recommendations

Operation ID:: GetRecommendations

Gets the list of recommendations for the tenant.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Paged list of recommendations

Body: AdvisorRecommendationIEnumerableResponseWithContinuation

Get rule based policy by ID

Operation ID:: GetRuleBasedPolicyByID

Retrieves details about a specific policy based on the policy ID. The response includes rule sets, inputs, and other metadata related to the policy.

Parameters

Name	Key	Required	Type	Description
Policy Id	policyId	True	string	The unique identifier of the policy.
Api-version	api-version	True	string	The API version.

Returns

Body: Policy

Get the billing policy at tenant level by policy ID

Operation ID:: GetBillingPolicy

Ability to Get the billing policy at tenant level by policy ID.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.

Returns

Body: BillingPolicyResponseModel

Get the currency report for the tenant

Operation ID:: ListCurrencyReports

Ability to Get the currency report for the tenant.

Parameters

Name	Key	Required	Type	Description
Include Allocations	includeAllocations		boolean	Flag indicating to include allocations.
Include Consumptions	includeConsumptions		boolean	Flag indicating to include consumptions.
Api-version	api-version	True	string	The API version.

Returns

response: array of CurrencyReportV2

Get the environment group

Operation ID:: GetEnvironmentGroup

Ability to Get the environment group.

Parameters

Name	Key	Required	Type	Description
Group Id	groupId	True	string	The group ID.
Api-version	api-version	True	string	The API version.

Returns

Body: EnvironmentGroup

Get the environment linked to the billing policy

Operation ID:: GetBillingPolicyEnvironment

Ability to Get the environment linked to the billing policy.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Returns

Body: BillingPolicyEnvironmentResponseModelV1

Get the linked billing policy details for an environment

Operation ID:: GetEnvironmentBillingPolicy

Ability to Get the linked billing policy details for an environment.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Returns

Body: BillingPolicyResponseModel

Get the list of application packages that are available for a tenant

Operation ID:: GetTenantApplicationPackage

Get the list of available application packages for a tenant.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: TenantApplicationPackageContinuationResponse

Get the list of billing policies for the tenant

Operation ID:: ListBillingPolicies

Ability to Get the list of billing policies for the tenant.

Parameters

Name	Key	Required	Type	Description
$top	$top		string	The ISV contract ID.
Api-version	api-version	True	string	The API version.

Returns

Body: BillingPolicyResponseModelResponseWithOdataContinuation

Get the list of environments linked to the billing policy

Operation ID:: ListBillingPolicyEnvironments

Ability to Get the list of environments linked to the billing policy.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.

Returns

Body: BillingPolicyEnvironmentResponseModelV1ResponseWithOdataContinuation

Get the list of ISV contracts for the tenant

Operation ID:: ListISVContracts

Get the list of ISV contracts for the tenant.

Parameters

Name	Key	Required	Type	Description
$top	$top		string	Top limit of results.
Api-version	api-version	True	string	The API version.

Returns

Body: IsvContractResponseModelResponseWithOdataContinuation

Get the polling status for a previously triggered installation

Operation ID:: GetApplicationPackageInstallStatus

Get the polling status to check on the progress of a previously triggered installation based on the operation ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	Environment ID (not to be confused with organization ID).
Operation Id	operationId	True	uuid	Operation ID.
Api-version	api-version	True	string	The API version.

Returns

Body: InstancePackageOperationPollingResponse

Get the Power Pages website details by specifying its unique identifier (ID)

Operation ID:: GetWebsiteById

Get website details using a specified website ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Returns

Body: WebsiteDto

Get the temporary currency count and limit for the month by type

Operation ID:: RetrieveTemporaryCurrencyEntitlementCount

Ability to Gets the number of temporary currency entitlements that have been requested this month, and the maximum allowed per month, for the provided currency type.

Parameters

Name	Key	Required	Type	Description
Currency Type	currencyType	True	string	The currency type.
Api-version	api-version	True	string	The API version.

Returns

Body: GetTemporaryCurrencyEntitlementCountResponseModel

Get the tenant capacity details for the tenant

Operation ID:: GetTenantCapacityDetails

Ability to Get the tenant capacity details for the tenant.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: TenantCapacityDetailsModel

Get the web application firewall status

Operation ID:: GetWAFStatus

Get the status of web application firewall associated with the given website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Returns

Web application firewall status

response: WebApplicationFirewallStatus

Link billing policy ID with environments

Operation ID:: AddBillingPolicyEnvironment

Ability to Link billing policy ID with environments.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.
environmentIds	environmentIds		array of string

List cross-tenant connection reports for a tenant

Operation ID:: ListCrossTenantConnectionReports

Ability to List cross-tenant connection reports for a tenant.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: CrossTenantConnectionReportsResponseWithOdataContinuation

List Power Pages websites

Operation ID:: GetWebsites

Get a list of all the websites in your environment.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Skip	skip		string	The number of items to skip before returning the remaining items.
Api-version	api-version	True	string	The API version.

Returns

Body: ODataListWebsitesDto

List rule based policies

Operation ID:: ListRuleBasedPolicies

List rule based policies available in the tenant.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: ListPolicyResponse

List rule based policy assignments

Operation ID:: ListRuleAssignments

Retrieves a list of rule assignments for a tenant. This operation provides details about the policy assignments, including rule sets and associated resource types.

Parameters

Name	Key	Required	Type	Description
Include Rule Set Counts	includeRuleSetCounts	True	boolean	Flag to include rule set counts in the response.
Api-version	api-version	True	string	The API version.

Returns

Body: RuleAssignmentsResponse

List the available operations for an environment

Operation ID:: ListOperationsForEnvironment

Returns a list of the available operations for an environment.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Limit	limit		string	String indicating to limit the results.
Continuation Token	continuationToken		string	The continuation token provided from a previous response.
Api-version	api-version	True	string	The API version.

Returns

Body: OperationExecutionResultPagedCollection

List the environment groups

Operation ID:: ListEnvironmentGroups

Ability to List the environment groups.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: EnvironmentGroupResponseWithOdataContinuation

List the installable application packages for a target environment

Operation ID:: GetEnvironmentApplicationPackage

Get the list of available application packages that are relevant in the context of a target environment. The client can filter the application packages based on install state (NotInstalled, Installed, All) and any other response parameters utilizing standard OData capabilities.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	Environment ID (not to be confused with Org ID).
App Install State	appInstallState		string	Application package install state.
Lcid	lcid		string	Application package supported language ID.
Api-version	api-version	True	string	The API version.

Returns

Body: ApplicationPackageContinuationResponse

Refresh the billing policy provisioning status

Operation ID:: RefreshProvisioningStatus

Ability to Refresh the billing policy provisioning status.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.

Returns

Body: BillingPolicyResponseModel

Remove the environment from the environment group

Operation ID:: RemoveEnvironmentFromGroup

Ability to Remove the environment from the environment group.

Parameters

Name	Key	Required	Type	Description
Group Id	groupId	True	uuid	The group ID.
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Restart a Power Pages website

Operation ID:: RestartWebsite

Restart the website for the given site ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Retrieve a list of environments

Operation ID:: ListEnvironmentsForUser

Returns a list of environments available for the authenticated user.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

Body: EnvironmentList

Retrieve the operation by ID

Operation ID:: GetOperationByID

Retrieve the operation specified by ID.

Parameters

Name	Key	Required	Type	Description
Operation Id	operationId	True	string	The operation ID.
Api-version	api-version	True	string	The API version.

Returns

Body: OperationExecutionResult

Retrieves a single environment by ID

Operation ID:: GetEnvironmentByIdForUser

Ability to Retrieves a single environment by ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Api-version	api-version	True	string	The API version.

Returns

Body: EnvironmentResponse

Stamp bootstrap version five (5) status as enabled for website

Operation ID:: SetPortalBootstrapV5Enabled

Stamp bootstrap version five (5) status as enabled for website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Stamp data model version for website

Operation ID:: SetPortalDataModelVersion

Stamp data model version for website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.
dataModelVersionValue	dataModelVersionValue	True	boolean	value of data model version for IsNewDataModel

Start a Power Pages website

Operation ID:: StartWebsite

Start the website for the given site ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Start the install of application package in target environment

Operation ID:: InstallApplicationPackage

Trigger the installation of an application package, based on the package unique name, to be installed into a target environment. The client can also include a custom payload when requesting installation of an application package.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	Environment ID (not to be confused with the organization ID).
Unique Name	uniqueName	True	string	Package unique name.
Api-version	api-version	True	string	The API version.
payloadValue	payloadValue		string

Returns

Body: InstancePackage

Stop a Power Pages website

Operation ID:: StopWebsite

Stop the website for the given site ID.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Api-version	api-version	True	string	The API version.

Storage warning thresholds

Operation ID:: ListStorageWarnings

Ability to Storage warning thresholds.

Parameters

Name	Key	Required	Type	Description
Api-version	api-version	True	string	The API version.

Returns

response: array of StorageWarningThresholdsDocument

Storage warning thresholds filtered by category

Operation ID:: GetStorageWarningByCategory

Ability to Storage warning thresholds filtered by category.

Parameters

Name	Key	Required	Type	Description
Storage Category	storageCategory	True	string	The storage category value.
Api-version	api-version	True	string	The API version.

Returns

response: array of StorageWarningThresholdsDocument

Storage warning thresholds filtered by category and storage entity name

Operation ID:: GetStorageWarningByCategoryAndEntity

Ability to Storage warning thresholds filtered by category and storage entity name.

Parameters

Name	Key	Required	Type	Description
Storage Category	storageCategory	True	string	The storage category value.
Entity Name	entityName	True	string	The name of the entity.
Api-version	api-version	True	string	The API version.

Returns

response: array of StorageWarningThresholdsDocument

Unlink billing policy ID from environments

Operation ID:: RemoveBillingPolicyEnvironment

Ability to Unlink billing policy ID from environments.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.
environmentIds	environmentIds		array of string

Update an ISV contract

Operation ID:: UpdateISVContract

Update an ISV contract.

Parameters

Name	Key	Required	Type	Description
Isv Contract Id	isvContractId	True	string	The ISV contract ID.
Api-version	api-version	True	string	The API version.
name	name		string
status	status		string	The desired ISV contract status.
allowOtherPremiumConnectors	allowOtherPremiumConnectors		boolean	A flag indicating whether metered usage that involves premium connectors may be attributed.
name	name		string	The name of an API connector.
cloudFlowRunsPayAsYouGoState	cloudFlowRunsPayAsYouGoState		string

Returns

Body: IsvContractResponseModel

Update fields on the environment management setting

Operation ID:: UpdateEnvironmentManagementSettings

Ability to Updates fields on the EnvironmentManagementSetting. This API currently doesn't return any entity data in the response body.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The ID for the environment management setting being updated.
Api-version	api-version	True	string	The API version.
			object

Returns

Represents the response object for APIs in this service.

Body: OperationResponse

Update rule based policy by ID

Operation ID:: UpdateRuleBasedPolicyByID

Updates details about a specific policy based on the policy ID. The input includes rule sets, inputs, and other metadata related to the policy.

Parameters

Name	Key	Required	Type	Description
Policy Id	policyId	True	string	The unique identifier of the policy.
Api-version	api-version	True	string	The API version.
name	name		string	The name of the policy.
id	id		string	The unique identifier of the rule set.
version	version		string	The version of the rule set.
inputs	inputs		object	The inputs for the rule set, which may vary based on the rule.

Returns

Body: RuleAssignment

Update security group for site visibility for a website

Operation ID:: updatePortalSecurityGroup

Update security group for site visibility for a website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Security Group Id	securityGroupId		string	Security group ID.
Api-version	api-version	True	string	The API version.

Update site visibility for a website

Operation ID:: updateSiteVisibility

Update site visibility for a website.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	The environment ID.
Id	id	True	string	Website unique identifier (ID).
Site Visibility	siteVisibility		string	Site visibility.
Api-version	api-version	True	string	The API version.

Update the environment group

Operation ID:: UpdateEnvironmentGroup

Ability to Update the environment group.

Parameters

Name	Key	Required	Type	Description
Group Id	groupId	True	uuid	The group ID.
Api-version	api-version	True	string	The API version.
id	id		uuid
displayName	displayName		string
description	description		string
parentGroupId	parentGroupId		uuid
childrenGroupIds	childrenGroupIds		array of uuid
createdTime	createdTime		date-time
id	id		string
displayName	displayName		string
email	email		string
type	type		string
tenantId	tenantId		string
userPrincipalName	userPrincipalName		string
lastModifiedTime	lastModifiedTime		date-time
id	id		string
displayName	displayName		string
email	email		string
type	type		string
tenantId	tenantId		string
userPrincipalName	userPrincipalName		string

Returns

Body: EnvironmentGroup

Updates the billing policy at tenant level

Operation ID:: UpdateBillingPolicy

Ability to Updates the billing policy at tenant level.

Parameters

Name	Key	Required	Type	Description
Billing Policy Id	billingPolicyId	True	string	The billing policy ID.
Api-version	api-version	True	string	The API version.
name	name		string
status	status		string	The desired ISV contract status.

Returns

Body: BillingPolicyResponseModel

Definitions

AdvisorActionResponse

The response for action performed on resources

Name	Path	Type	Description
results	results	array of AdvisorActionResult

AdvisorActionResult

The result of an action performed on a resource

Name	Path	Type	Description
Resource ID	resourceId	string	The unique ID of the resource for which the action was performed
Status Code	statusCode	integer	The status code of the action request for the given resource
Action Result	actionFinalResult	string	Final status of the action request
Error Code	errorCode	string	The error code associated with any error encountered during the action execution
Error Message	error	string	The error message associated with any error encountered during the action execution

AdvisorRecommendation

Information for a recommendation

Name	Path	Type	Description
Recommendation Name	scenario	string	The recommendation name.
details	details	AdvisorRecommendationDetails	Details for a recommendation

AdvisorRecommendationDetails

Details for a recommendation

Name	Path	Type	Description
Resource count	resourceCount	integer	The number of resources
Last refresh timestamp	lastRefreshedTimestamp	date-time	Time when the recommendation was refreshed
Expected next refresh timestamp	expectedNextRefreshTimestamp	date-time	Time when the recommendation will be refreshed again

AdvisorRecommendationIEnumerableResponseWithContinuation

Paged list of recommendations

Name	Path	Type	Description
value	value	array of AdvisorRecommendation	List of recommendations
Next link	nextLink	string	Link to get the next page of recommendations

AdvisorRecommendationResource

Details of a resource included in a recommendation

Name	Path	Type	Description
Resource display name	resourceName	string	The resource display name
Resource ID	resourceId	string	The resource unique ID
Owner ID	resourceOwnerId	string	The resource owner object ID
Owner name	resourceOwner	string	The resource owner display name
Resource type	resourceType	string	The type of resource
Resource sub type	resourceSubType	string	The sub type of the resource
Resource description	resourceDescription	string	The resource description
Resource usage	resourceUsage	double	Number of unique users who used the resource in the last thirty (30) days
Environment name	environmentName	string	The environment display name
Environment ID	environmentId	string	The environment unique ID
Last modfified date	lastModifiedDate	date-time	Time when the resource was last modified
Last used date	lastAccessedDate	date-time	Time when the resource was last used
Action Status	resourceActionStatus	string	Current status of any action taken since the last refresh time

AdvisorRecommendationResourceIEnumerableResponseWithContinuation

Paged list of recommendation resources

Name	Path	Type	Description
value	value	array of AdvisorRecommendationResource	List of recommendation resources
Next link	nextLink	string	Link to get the next page of resources

AllocationsByEnvironmentResponseModelV1

The response body includes environment ID and allocated currencies.

Name	Path	Type	Description
environmentId	environmentId	string	The environment ID for which the currency has been allocated.
currencyAllocations	currencyAllocations	array of CurrencyAllocationResponseModelV1	The collection of currencies with allocation count.

ApplicationPackage

Name	Path	Type	Description
id	id	uuid	Available package ID or instance package ID, where both map to the application package ID
uniqueName	uniqueName	string	Available package unique name or instance package unique name
version	version	string	Available package version or instance package version
localizedDescription	localizedDescription	string	Localized description for the application package
localizedName	localizedName	string	Localized name of application package
applicationId	applicationId	uuid	Application ID
applicationName	applicationName	string	Application name
applicationDescription	applicationDescription	string	Application description
singlePageApplicationUrl	singlePageApplicationUrl	string	Single Page Application (SPA) URL associated with the application
publisherName	publisherName	string	Publisher name
publisherId	publisherId	uuid	Publisher ID
learnMoreUrl	learnMoreUrl	string	Learn more URL for the application
platformMinVersion	platformMinVersion	string	Available package platform minimum version
platformMaxVersion	platformMaxVersion	string	Available package platform maximum version
customHandleUpgrade	customHandleUpgrade	boolean	Available package custom upgrade
instancePackageId	instancePackageId	uuid	Instance package ID that is used only for a retry of package installation (for example, a reinstall).
state	state	InstancePackageState	State of the instance package
catalogVisibility	catalogVisibility	CatalogVisibility	Catalog visibility for the application
applicationVisibility	applicationVisibility	ApplicationVisibility	Application visibility
lastError	lastError	ErrorDetails
startDateUtc	startDateUtc	date-time	Start date for application package
endDateUtc	endDateUtc	date-time	End date for application package
supportedCountries	supportedCountries	array of string	List of supported countries/regions for the application

ApplicationPackageContinuationResponse

Name	Path	Type	Description
value	value	array of ApplicationPackage
@odata.nextLink	@odata.nextLink	string

ApplicationVisibility

Application visibility

: string

BillingInstrumentModel

The ISV billing instrument information.

Name	Path	Type	Description
subscriptionId	subscriptionId	uuid	The tenant subscription Id.
resourceGroup	resourceGroup	string	The resource group within the tenant subscription.
id	id	string

BillingPolicyConditionsApiFilterModel

The Power Platform connector filter.

Name	Path	Type	Description
allowOtherPremiumConnectors	allowOtherPremiumConnectors	boolean	A flag indicating whether metered usage that involves premium connectors may be attributed.
requiredApis	requiredApis	array of BillingPolicyConditionsApiModel	A list of connectors, at least one of which must be involved in the metered usage to be attributed.

BillingPolicyConditionsApiModel

Name	Path	Type	Description
name	name	string	The name of an API connector.

BillingPolicyConditionsModel

The ISV Contract API filter conditions.

Name	Path	Type	Description
apiFilter	apiFilter	BillingPolicyConditionsApiFilterModel	The Power Platform connector filter.

BillingPolicyEnvironmentResponseModelV1

Name	Path	Type	Description
billingPolicyId	billingPolicyId	string
environmentId	environmentId	string

BillingPolicyEnvironmentResponseModelV1ResponseWithOdataContinuation

Name	Path	Type	Description
value	value	array of BillingPolicyEnvironmentResponseModelV1
@odata.nextLink	@odata.nextLink	string

BillingPolicyResponseModel

Name	Path	Type	Description
id	id	string
name	name	string
status	status	BillingPolicyStatus	The desired ISV contract status.
___location	___location	string
billingInstrument	billingInstrument	BillingInstrumentModel	The ISV billing instrument information.
createdOn	createdOn	date-time
createdBy	createdBy	Principal
lastModifiedOn	lastModifiedOn	date-time
lastModifiedBy	lastModifiedBy	Principal

BillingPolicyResponseModelResponseWithOdataContinuation

Name	Path	Type	Description
value	value	array of BillingPolicyResponseModel
@odata.nextLink	@odata.nextLink	string

BillingPolicyStatus

The desired ISV contract status.

: string

CapacitySummary

Name	Path	Type
status	status	CapacityAvailabilityStatus
statusMessage	statusMessage	string
statusMessageCode	statusMessageCode	CapacityStatusMessageCode
finOpsStatus	finOpsStatus	CapacityAvailabilityStatus
finOpsStatusMessage	finOpsStatusMessage	string
finOpsStatusMessageCode	finOpsStatusMessageCode	CapacityStatusMessageCode

CapacityType

: string

CapacityUnits

: string

CatalogVisibility

Catalog visibility for the application

: string

ConnectionReference

Name	Path	Type	Description
Connector Id	id	string
Connector display name	displayName	string
Icon URI	iconUri	string
Data sources	dataSources	array of string	List of data sources for the connection
Dependencies	dependencies	array of string	List of dependencies for the connection
Dependents	dependents	array of string	List of dependant connectors for the connector
Is on premise connection	isOnPremiseConnection	boolean	Flag indicates on premise data gateway
Bypass consent	bypassConsent	boolean	Flag indicates bypassed API consent
API tier	apiTier	string	API tier is standard or premium
Custom API flag	isCustomApiConnection	boolean	Flag indicates custom connector
Runtime Policy Name	runtimePolicyName	string	String indicating the name of the runtime policy
Execution Restrictions	executionRestrictions	object	Execution restrictions for the runtime policy
Shared Connection ID	sharedConnectionId	string	String indicating the ID of the shared connection

ConnectionReferences

Name	Path	Type	Description
Items		ConnectionReference

ConsumerIdentityModel

The consumer identity for ISV contract.

Name	Path	Type	Description
tenantId	tenantId	uuid	The ID of the customer tenant.

ConsumptionModel

Name	Path	Type
actual	actual	double
rated	rated	double
actualUpdatedOn	actualUpdatedOn	date-time
ratedUpdatedOn	ratedUpdatedOn	date-time

CreateEnvironmentManagementSettingResponse

Represents the response object for APIs in this service.

Name	Path	Type	Description
objectResult	objectResult	string	Gets or sets the ID of the entity being created in the response
errors	errors	ErrorResponse
nextLink	nextLink	uri	Gets or sets the next link if there are more records to be returned
responseMessage	responseMessage	string	Gets or sets the error message.

CrossTenantConnection

Name	Path	Type	Description
tenantId	tenantId	uuid	The Azure AD tenant ID to or from which the cross-tenant connection occurred.
connectionType	connectionType	string	The direction of the cross-tenant connection.

CrossTenantConnectionReport

Name	Path	Type	Description
tenantId	tenantId	uuid	The Azure AD tenant ID for which the report was generated.
reportId	reportId	uuid	The report ID.
requestDate	requestDate	date-time	The date when the cross-tenant connection report was requested.
startDate	startDate	date-time	The start of the report date window.
endDate	endDate	date-time	The end of the report date window.
status	status	string
connections	connections	array of CrossTenantConnection	The page of cross-tenant connections occurring within the report date window.
@odata.nextLink	@odata.nextLink	string	The URI of the next page of the report containing additional cross-tenant connections.

CrossTenantConnectionReportsResponseWithOdataContinuation

Name	Path	Type	Description
value	value	array of CrossTenantConnectionReport	The cross-tenant connection reports for the tenant.
@odata.nextLink	@odata.nextLink	string	The URI of the next page of the list response.

CurrencyAllocationResponseModelV1

Name	Path	Type	Description
currencyType	currencyType	ExternalCurrencyType	Available currency type which can be allocated to environment.
allocated	allocated	integer	The allocated count of currency type

CurrencyConsumption

Name	Path	Type	Description
unitsConsumed	unitsConsumed	integer
lastUpdatedDay	lastUpdatedDay	date-time

CurrencyReportV2

Name	Path	Type	Description
currencyType	currencyType	ExternalCurrencyType	Available currency type which can be allocated to environment.
purchased	purchased	integer
allocated	allocated	integer
consumed	consumed	CurrencyConsumption

Environment

Name	Path	Type	Description
environmentId	environmentId	string	The environment ID.

EnvironmentGroup

Name	Path	Type
id	id	uuid
displayName	displayName	string
description	description	string
parentGroupId	parentGroupId	uuid
childrenGroupIds	childrenGroupIds	array of uuid
createdTime	createdTime	date-time
createdBy	createdBy	Principal
lastModifiedTime	lastModifiedTime	date-time
lastModifiedBy	lastModifiedBy	Principal

EnvironmentGroupResponseWithOdataContinuation

Name	Path	Type	Description
value	value	array of EnvironmentGroup
@odata.nextLink	@odata.nextLink	string

EnvironmentList

Name	Path	Type	Description
value	value	array of EnvironmentResponse

EnvironmentManagementSetting

Name	Path	Type
id	id	string
tenantId	tenantId	uuid
enableIpBasedStorageAccessSignatureRule	enableIpBasedStorageAccessSignatureRule	boolean
allowedIpRangeForStorageAccessSignatures	allowedIpRangeForStorageAccessSignatures	string
ipBasedStorageAccessSignatureMode	ipBasedStorageAccessSignatureMode	integer
loggingEnabledForIpBasedStorageAccessSignature	loggingEnabledForIpBasedStorageAccessSignature	boolean
rowRevision	rowRevision	integer

EnvironmentResponse

Name	Path	Type	Description
id	id	string	The value of id property on the environment object.
displayName	displayName	string	The display name of the environment.
tenantId	tenantId	string	The value of tenantId property on the environment object.
type	type	string	The type of environment.
geo	geo	string	The geographical region of the environment.
azureRegion	azureRegion	string	The Azure region of the environment.
createdDateTime	createdDateTime	date-time	The creation date and time of the environment.
deletedDateTime	deletedDateTime	date-time	The deletion date and time of the environment.
dataverseId	dataverseId	string	The value of dataverseId property on the environment object.
url	url	string	The URL of the environment.
version	version	string	The version of the environment.
domainName	domainName	string	The ___domain name of the environment.
state	state	string	The state of the environment.
adminMode	adminMode	string	The administrative mode of the environment.
backgroundOperationsState	backgroundOperationsState	string	The background operations state of the environment.
protectionLevel	protectionLevel	string	The protection level of the environment.
retentionPeriod	retentionDetails.retentionPeriod	string	The retention period of the environment.
availableFromDateTime	retentionDetails.availableFromDateTime	date-time	The available from date and time of the environment.

ErrorDetail

Name	Path	Type
code	code	string
message	message	string
target	target	string
value	value	string

ErrorDetails

Name	Path	Type	Description
errorName	errorName	string	Error name
errorCode	errorCode	integer	Error code from Dataverse
message	message	string	Error message
type	type	string	Error type
statusCode	statusCode	integer	Status code for error
source	source	string	Source of the error

ErrorInfo

Name	Path	Type	Description
code	code	string	The error code.
fieldErrors	fieldErrors	object

ErrorResponse

Name	Path	Type
code	code	string
message	message	string
details	details	array of ErrorDetail

ExternalCurrencyType

Available currency type which can be allocated to environment.

: string

GetEnvironmentManagementSettingResponse

Represents the response object for APIs in this service.

Name	Path	Type	Description
objectResult	objectResult	array of EnvironmentManagementSetting	Gets or sets the fields for the entities being queried.
errors	errors	ErrorResponse
nextLink	nextLink	uri	Gets or sets the next link if there are more records to be returned
responseMessage	responseMessage	string	Gets or sets the error message.

GetTemporaryCurrencyEntitlementCountResponseModel

Name	Path	Type
temporaryCurrencyEntitlementCount	temporaryCurrencyEntitlementCount	integer
temporaryCurrencyEntitlementsAllowedPerMonth	temporaryCurrencyEntitlementsAllowedPerMonth	integer
entitledQuantity	entitledQuantity	integer

InstancePackage

Name	Path	Type	Description
id	id	uuid	Instance package ID
packageId	packageId	uuid	Package ID
applicationId	applicationId	uuid	Application ID associated with the instance package
applicationName	applicationName	string	Application name associated with the instance package
applicationDescription	applicationDescription	string	Application description associated with the instance package
singlePageApplicationUrl	singlePageApplicationUrl	string	Single Page Application (SPA) URL
publisherName	publisherName	string	Publisher name for the application
publisherId	publisherId	uuid	Publisher ID
packageUniqueName	packageUniqueName	string	Package unique name.
packageVersion	packageVersion	string	Package version
localizedDescription	localizedDescription	string	Localized description of application
localizedName	localizedName	string	Localized name of application
learnMoreUrl	learnMoreUrl	string	Learn more url for the application
termsOfServiceBlobUris	termsOfServiceBlobUris	array of string	Terms of service for the application
applicationVisibility	applicationVisibility	ApplicationVisibility	Application visibility
lastOperation	lastOperation	InstancePackageOperation
customHandleUpgrade	customHandleUpgrade	boolean	Custom handle upgrade flag for the application

InstancePackageOperation

Name	Path	Type	Description
state	state	InstancePackageState	State of the instance package
createdOn	createdOn	date-time	Date and time for creation of the instance package operation
modifiedOn	modifiedOn	date-time	Date and time for modification of the instance package operation
errorDetails	errorDetails	ErrorDetails
statusMessage	statusMessage	string	Status message
instancePackageId	instancePackageId	uuid	Instance package ID
operationId	operationId	uuid	Operation ID for the operation triggered on the instance package

InstancePackageOperationPollingResponse

Name	Path	Type
status	status	InstancePackageOperationStatus
createdDateTime	createdDateTime	date-time
lastActionDateTime	lastActionDateTime	date-time
error	error	ErrorDetails
statusMessage	statusMessage	string
operationId	operationId	uuid

InstancePackageOperationStatus

: string

InstancePackageState

State of the instance package

: string

IsvContractResponseModel

Name	Path	Type	Description
id	id	string
name	name	string
status	status	BillingPolicyStatus	The desired ISV contract status.
geo	geo	string
consumer	consumer	ConsumerIdentityModel	The consumer identity for ISV contract.
conditions	conditions	BillingPolicyConditionsModel	The ISV Contract API filter conditions.
billingInstrument	billingInstrument	BillingInstrumentModel	The ISV billing instrument information.
powerAutomatePolicy	powerAutomatePolicy	PowerAutomatePolicyModel	The Power Platform requests policies.
createdOn	createdOn	date-time
createdBy	createdBy	Principal
lastModifiedOn	lastModifiedOn	date-time
lastModifiedBy	lastModifiedBy	Principal

IsvContractResponseModelResponseWithOdataContinuation

Name	Path	Type	Description
value	value	array of IsvContractResponseModel
@odata.nextLink	@odata.nextLink	string

JobStatus

Name	Path	Type	Description
name	name	string	The job name.
status	status	string	The job status.
startTime	startTime	date-time	The job start time.
endTime	endTime	date-time	The job end time.

LegacyCapacityModel

Name	Path	Type
totalCapacity	totalCapacity	double
totalConsumption	totalConsumption	double
capacityUnits	capacityUnits	CapacityUnits

LicenseDetailsModel

Name	Path	Type
entitlementCode	entitlementCode	string
displayName	displayName	string
isTemporaryLicense	isTemporaryLicense	boolean
temporaryLicenseExpiryDate	temporaryLicenseExpiryDate	date-time
servicePlanId	servicePlanId	uuid
skuId	skuId	uuid
paid	paid	LicenseQuantity
trial	trial	LicenseQuantity
totalCapacity	totalCapacity	double
nextLifecycleDate	nextLifecycleDate	date-time
capabilityStatus	capabilityStatus	string

LicenseModel

: string

LicenseQuantity

Name	Path	Type
enabled	enabled	integer
warning	warning	integer
suspended	suspended	integer

ListPolicyResponse

Name	Path	Type	Description
value	value	array of Policy

ODataListWebsitesDto

Name	Path	Type
@odata.metadata	@odata.metadata	string
value	value	array of WebsiteDto
@odata.nextLink	@odata.nextLink	string

OperationExecutionResult

Name	Path	Type	Description
name	name	string	The result name.
status	status	OperationStatus	The operation status.
operationId	operationId	string	The operation ID.
startTime	startTime	date-time	The start time.
endTime	endTime	date-time	The end time.
updatedEnvironment	updatedEnvironment	Environment
requestedBy	requestedBy	UserIdentity
errorDetail	errorDetail	ErrorInfo
jobStatuses	jobStatuses	array of JobStatus

OperationExecutionResultPagedCollection

Name	Path	Type	Description
collection	collection	array of OperationExecutionResult
continuationToken	continuationToken	string	The continuation token from a previous response.

OperationResponse

Represents the response object for APIs in this service.

Name	Path	Type	Description
objectResult	objectResult		Gets or sets the response's object
errors	errors	ErrorResponse
nextLink	nextLink	uri	Gets or sets the next link if there are more records to be returned
debugErrors	debugErrors	string	Gets or sets debug errors, that are only shown for private/local testing
responseMessage	responseMessage	string	Gets or sets the error message.

OperationStatus

The operation status.

: string

OverflowCapacityModel

Name	Path	Type	Description
capacityType	capacityType	CapacityType
value	value	double

PayAsYouGoState

: string

Policy

Name	Path	Type	Description
id	id	string	The unique identifier of the policy assignment.
tenantId	tenantId	string	The unique identifier of the tenant.
name	name	string	The name of the policy.
lastModified	lastModified	date-time	The date and time when the policy was last modified.
ruleSets	ruleSets	array of RuleSet
ruleSetCount	ruleSetCount	integer	The number of rule sets associated with this policy.

PowerApp

Name	Path	Type	Description
id	id	string	PowerApp ID field.
name	name	string	PowerApp name field.
appVersion	properties.appVersion	date-time	PowerApp property appVersion.
major	properties.createdByClientVersion.major	integer	PowerApp property createdByClientVersion major.
minor	properties.createdByClientVersion.minor	integer	PowerApp property createdByClientVersion minor.
build	properties.createdByClientVersion.build	integer	PowerApp property createdByClientVersion build.
revision	properties.createdByClientVersion.revision	integer	PowerApp property createdByClientVersion revision.
majorRevision	properties.createdByClientVersion.majorRevision	integer	PowerApp property createdByClientVersion majorRevision.
minorRevision	properties.createdByClientVersion.minorRevision	integer	PowerApp property createdByClientVersion minorRevision.
major	properties.minClientVersion.major	integer	PowerApp property minClientVersion major.
minor	properties.minClientVersion.minor	integer	PowerApp property minClientVersion minor.
build	properties.minClientVersion.build	integer	PowerApp property minClientVersion build.
revision	properties.minClientVersion.revision	integer	PowerApp property minClientVersion revision.
majorRevision	properties.minClientVersion.majorRevision	integer	PowerApp property minClientVersion majorRevision.
minorRevision	properties.minClientVersion.minorRevision	integer	PowerApp property minClientVersion minorRevision.
id	properties.owner.id	string	PowerApp owner principal user ID.
displayName	properties.owner.displayName	string	PowerApp owner principal display name.
email	properties.owner.email	string	PowerApp owner principal email.
type	properties.owner.type	string	PowerApp owner principal type.
tenantId	properties.owner.tenantId	string	PowerApp owner principal tenant ID.
userPrincipalName	properties.owner.userPrincipalName	string	PowerApp owner principal user principal name.
id	properties.createdBy.id	string	PowerApp creator principal object ID.
displayName	properties.createdBy.displayName	string	PowerApp creator principal display name.
email	properties.createdBy.email	string	PowerApp creator principal email.
type	properties.createdBy.type	string	PowerApp creator principal type.
tenantId	properties.createdBy.tenantId	string	PowerApp creator principal tenant ID.
userPrincipalName	properties.createdBy.userPrincipalName	string	PowerApp creator principal user principal name.
id	properties.lastModifiedBy.id	string	PowerApp last modified by principal object ID.
displayName	properties.lastModifiedBy.displayName	string	PowerApp last modified by principal display name.
email	properties.lastModifiedBy.email	string	PowerApp last modified by principal email.
type	properties.lastModifiedBy.type	string	PowerApp last modified by principal type.
tenantId	properties.lastModifiedBy.tenantId	string	PowerApp last modified by principal tenant ID.
userPrincipalName	properties.lastModifiedBy.userPrincipalName	string	PowerApp last modified by principal userPrincipalName.
backgroundColor	properties.backgroundColor	string	PowerApp background color.
backgroundImageUri	properties.backgroundImageUri	string	PowerApp background image URI.
displayName	properties.displayName	string	PowerApp display name.
description	properties.description	string	PowerApp description.
value	properties.appUris.documentUri.value	string	PowerApp appUri document URI value.
readonlyValue	properties.appUris.documentUri.readonlyValue	string	PowerApp appUri document URI read only value.
imageUris	properties.appUris.imageUris	array of string	PowerApp appUri image URI array.
createdTime	properties.createdTime	date-time	PowerApp property created time.
lastModifiedTime	properties.lastModifiedTime	date-time	PowerApp property last modified time.
sharedGroupsCount	properties.sharedGroupsCount	integer	PowerApp property shared groups count.
sharedUsersCount	properties.sharedUsersCount	integer	PowerApp property shared users count.
appOpenProtocolUri	properties.appOpenProtocolUri	string	PowerApp property app open protocol URI.
appOpenUri	properties.appOpenUri	string	PowerApp property app open URI.
favorite	properties.userAppMetadata.favorite	string	PowerApp property user app metadata favorite.
includeInAppsList	properties.userAppMetadata.includeInAppsList	boolean	PowerApp property user app metadata include in apps list.
isFeaturedApp	properties.isFeaturedApp	boolean	PowerApp property is featured app.
bypassConsent	properties.bypassConsent	boolean	PowerApp property bypass consent.
isHeroApp	properties.isHeroApp	boolean	PowerApp property indicating hero application.
id	properties.environment.id	string	PowerApp environment ID.
name	properties.environment.name	string	PowerApp environment name.
connectionReferences	properties.connectionReferences	ConnectionReferences
primaryDeviceWidth	tags.primaryDeviceWidth	string	PowerApp tag primary device width.
primaryDeviceHeight	tags.primaryDeviceHeight	string	PowerApp tag primary device height.
sienaVersion	tags.sienaVersion	string	PowerApp tag siena version.
deviceCapabilities	tags.deviceCapabilities	string	PowerApp tag device capabilities.
supportsPortrait	tags.supportsPortrait	string	PowerApp tag supports portrait.
supportsLandscape	tags.supportsLandscape	string	PowerApp tag supports landscape.
primaryFormFactor	tags.primaryFormFactor	string	PowerApp tag primary form factor.
publisherVersion	tags.publisherVersion	string	PowerApp tag publisher version.
minimumRequiredApiVersion	tags.minimumRequiredApiVersion	date-time	PowerApp tag minimum required API version.
type	type	string	PowerApp type field.

PowerAutomatePolicyModel

The Power Platform requests policies.

Name	Path	Type
cloudFlowRunsPayAsYouGoState	cloudFlowRunsPayAsYouGoState	PayAsYouGoState
desktopFlowUnattendedRunsPayAsYouGoState	desktopFlowUnattendedRunsPayAsYouGoState	PayAsYouGoState
desktopFlowAttendedRunsPayAsYouGoState	desktopFlowAttendedRunsPayAsYouGoState	PayAsYouGoState

Principal

Name	Path	Type
id	id	string
displayName	displayName	string
email	email	string
type	type	string
tenantId	tenantId	string
userPrincipalName	userPrincipalName	string

ResourceArrayPowerApp

Name	Path	Type	Description
value	value	array of PowerApp
Next Link	nextLink	string	The URL to get the next page of the apps list. Contains the skip token.

RuleAssignment

Name	Path	Type	Description
ruleSetCount	ruleSetCount	integer	The count of rule sets assigned.
policyId	policyId	string	The unique identifier of the policy.
tenantId	tenantId	string	The unique identifier of the tenant.
resourceId	resourceId	string	The unique identifier of the resource.
resourceType	resourceType	string	The type of resource assigned to the rule.

RuleAssignmentsResponse

Name	Path	Type	Description
value	value	array of RuleAssignment

RuleSet

Name	Path	Type	Description
id	id	string	The unique identifier of the rule set.
version	version	string	The version of the rule set.
inputs	inputs	object	The inputs for the rule set, which may vary based on the rule.

StorageWarningThresholds

Name	Path	Type
storageCategory	storageCategory	string
storageEntity	storageEntity	string
thresholdInMB	thresholdInMB	integer
warningMessageConstKey	warningMessageConstKey	string

StorageWarningThresholdsDocument

Name	Path	Type
storageCategory	storageCategory	string
storageEntity	storageEntity	string
thresholds	thresholds	array of StorageWarningThresholds
isActive	isActive	boolean

TemporaryLicenseInfo

Name	Path	Type	Description
hasTemporaryLicense	hasTemporaryLicense	boolean
temporaryLicenseExpiryDate	temporaryLicenseExpiryDate	date-time

TenantApplicationPackage

Name	Path	Type	Description
uniqueName	uniqueName	string	Unique name of the tenant application package
localizedDescription	localizedDescription	string	Localized description of the tenant application package
localizedName	localizedName	string	Localized name
applicationId	applicationId	uuid	Application ID
applicationName	applicationName	string	Application name
applicationDescription	applicationDescription	string	Application description
publisherName	publisherName	string	Publisher name
publisherId	publisherId	uuid	Publisher ID
learnMoreUrl	learnMoreUrl	string	Learn more URL
catalogVisibility	catalogVisibility	CatalogVisibility	Catalog visibility for the application
applicationVisibility	applicationVisibility	ApplicationVisibility	Application visibility
lastError	lastError	ErrorDetails

TenantApplicationPackageContinuationResponse

Name	Path	Type	Description
value	value	array of TenantApplicationPackage
@odata.nextLink	@odata.nextLink	string

TenantCapacityAndConsumptionModel

Name	Path	Type
capacityType	capacityType	CapacityType
capacityUnits	capacityUnits	CapacityUnits
totalCapacity	totalCapacity	double
maxCapacity	maxCapacity	double
consumption	consumption	ConsumptionModel
status	status	CapacityAvailabilityStatus
overflowCapacity	overflowCapacity	array of OverflowCapacityModel
capacityEntitlements	capacityEntitlements	array of TenantCapacityEntitlementModel

TenantCapacityDetailsModel

Name	Path	Type
tenantId	tenantId	uuid
licenseModelType	licenseModelType	LicenseModel
capacitySummary	capacitySummary	CapacitySummary
tenantCapacities	tenantCapacities	array of TenantCapacityAndConsumptionModel
legacyModelCapacity	legacyModelCapacity	LegacyCapacityModel
temporaryLicenseInfo	temporaryLicenseInfo	TemporaryLicenseInfo

TenantCapacityEntitlementModel

Name	Path	Type
capacityType	capacityType	CapacityType
capacitySubType	capacitySubType	CapacityEntitlementType
totalCapacity	totalCapacity	double
maxNextLifecycleDate	maxNextLifecycleDate	date-time
licenses	licenses	array of LicenseDetailsModel

UserIdentity

Name	Path	Type	Description
userId	userId	string	The user ID.
displayName	displayName	string	The display name.
tenantId	tenantId	string	The tenant ID.

WebApplicationFirewallStatus

Web application firewall status

: string

WebsiteDto

Name	Path	Type	Description
id	id	string	Website unique identifier (ID)
name	name	string	Website name
createdOn	createdOn	string	Website creation time in the ISO 8601 UTC format
templateName	templateName	string	Website template name
websiteUrl	websiteUrl	string	Website URL
tenantId	tenantId	string	Tenant unique identifier (ID) of the website
dataverseInstanceUrl	dataverseInstanceUrl	string	Organization URL of the website
environmentName	environmentName	string	Environment name of the website
environmentId	environmentId	string	Environment unique identifier (ID) of the website
dataverseOrganizationId	dataverseOrganizationId	string	Organization unique identifier (ID) of the website
selectedBaseLanguage	selectedBaseLanguage	integer	Language unique identifier (ID) of the website - https://go.microsoft.com/fwlink/?linkid=2208135
customHostNames	customHostNames	array of string	Custom hostnames added for the website
websiteRecordId	websiteRecordId	string	Dataverse record unique identifier (ID) of the website
subdomain	subdomain	string	Subdomain of website
packageInstallStatus	packageInstallStatus	string	Package installation status of the website
type	type	string	Application type of the website
trialExpiringInDays	trialExpiringInDays	integer	Time (in days) to expiration of the website
suspendedWebsiteDeletingInDays	suspendedWebsiteDeletingInDays	integer	Time (in days) to website deletion, if suspended
packageVersion	packageVersion	string	Package version of the website
isEarlyUpgradeEnabled	isEarlyUpgradeEnabled	boolean	Website eligibility for early upgrade
isCustomErrorEnabled	isCustomErrorEnabled	boolean	Custom error enablement for Website
applicationUserAadAppId	applicationUserAadAppId	string	Entra ID (formerly Azure Active Directory) object unique identifier (ID)
ownerId	ownerId	string	User unique identifier (ID) of the website owner
status	status	string	Website status
siteVisibility	siteVisibility	string	Website visibility status

Share via

Power Platform for Admins V2

Power Platform for Admins V2

Service Principal authentication

Known issues and limitations

Creating a connection

OAuth Connection

Service Principal Connection

Default [DEPRECATED]

Throttling Limits

Actions

Add the environment to the environment group

Parameters

Allocate and deallocate the currencies for the environment

Parameters

Returns

Apply the system administrator role

Parameters

Create a Power Pages website

Parameters

Create an ISV contract

Parameters

Returns

Create environment group rule based assignment

Parameters

Returns

Create environment management settings

Parameters

Returns

Create rule based policy

Parameters

Returns

Create the environment group

Parameters

Returns

Creates the billing policy at tenant level

Parameters

Returns

Delete a Power Pages website

Parameters

Delete an ISV contract

Parameters

Delete billing policy

Parameters

Delete the environment by ID

Parameters

Delete the environment group

Parameters

Enable web application firewall on a Power Pages website

Parameters

Execute recommendation action

Parameters

Returns

Generate or fetch a cross-tenant connection report

Parameters

Returns

Get a cross-tenant connection report by report ID for a tenant

Parameters

Returns

Get an ISV contract by its identifier (ID)

Parameters

Returns

Get app as administrator

Parameters

Returns

Get apps as administrator

Parameters

Returns

Get currency allocations for the environment

Parameters

Returns

Get environment management setting by ID

Parameters

Returns

Get operation status

Parameters

Get recommendation resources

Parameters

Returns

Get recommendations