Power Platform for Admins V2 (Preview)

Reference

Unified connector for all administrative capabilities in Microsoft Power Platform

This connector is available in the following products and regions:

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

Contact
Name	Microsoft Support
URL	https://admin.powerplatform.microsoft.com/support
Email	[email protected]

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.
Create a Power Pages website	Trigger the creation of a new website
Create a request to generate cross-tenant connection report for a tenant or return an existing report	Ability to Create a request to generate cross-tenant connection report for a tenant or return an existing report.
Create an ISV contract	Create an ISV contract.
Create Environment Management Settings	Ability to Create Environment Management Settings
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 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).
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 currency allocations for the environment	Ability to Get currency allocations for the environment.
Get list of Application Packages that are available for a tenant	Get list of available application packages for a tenant
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 the billing policy at tenant level by policy ID	Ability to Get the billing policy at tenant level by policy ID.
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 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 from Website id
Get the Web Application Firewall status	Get the status of Web Application Firewall associated with the given website
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 type	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 type.
Grants requesting tenant admin user the system admin role within Dataverse in the environment	Ability to Grants requesting tenant admin user the system admin role within Dataverse in the environment.
Link billing policy ID with environments	Ability to Link billing policy ID with environments.
List Application Packages that are available for install in a target environment	Get list of Application Packages that are relevant in the context of a target environment. Client can filter the Application Packages based on Install State (NotInstalled, Installed, All) and any other response parameters utilizing standard OData capabilities
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 the environment groups	Ability to List the environment groups.
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
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
Stop a Power Pages website	Stop the website for the given site id
Trigger application package install into a target environment	Trigger installation of an application package based on the package unique name to be installed in a target environment. Client can also include custom payload when requesting installation of an application package.
Unlink billing policy ID from environments	Ability to Unlink billing policy ID from environments.
Update an ISV contract	Update an ISV contract.
Update the environment group	Ability to Update the environment group.
Updates fields on a EnvironmentManagementSetting. This API currently doesn't return any entity data in the response body	Ability to Updates fields on a EnvironmentManagementSetting. This API currently doesn't return any entity data in the response body.
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

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 a request to generate cross-tenant connection report for a tenant or return an existing report

Operation ID:: CreateCrossTenantConnectionReport

Ability to Create a request to generate 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

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 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 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 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
type	type		string
lastModifiedTime	lastModifiedTime		date-time
id	id		string
type	type		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	The Operation- Location
Environment Id	environmentId	True	string	The Environment Id
Id	id	True	string	The 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 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	The 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

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 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 list of Application Packages that are available for a tenant

Operation ID:: GetTenantApplicationPackage

Get 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 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 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 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 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	Top limit of results
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 Org 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 from Website id

Parameters

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

Returns

Body: WebsiteDto

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	The Id
Api-version	api-version	True	string	The API version

Returns

Web Application Firewall status

response: WebApplicationFirewallStatus

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 type

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 type.

Parameters

Name	Key	Required	Type	Description
Environment Id	environmentId	True	string	Id for the EnvironmentManagementSetting
$top	$top		integer	Number of records to retrieve. If not set, 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

Grants requesting tenant admin user the system admin role within Dataverse in the environment

Operation ID:: ApplyAdminRole

Ability to Grants requesting tenant admin user the system admin 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

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 Application Packages that are available for install in a target environment

Operation ID:: GetEnvironmentApplicationPackage

Get list of Application Packages that are relevant in the context of a target environment. 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

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 Skip
Api-version	api-version	True	string	The API version

Returns

Body: ODataListWebsitesDto

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

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	The 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	The 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	The Id
Api-version	api-version	True	string	The API version

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	The Id
Api-version	api-version	True	string	The API version

Trigger application package install into a target environment

Operation ID:: InstallApplicationPackage

Trigger installation of an application package based on the package unique name to be installed in a target environment. Client can also include 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 Org id)
Unique Name	uniqueName	True	string	Package Unique Name
Api-version	api-version	True	string	The API version
payloadValue	payloadValue		string

Returns

Body: InstancePackage

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 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
type	type		string
lastModifiedTime	lastModifiedTime		date-time
id	id		string
type	type		string

Returns

Body: EnvironmentGroup

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

Operation ID:: UpdateEnvironmentManagementSettings

Ability to Updates fields on a 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 EnvironmentManagementSetting being updated
Api-version	api-version	True	string	The API version
			object

Returns

Represents the response object for APIs in this service.

Body: OperationResponse

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 last 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

ApplicationPackage

