Microsoft Azure Experiments API

openapi: 3.2.0
info:
  title: Microsoft Azure Experiments API
  version: '1.0'
  description: 'Operations tagged Experiments across 2 of this provider''s published API definitions: networkexperiments-openapi-original.yml, run-history-apis-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Experiments
  description: The configuration of the Network Experiment experiments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments
  : get:
      tags:
      - Experiments
      summary: Microsoft Azure Gets A List Of Experiments
      operationId: microsoftAzureExperimentsListbyprofile
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ProfileNameParameter'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Gets a list of Experiments:
          $ref: ./examples/NetworkExperimentListExperiments.json
      description: Needs a more full description created.
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
  : get:
      tags:
      - Experiments
      summary: Microsoft Azure Gets An Experiment By Experimentname
      operationId: microsoftAzureExperimentsGet
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ProfileNameParameter'
      - $ref: '#/components/parameters/ExperimentNameParameter'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Gets an Experiment by ExperimentName:
          $ref: ./examples/NetworkExperimentGetExperiment.json
      description: Needs a more full description created.
    put:
      tags:
      - Experiments
      summary: Microsoft Azure Creates Or Updates An Experiment
      operationId: microsoftAzureExperimentsCreateorupdate
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ProfileNameParameter'
      - $ref: '#/components/parameters/ExperimentNameParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        '201':
          description: Created. The request has been fulfilled and a new experiment has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates an Experiment:
          $ref: ./examples/NetworkExperimentCreateExperiment.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Experiment'
        description: The Experiment resource
        required: true
    patch:
      tags:
      - Experiments
      description: Updates an Experiment
      summary: Microsoft Azure Updates An Experiment By Experiment Id
      operationId: microsoftAzureExperimentsUpdate
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ProfileNameParameter'
      - $ref: '#/components/parameters/ExperimentNameParameter'
      responses:
        '200':
          description: OK. successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Updates an Experiment:
          $ref: ./examples/NetworkExperimentUpdateExperiment.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperimentUpdateModel'
        description: The Experiment Update Model
        required: true
    delete:
      tags:
      - Experiments
      summary: Microsoft Azure Deletes An Experiment
      operationId: microsoftAzureExperimentsDelete
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ProfileNameParameter'
      - $ref: '#/components/parameters/ExperimentNameParameter'
      responses:
        '200':
          description: Delete successful.
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
        '204':
          description: No Content. The request has been accepted but the policy was not found.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Deletes an Experiment:
          $ref: ./examples/NetworkExperimentDeleteExperiment.json
      description: Needs a more full description created.
    servers:
    - url: https://management.azure.com
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}
  : get:
      tags:
      - Experiments
      summary: Microsoft Azure Get Details Of An Experiment
      description: Get details of an Experiment with specific Experiment name.
      operationId: getHistoryV10SubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftMachineLearningServicesWorkspacesByWorkspaceNameExperimentsByExperimentName
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentName
        in: path
        description: The experiment name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The details of the Experiment are returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureExperimentsGet
    post:
      tags:
      - Experiments
      summary: Microsoft Azure Create An Experiment
      description: Create a new Experiment.
      operationId: microsoftAzureExperimentsCreate
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentName
        in: path
        description: The experiment name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The Experiment is created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}
  : get:
      tags:
      - Experiments
      summary: Microsoft Azure Get Details Of An Experiment
      description: Get details of an Experiment with specific Experiment Id.
      operationId: microsoftAzureExperimentsGetbyid
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentId
        in: path
        description: The identifier of the experiment.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    patch:
      tags:
      - Experiments
      summary: Microsoft Azure Update Details Of An Experiment
      description: Update details of an Experiment with specific Experiment Id.
      operationId: patchHistoryV10SubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftMachineLearningServicesWorkspacesByWorkspaceNameExperimentidsByExperimentId
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentId
        in: path
        description: The identifier of the experiment.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyExperiment'
        description: Experiment details which needs to be updated.
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureExperimentsUpdate
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query
  : post:
      tags:
      - Experiments
      summary: Microsoft Azure Get All Experiments In A Specific Workspace
      description: Get all experiments in a specific workspace with the specified query filters.
      operationId: microsoftAzureExperimentsGetbyquery
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExperimentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      x-ms-pageable:
        nextLinkName: nextLink
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryParams'
        description: Query parameters for data sorting and filtering.
  ? /history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags
  : delete:
      tags:
      - Experiments
      summary: Microsoft Azure Delete List Of Tags In An Experiment
      description: Delete list of Tags from a specific Experiment Id.
      operationId: microsoftAzureExperimentsDeletetags
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/workspaceNameParameter'
      - name: experimentId
        in: path
        description: The identifier of the experiment.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTagsCommand'
        description: The requested tags list to be deleted.
