Microsoft Azure Experiments API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Experiments API
  description: The configuration of the Network Experiment experiments
schemes:
- https
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
      produces:
      - application/json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ProfileNameParameter'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ExperimentList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
  : get:
      tags:
      - Experiments
      summary: Microsoft Azure Gets An Experiment By Experimentname
      operationId: microsoftAzureExperimentsGet
      produces:
      - application/json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ProfileNameParameter'
      - $ref: '#/parameters/ExperimentNameParameter'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Experiment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ProfileNameParameter'
      - $ref: '#/parameters/ExperimentNameParameter'
      - description: The Experiment resource
        in: body
        name: parameters
        required: true
        schema:
          $ref: '#/definitions/Experiment'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/Experiment'
        '201':
          description: Created. The request has been fulfilled and a new experiment has been created.
          schema:
            $ref: '#/definitions/Experiment'
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
          schema:
            $ref: '#/definitions/Experiment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates an Experiment:
          $ref: ./examples/NetworkExperimentCreateExperiment.json
      description: Needs a more full description created.
    patch:
      tags:
      - Experiments
      description: Updates an Experiment
      summary: Microsoft Azure Updates An Experiment By Experiment Id
      operationId: microsoftAzureExperimentsUpdate
      produces:
      - application/json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ProfileNameParameter'
      - $ref: '#/parameters/ExperimentNameParameter'
      - in: body
        name: parameters
        description: The Experiment Update Model
        required: true
        schema:
          $ref: '#/definitions/ExperimentUpdateModel'
      responses:
        '200':
          description: OK. successful operation
          schema:
            $ref: '#/definitions/Experiment'
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
          schema:
            $ref: '#/definitions/Experiment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Updates an Experiment:
          $ref: ./examples/NetworkExperimentUpdateExperiment.json
    delete:
      tags:
      - Experiments
      summary: Microsoft Azure Deletes An Experiment
      operationId: microsoftAzureExperimentsDelete
      produces:
      - application/json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ProfileNameParameter'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Deletes an Experiment:
          $ref: ./examples/NetworkExperimentDeleteExperiment.json
      description: Needs a more full description created.
  ? /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: microsoftAzureExperimentsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: experimentName
        in: path
        description: The experiment name.
        required: true
        type: string
      responses:
        '200':
          description: The details of the Experiment are returned successfully.
          schema:
            $ref: '#/definitions/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
    post:
      tags:
      - Experiments
      summary: Microsoft Azure Create An Experiment
      description: Create a new Experiment.
      operationId: microsoftAzureExperimentsCreate
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: experimentName
        in: path
        description: The experiment name.
        required: true
        type: string
      responses:
        '200':
          description: The Experiment is created successfully.
          schema:
            $ref: '#/definitions/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: experimentId
        in: path
        description: The identifier of the experiment.
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
    patch:
      tags:
      - Experiments
      summary: Microsoft Azure Update Details Of An Experiment
      description: Update details of an Experiment with specific Experiment Id.
      operationId: microsoftAzureExperimentsUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: experimentId
        in: path
        description: The identifier of the experiment.
        required: true
        type: string
      - name: modifyExperimentDto
        in: body
        description: Experiment details which needs to be updated.
        required: false
        schema:
          $ref: '#/definitions/ModifyExperiment'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
  ? /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
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: queryParams
        in: body
        description: Query parameters for data sorting and filtering.
        required: false
        schema:
          $ref: '#/definitions/QueryParams'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedExperimentList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /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
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: experimentId
        in: path
        description: The identifier of the experiment.
        required: true
        type: string
      - name: tags
        in: body
        description: The requested tags list to be deleted.
        required: false
        schema:
          $ref: '#/definitions/DeleteTagsCommand'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Experiment_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
definitions:
  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
  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: '#/definitions/ExperimentUpdateProperties'
        x-ms-client-flatten: true
  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
  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: '#/definitions/ErrorDetails'
      innerError:
        $ref: '#/definitions/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.
  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
  DeleteTagsCommand:
    type: object
    properties:
      tags:
        uniqueItems: false
        type: array
        items:
          type: string
  ErrorResponse_2:
    description: The error response.
    type: object
    properties:
      error:
        $ref: '#/definitions/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
  ModifyExperiment:
    type: object
    properties:
      description:
        type: string
      tags:
        type: object
        additionalProperties:
          type: string
      archive:
        type: boolean
  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: '#/definitions/ExperimentProperties'
        x-ms-client-flatten: true
    allOf:
    - $ref: ./network.json#/definitions/Resource
  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
  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
  QueryParams:
    description: The set of supported filters.
    type: object
    properties:
      filter:
        description: "Allows for filtering the collection of resources.\r\nThe expression specified is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response.\r\nSee 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.\r\nOptionally, 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.\r\nIf not specified, all items are returned."
        type: integer
  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: '#/definitions/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.
  InnerErrorResponse:
    description: A nested structure of errors.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      innerError:
        $ref: '#/definitions/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.
  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
  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: '#/definitions/Endpoint'
      endpointB:
        description: The endpoint B of an experiment
        $ref: '#/definitions/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: '#/definitions/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
  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: '#/definitions/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
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The Name of the resource group in which the workspace is located.
    required: true
    type: string
    x-ms-parameter-location: method
  ProfileNameParameter:
    name: profileName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
    x-ms-parameter-location: method
    description: The Profile identifier associated with the Tenant and Partner
  workspaceNameParameter:
    name: workspaceName
    in: path
    description: The name of the workspace.
    required: true
    type: string
    x-ms-parameter-location: method
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
    minLength: 1
    maxLength: 80
    x-ms-parameter-location: method
    description: Name of the Resource group within the Azure subscription.
  ExperimentNameParameter:
    name: experimentName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
    x-ms-parameter-location: method
    description: The Experiment identifier associated with the Experiment
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Azure Subscription ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'