swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector EnvironmentOperations API
schemes:
- https
tags:
- name: EnvironmentOperations
paths:
  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations:
    get:
      tags:
      - EnvironmentOperations
      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: '#/parameters/EnvironmentNameParameter'
      operationId: microsoftAzureEnvironmentsListoperations
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/EnvironmentOperationListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        EnvironmentOperations_ListByEnvironment:
          $ref: ./examples/EnvironmentOperations_ListByEnvironment.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations
  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}:
    get:
      tags:
      - EnvironmentOperations
      description: Gets an environment action result.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/UserIdParameter
      - $ref: '#/parameters/EnvironmentNameParameter'
      - $ref: '#/parameters/EnvironmentOperationIdParameter'
      operationId: microsoftAzureEnvironmentsGetoperation
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/EnvironmentOperation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        EnvironmentOperations_GetByEnvironment:
          $ref: ./examples/EnvironmentOperations_GetByEnvironment.json
      summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations Operationid
  /projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs:
    get:
      tags:
      - EnvironmentOperations
      description: Gets the logs for an operation on an environment.
      produces:
      - text/plain
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/UserIdParameter
      - $ref: '#/parameters/EnvironmentNameParameter'
      - $ref: '#/parameters/EnvironmentOperationIdParameter'
      operationId: microsoftAzureEnvironmentsGetlogsbyoperation
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            type: file
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        EnvironmentOperations_GetLogs:
          $ref: ./examples/EnvironmentOperations_GetLogs.json
      summary: Microsoft Azure Get Projects Projectname Users Userid Environments Environmentname Operations Operationid Logs
definitions:
  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: 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: '#/definitions/EnvironmentOperationKind'
      status:
        description: The operation status.
        $ref: '#/definitions/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
  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.
  EnvironmentOperationListResult:
    type: object
    description: The action results list result.
    properties:
      value:
        description: The current page of results.
        type: array
        items:
          $ref: '#/definitions/EnvironmentOperation'
      nextLink:
        type: string
        description: The URL to get the next set of results.
    required:
    - value
parameters:
  EnvironmentOperationIdParameter:
    name: operationId
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
    minLength: 3
    maxLength: 63
    description: The id of the operation on an environment.
    x-ms-parameter-location: method
  EnvironmentNameParameter:
    name: environmentName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
    minLength: 3
    maxLength: 63
    description: The name of the environment.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'