/api/v1/execution-environment:prepare
Retries setup preparation for a pending execution environment after a customer administrator resolves the required consent. Environment creation starts the first attempt automatically. Follow the operation status before continuing with Azure deployment. Requires the GV.APIOwner application role, or a higher role (Owner > Contributor > Reader).
Operation ID · prepare_execution_environment
Request example
Authentication and access
- Required role: GV.APIOwner
- Data classification: metadata
- Side effects: configurationWrite
- Microsoft Entra delegated user token
- Microsoft Entra application token
Parameters
Idempotency-Key
header Required Required caller-chosen retry identity. Use 1-128 visible ASCII characters and reuse it only for an exact retry of this request.string
minimum length: 1 · maximum length: 128
Responses
This guide summarizes response status codes and headers. Retrieve the deployed, authenticated OpenAPI document for the exact response body schemas and examples. The API also provides an authenticated Swagger UI; opening it in a browser does not automatically attach a bearer token. Error responses useapplication/problem+json. The response’s stable code and type map to the error-code reference.
202
Preparation accepted; poll the operation.Headers
- Idempotency-Replayed:
boolean - Location:
string - Retry-After: Wait five seconds before polling again.
integerAllowed values5
401
A valid Microsoft Entra bearer token is required.403
The authenticated principal does not have the required role.404
The resource does not exist in this tenant.409
The operation conflicts with current resource or Azure state.422
The request is syntactically valid but semantically invalid.429
The bounded application request rate was exceeded.Headers
- Retry-After: Seconds to wait before retrying.
integerminimum: 1
503
A required dependency is temporarily unavailable.Headers
- Retry-After: Seconds to wait before retrying.
integerminimum: 1