Name	Path	Type	Description
id	id	uuid	AvailablePackage Id or InstancePackage PackageId, both maps to ApplicationPackageId
uniqueName	uniqueName	string	AvailablePackage UniqueName or InstancePackage PackageUniqueName
version	version	string	AvailablePackage Version or InstancePackage PackageVersion
localizedDescription	localizedDescription	string	LocalizedDescription 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 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	AvailablePackage CrmMinVersion
platformMaxVersion	platformMaxVersion	string	AvailablePackage CrmMaxVersion
customHandleUpgrade	customHandleUpgrade	boolean	AvailablePackage CustomUpgrade
instancePackageId	instancePackageId	uuid	InstancePackage Id, used only for retry of package installation ie, Reinstall.
state	state	InstancePackageState	State of instance package
catalogVisibility	catalogVisibility	CatalogVisibility	CatalogVisibility for application
applicationVisibility	applicationVisibility	ApplicationVisibility	Application Visibility
lastError	lastError	ErrorDetails
startDateUtc	startDateUtc	date-time	Start date for applicationPackage
endDateUtc	endDateUtc	date-time	End date for applicationPackage
supportedCountries	supportedCountries	array of string	List of supported countries for the application

ApplicationPackageContinuationResponse

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

ApplicationVisibility

Application Visibility

: string

CatalogVisibility

CatalogVisibility for application

: string

ErrorDetails

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

InstancePackage

Name	Path	Type	Description
id	id	uuid	InstancePackage ID
packageId	packageId	uuid	Package ID
applicationId	applicationId	uuid	ApplicationID 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 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	TOS 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 instance package
createdOn	createdOn	date-time	DateTime for creation of the instance package operation
modifiedOn	modifiedOn	date-time	DateTime for modification of the instance package operation
errorDetails	errorDetails	ErrorDetails
statusMessage	statusMessage	string	Status Message
instancePackageId	instancePackageId	uuid	InstancePackage ID
operationId	operationId	uuid	OperationID 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 instance package

: string

TenantApplicationPackage

Name	Path	Type	Description
uniqueName	uniqueName	string	Uniquename of TenantApplicationPackage
localizedDescription	localizedDescription	string	Localized description of 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	CatalogVisibility for application
applicationVisibility	applicationVisibility	ApplicationVisibility	Application Visibility
lastError	lastError	ErrorDetails

TenantApplicationPackageContinuationResponse

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

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.
reportStatus	reportStatus	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.

ODataListWebsitesDto

Name	Path	Type
@odata.metadata	@odata.metadata	string
value	value	array of WebsiteDto
@odata.nextLink	@odata.nextLink	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	Azure Active Directory (AAD) 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

WebApplicationFirewallStatus

Web Application Firewall status

: string

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

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

ExternalCurrencyType

Available currency type which can be allocated to environment

: string

BillingPolicyConditionsModel

The ISV Contract API filter conditions.

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

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 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.

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

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

ConsumerIdentityModel

The consumer identity for ISV contract.

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

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

PowerAutomatePolicyModel

The Power Platform Requests policies.

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

PayAsYouGoState

: string

Principal

Name	Path	Type	Description
id	id	string
type	type	PrincipalType

PrincipalType

: string

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

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 nextLink if there are more records to be returned
responseMessage	responseMessage	string	Gets or sets the error message.

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

ErrorDetail

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

ErrorResponse

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

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 nextLink if there are more records to be returned
responseMessage	responseMessage	string	Gets or sets the error message.

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 nextLink if there are more records to be returned
debugErrors	debugErrors	string	Gets or sets DebugErrors, only shown for private/local testing
responseMessage	responseMessage	string	Gets or sets the error message.

Share via

Power Platform for Admins V2 (Preview)

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

Create a Power Pages website

Parameters

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

Parameters

Returns

Create an ISV contract

Parameters

Returns

Create Environment Management Settings

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 group

Parameters

Enable Web Application Firewall on a Power Pages website

Parameters

Execute recommendation action

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 currency allocations for the environment

Parameters

Returns

Get list of Application Packages that are available for a tenant

Parameters

Returns

Get Operation Status

Parameters

Get recommendation resources

Parameters

Returns

Get recommendations

Parameters

Returns

Get the billing policy at tenant level by policy ID

Parameters

Returns

Get the environment group

Parameters

Returns

Get the environment linked to the billing policy

Parameters

Returns

Get the linked billing policy details for an environment

Parameters

Returns

Get the list of billing policies for the tenant

Parameters