通过

Environment State - Enable Environment

Service:
Power Platform API
API Version:
2022-03-01-preview

Enables the specified environment (Preview).

POST https://api.powerplatform.com/environmentmanagement/environments/{environmentId}/Enable?api-version=2022-03-01-preview
With optional parameters: 
POST https://api.powerplatform.com/environmentmanagement/environments/{environmentId}/Enable?ValidateOnly={ValidateOnly}&ValidateProperties={ValidateProperties}&api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
environmentId
 path True

string

The ID of the environment.
api-version
 query True

string

The API version.
ValidateOnly
 query

boolean

The value which indicates whether the operation is a validated only request. Examples:

validateOnly=true with validateProperties non-empty: Validate only the listed properties, ignoring others even if present in the body.

validateOnly=true with empty/absent validateProperties: Validate the entire body (equivalent to full validation).

validateOnly=false or omitted: Process the full request(validate and execute).
ValidateProperties
 query

string

The value which indicates what properties should be validated. Need to work together with ValidateOnly. Properties should be separated by ','. Example: "property1,property2,property3".

Request Body

Media Types: "application/json", "text/json", "application/*+json"

Name Type Description
reason

string

The reason of this state change.

Responses

Name Type Description
202 Accepted

Accepted

Media Types: "text/plain", "application/json", "text/json"
400 Bad Request

ValidationResponse

Bad Request

Media Types: "text/plain", "application/json", "text/json"

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name Description
.default .default

Definitions

Name Description
ErrorInfo

Represents error information for an operation.
StateChangeRequest

Represents a request to change the state of an environment.
ValidationResponse

Represents the response for validation of an operation.

ErrorInfo

Object

Represents error information for an operation.

Name Type Description
code

string

The error Code.
fieldErrors

object

The detailed error.

StateChangeRequest

Object

Represents a request to change the state of an environment.

Name Type Description
reason

string

The reason of this state change.

ValidationResponse

Object

Represents the response for validation of an operation.

Name Type Description
errorDetail

ErrorInfo

Represents error information for an operation.