components:
  schemas:
    NetworkExperimentResourceState:
      description: Defines the server side resource status
      readOnly: true
      enum:
      - Creating
      - Enabling
      - Enabled
      - Disabling
      - Disabled
      - Deleting
      type: string
      x-ms-enum:
        name: NetworkExperimentResourceState
        modelAsString: true
    ExperimentList:
      description: Defines a list of Experiments. It contains a list of Experiment objects and a URL link to get the next set of results.
      properties:
        value:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Experiment'
          description: List of Experiments within a resource group.
        nextLink:
          type: string
          description: URL to get the next set of Experiment objects if there are any.
    Endpoint:
      description: Defines the endpoint properties
      type: object
      properties:
        name:
          description: The name of the endpoint
          type: string
        endpoint:
          description: The endpoint URL
          type: string
    ExperimentUpdateModel:
      description: Defines modifiable attributes of an Experiment
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
        properties:
          description: The properties of a Profile
          $ref: '#/components/schemas/ExperimentUpdateProperties'
          x-ms-client-flatten: true
    ExperimentProperties:
      description: Defines the properties of an experiment
      type: object
      properties:
        description:
          description: The description of the details or intents of the Experiment
          type: string
        endpointA:
          description: The endpoint A of an experiment
          $ref: '#/components/schemas/Endpoint'
        endpointB:
          description: The endpoint B of an experiment
          $ref: '#/components/schemas/Endpoint'
        enabledState:
          type: string
          description: The state of the Experiment
          enum:
          - Enabled
          - Disabled
          x-ms-enum:
            name: state
            modelAsString: true
        resourceState:
          description: Resource status.
          $ref: '#/components/schemas/NetworkExperimentResourceState'
        status:
          description: The description of Experiment status from the server side
          type: string
          readOnly: true
        scriptFileUri:
          description: The uri to the Script used in the Experiment
          type: string
          readOnly: true
    ErrorResponse:
      description: Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
      type: object
      properties:
        code:
          description: Error code.
          readOnly: true
          type: string
        message:
          description: Error message indicating why the operation failed.
          readOnly: true
          type: string
    ExperimentUpdateProperties:
      description: Defines the properties of an experiment
      type: object
      properties:
        description:
          description: The description of the intent or details of the Experiment
          type: string
        enabledState:
          type: string
          description: The state of the Experiment
          enum:
          - Enabled
          - Disabled
          x-ms-enum:
            name: state
            modelAsString: true
    Experiment:
      description: Defines the properties of an Experiment
      properties:
        name:
          description: The name of the Experiment
          type: string
          readOnly: true
        properties:
          description: The properties of an Experiment
          $ref: '#/components/schemas/ExperimentProperties'
          x-ms-client-flatten: true
      allOf:
      - $ref: ./network.json#/definitions/Resource
    DeleteTagsCommand:
      type: object
      properties:
        tags:
          uniqueItems: false
          type: array
          items:
            type: string
    RootError:
      description: The root error.
      type: object
      properties:
        code:
          description: 'The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.'
          type: string
        message:
          description: A human-readable representation of the error.
          type: string
        target:
          description: The target of the error (e.g., the name of the property in error).
          type: string
        details:
          description: The related errors that occurred during the request.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetails'
        innerError:
          $ref: '#/components/schemas/InnerErrorResponse'
          description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand.
    ErrorDetails:
      description: The error details.
      type: object
      properties:
        code:
          description: The error code.
          type: string
        message:
          description: The error message.
          type: string
        target:
          description: The target of the error (e.g., the name of the property in error).
          type: string
    PaginatedExperimentList:
      description: A paginated list of Experiments.
      type: object
      properties:
        value:
          description: An array of objects of type Experiment.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/Experiment_2'
        continuationToken:
          description: The token used in retrieving the next page.  If null, there are no additional pages.
          type: string
        nextLink:
          description: The link to the next page constructed using the continuationToken.  If null, there are no additional pages.
          type: string
    ModifyExperiment:
      type: object
      properties:
        description:
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
        archive:
          type: boolean
    QueryParams:
      description: The set of supported filters.
      type: object
      properties:
        filter:
          description: 'Allows for filtering the collection of resources.

            The expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.

            See https://docs.microsoft.com/en-us/azure/search/query-odata-filter-orderby-syntax for details on the expression syntax.'
          type: string
        continuationToken:
          description: The continuation token to use for getting the next set of resources.
          type: string
        orderBy:
          description: 'The comma separated list of resource properties to use for sorting the requested resources.

            Optionally, can be followed by either ''asc'' or ''desc'''
          type: string
          example: Color, Size desc
        top:
          format: int32
          description: 'The maximum number of items in the resource collection to be included in the result.

            If not specified, all items are returned.'
          type: integer
    InnerErrorResponse:
      description: A nested structure of errors.
      type: object
      properties:
        code:
          description: The error code.
          type: string
        innerError:
          $ref: '#/components/schemas/InnerErrorResponse'
          description: A nested list of inner errors. When evaluating errors, clients MUST traverse through all of the nested “innerErrors” and choose the deepest one that they understand.
    ErrorResponse_2:
      description: The error response.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/RootError'
          description: The top level error that occurred.
        correlation:
          description: Dictionary containing correlation details for the error.
          type: object
          additionalProperties:
            type: string
        environment:
          description: The hosting environment.
          type: string
        location:
          description: The Azure region.
          type: string
        time:
          format: date-time
          description: The time in UTC.
          type: string
    Experiment_2:
      type: object
      properties:
        experimentId:
          type: string
        name:
          type: string
        description:
          type: string
        createdUtc:
          format: date-time
          type: string
        tags:
          type: object
          additionalProperties:
            type: string
        archivedTime:
          format: date-time
          type: string
        latestCreatedRunCreatedUtc:
          format: date-time
          type: string
        latestCreatedRunId:
          type: string
  parameters:
    ExperimentNameParameter:
      name: experimentName
      in: path
      required: true
      x-ms-parameter-location: method
      description: The Experiment identifier associated with the Experiment
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
    ProfileNameParameter:
      name: profileName
      in: path
      required: true
      x-ms-parameter-location: method
      description: The Profile identifier associated with the Tenant and Partner
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      x-ms-parameter-location: method
      description: Name of the Resource group within the Azure subscription.
      schema:
        type: string
        maxLength: 80
        minLength: 1
        pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The Name of the resource group in which the workspace is located.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The Azure Subscription ID.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        format: uuid
    workspaceNameParameter:
      name: workspaceName
      in: path
      description: The name of the workspace.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      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-refined-from:
- networkexperiments-openapi-original.yml
- run-history-apis-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'