openapi: 3.2.0
info:
  version: 2023-09-01-preview
  title: Microsoft Azure DevCenter Environment Operations API
  description: Deployment Environments API.
security:
- AADToken:
  - user_impersonation
tags:
- name: Environment Operations
paths:
  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations:
    get:
      tags:
      - Environment Operations
      description: Lists operations on the environment which have occurred within the past 90 days
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/TopParameter
      - $ref: devcenter.json#/parameters/FilterParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/UserIdParameter
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      operationId: microsoftAzureEnvironmentsListoperations
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentOperationListResult'
        default:
          description: Error response describing why the operation failed.
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: devcenter.json#/definitions/CloudError
      x-ms-examples:
        EnvironmentOperations_ListByEnvironment:
          $ref: ./examples/EnvironmentOperations_ListByEnvironment.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Projects Projectname Users Userid Environments…
  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}:
    get:
      tags:
      - Environment Operations
      description: Gets an environment action result.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/UserIdParameter
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - $ref: '#/components/parameters/EnvironmentOperationIdParameter'
      operationId: microsoftAzureEnvironmentsGetoperation
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentOperation'
        default:
          description: Error response describing why the operation failed.
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: devcenter.json#/definitions/CloudError
      x-ms-examples:
        EnvironmentOperations_GetByEnvironment:
          $ref: ./examples/EnvironmentOperations_GetByEnvironment.json
      summary: Microsoft Azure Get Projects Projectname Users Userid Environments…
  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs:
    get:
      tags:
      - Environment Operations
      description: Gets the logs for an operation on an environment.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/UserIdParameter
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - $ref: '#/components/parameters/EnvironmentOperationIdParameter'
      operationId: microsoftAzureEnvironmentsGetlogsbyoperation
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            text/plain:
              schema:
                type: string
                format: binary
        default:
          description: Error response describing why the operation failed.
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            text/plain:
              schema:
                $ref: devcenter.json#/definitions/CloudError
      x-ms-examples:
        EnvironmentOperations_GetLogs:
          $ref: ./examples/EnvironmentOperations_GetLogs.json
      summary: Microsoft Azure Get Projects Projectname Users Userid Environments…
components:
  parameters:
    EnvironmentNameParameter:
      name: environmentName
      in: path
      required: true
      description: The name of the environment.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 63
        minLength: 3
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
    EnvironmentOperationIdParameter:
      name: operationId
      in: path
      required: true
      description: The id of the operation on an environment.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 63
        minLength: 3
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
  schemas:
    EnvironmentOperationStatus:
      type: string
      enum:
      - NotStarted
      - Running
      - Succeeded
      - Canceled
      - Failed
      description: The status of an environment operation.
      x-ms-enum:
        name: EnvironmentOperationStatus
        modelAsString: true
        values:
        - value: NotStarted
          description: The operation has not started.
        - value: Running
          description: The operation is running.
        - value: Succeeded
          description: The operation succeeded.
        - value: Canceled
          description: The operation was canceled.
        - value: Failed
          description: The operation failed.
    EnvironmentOperation:
      type: object
      description: Information about an operation on an environment.
      discriminator:
        propertyName: kind
      properties:
        uri:
          description: The unique URI for the environment operation.
          type: string
        operationId:
          description: Unique identifier for the environment operation.
          type: string
        kind:
          description: The kind of operation that occurred.
          $ref: '#/components/schemas/EnvironmentOperationKind'
        status:
          description: The operation status.
          $ref: '#/components/schemas/EnvironmentOperationStatus'
        createdByObjectId:
          description: The object ID of the actor which initiated the operation.
          type: string
        startTime:
          description: The time the operation started.
          type: string
          format: date-time
        endTime:
          description: The time the operation finished.
          type: string
          format: date-time
        environmentParameters:
          type: object
          description: Parameters object for the environment at the time of the operation.
        error:
          description: Provisioning or operation error details. Populated only for error states.
          $ref: devcenter.json#/definitions/CloudErrorBody
      required:
      - uri
      - operationId
      - kind
      - status
    EnvironmentOperationListResult:
      type: object
      description: The action results list result.
      properties:
        value:
          description: The current page of results.
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentOperation'
        nextLink:
          type: string
          description: The URL to get the next set of results.
      required:
      - value
    EnvironmentOperationKind:
      type: string
      enum:
      - Deploy
      - Delete
      description: The type of environment operation.
      x-ms-enum:
        name: EnvironmentOperationKind
        modelAsString: true
        values:
        - value: Deploy
          description: The operation represents a deployment.
        - value: Delete
          description: The operation represents a delete.
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: devcenter.json#/parameters/EndpointParameter