swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Profile API
schemes:
- https
tags:
- name: Profile
paths:
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles/{id}
  : get:
      tags:
      - Profile
      summary: Microsoft Azure Get A Profile
      description: Get the Profile for an Image.
      operationId: microsoftAzureProfilesQuerybyid
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: imageId
        in: path
        description: The Image Id.
        required: true
        type: string
      - name: id
        in: path
        description: The Profile Id.
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ProfileResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles
  : get:
      tags:
      - Profile
      summary: Microsoft Azure Get A List Of Image Profiles
      description: If no filter is passed, the query lists all Profiles for the Image. The returned list is paginated and the count of items in each page is an optional parameter.
      operationId: microsoftAzureProfilesListquery
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: imageId
        in: path
        description: The Image Id.
        required: true
        type: string
      - name: name
        in: query
        description: The Profile name.
        required: false
        type: string
      - name: description
        in: query
        description: The Profile description.
        required: false
        type: string
      - name: tags
        in: query
        description: "A set of tags with which to filter the returned models.\r\n            It is a comma separated string of tags key or tags key=value\r\n            Example: tagKey1,tagKey2,tagKey3=value3"
        required: false
        type: string
      - name: properties
        in: query
        description: "A set of properties with which to filter the returned models.\r\n            It is a comma separated string of properties key and/or properties key=value\r\n            Example: propKey1,propKey2,propKey3=value3"
        required: false
        type: string
      - name: count
        in: query
        description: The number of items to retrieve in a page.
        required: false
        type: integer
        format: int32
      - name: $skipToken
        in: query
        description: The continuation token to retrieve the next page.
        required: false
        type: string
      - name: orderBy
        in: query
        description: The option to order the response.
        required: false
        type: string
        default: CreatedAtDesc
        enum:
        - CreatedAtDesc
        - CreatedAtAsc
        - UpdatedAtDesc
        - UpdatedAtAsc
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedProfileResponseList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
    post:
      tags:
      - Profile
      summary: Microsoft Azure Create A Profile
      description: Create a Profile for an Image.
      operationId: microsoftAzureProfilesCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: imageId
        in: path
        description: The Image Id.
        required: true
        type: string
      - name: inputRequest
        in: body
        description: The payload that is used to create the Profile.
        required: true
        schema:
          $ref: '#/definitions/ProfileRequestBase'
      responses:
        '202':
          description: The request was accepted. The header 'Operation-Location' contains the async operation location URL. Accessing this URL with a GET call will return the status of the background task.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
definitions:
  ModelErrorResponse:
    description: The Model Management Service Error object.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      statusCode:
        format: int32
        description: The HTTP status code.
        type: integer
      message:
        description: The error message.
        type: string
      details:
        description: An array of error detail objects.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ErrorDetails'
  ProfileRequestBase:
    description: The request for creating a profile.
    required:
    - name
    type: object
    properties:
      name:
        description: The profile name.
        type: string
      description:
        description: The profile description.
        type: string
      inputData:
        description: The profile input data.
        type: string
      kvTags:
        description: The tags dictionary.
        type: object
        additionalProperties:
          type: string
      properties:
        description: The properties dictionary.
        type: object
        additionalProperties:
          type: string
  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
  ProfileResponse:
    description: The profile response.
    type: object
    properties:
      name:
        description: The profile name.
        type: string
      description:
        description: The profile description.
        type: string
      imageId:
        description: The Image Id.
        type: string
      inputData:
        description: The input data.
        type: string
      state:
        description: The state of the profile.
        type: string
      createdTime:
        format: date-time
        description: The profile creation time (UTC).
        type: string
      kvTags:
        description: The profile tags dictionary. Tags are mutable.
        type: object
        additionalProperties:
          type: string
      properties:
        description: The profile properties dictionary. Properties are immutable.
        type: object
        additionalProperties:
          type: string
      recommendedMemoryInGB:
        format: double
        description: The recommended amount of memory to allocate in GB.
        type: number
      recommendedCpu:
        format: double
        description: The recommended CPU allocation.
        type: number
      recommendationLatencyInMs:
        format: double
        description: Latency associated with the recommended memory/cpu config
        type: number
      profileRunResult:
        description: The profile run result.
        type: string
      error:
        $ref: '#/definitions/ModelErrorResponse'
        description: The error details.
      profilingErrorLogs:
        description: The profiling error logs.
        type: string
  PaginatedProfileResponseList:
    description: A paginated list of ProfileResponses.
    type: object
    properties:
      value:
        description: An array of objects of type ProfileResponse.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ProfileResponse'
      nextLink:
        description: A continuation link (absolute URI) to the next page of results in the list.
        type: string
parameters:
  workspaceParameter:
    name: workspace
    in: path
    description: The name of the workspace.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Azure Subscription ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  resourceGroupParameter:
    name: resourceGroup
    in: path
    description: The Name of the resource group in which the workspace is located.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'