Skip to main content
API · Execution Environment GET /api/v1/execution-environment Requires the GV.APIReader application role, or a higher role (Owner > Contributor > Reader). Operation ID · get_execution_environment

Request example

Authentication and access

  • Required role: GV.APIReader
  • Data classification: metadata
  • Side effects: none
Use an authentication scheme declared below. Ordinary workloads use application tokens; signed-in users use delegated tokens and Organization membership. Activation and invitation acceptance require a person, and execution callbacks require their registered identity.
  • Microsoft Entra delegated user token
  • Microsoft Entra application token

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 use application/problem+json. The response’s stable code and type map to the error-code reference.

200

Active environment with its latest provisioning operation; Retry-After is present only while work is queued or running.

Headers

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

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