Microsoft Azure Modelmanagement API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Modelmanagement API
schemes:
- https
tags:
- name: Modelmanagement
paths:
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}
  : get:
      tags:
      - Modelmanagement
      summary: Microsoft Azure Get A Service
      description: Get a Service by Id.
      operationId: microsoftAzureServicesQuerybyid
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The Service Id.
        required: true
        type: string
      - name: expand
        in: query
        description: Set to True to include Model details.
        required: false
        type: boolean
        default: false
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ServiceResponseBase'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
    delete:
      tags:
      - Modelmanagement
      summary: Microsoft Azure Delete A Service
      description: Delete a specific Service.
      operationId: microsoftAzureServicesDelete
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The Service Id.
        required: true
        type: string
      responses:
        '200':
          description: The resource exists and was deleted successfully.
        '202':
          description: Success
        '204':
          description: The resource does not exist and the request was well formed.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
    patch:
      tags:
      - Modelmanagement
      summary: Microsoft Azure Patch A Service
      description: Patch a specific Service.
      operationId: microsoftAzureServicesPatch
      consumes:
      - application/json-patch+json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The Service Id.
        required: true
        type: string
      - name: patch
        in: body
        description: The payload that is used to patch the Service.
        required: true
        schema:
          uniqueItems: false
          type: array
          items:
            $ref: '#/definitions/JsonPatchOperation'
      responses:
        '200':
          description: Success
        '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'
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services
  : get:
      tags:
      - Modelmanagement
      summary: Microsoft Azure Query The List Of Services In A Workspace
      description: If no filter is passed, the query lists all Services in the Workspace. The returned list is paginated and the count of item in each page is an optional parameter.
      operationId: microsoftAzureServicesListquery
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: imageId
        in: query
        description: The Image Id.
        required: false
        type: string
      - name: imageName
        in: query
        description: The Image name.
        required: false
        type: string
      - name: modelId
        in: query
        description: The Model Id.
        required: false
        type: string
      - name: modelName
        in: query
        description: The Model name.
        required: false
        type: string
      - name: name
        in: query
        description: The object name.
        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: computeType
        in: query
        description: The compute environment type.
        required: false
        type: string
      - name: $skipToken
        in: query
        description: The continuation token to retrieve the next page.
        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: expand
        in: query
        description: Set to True to include Model details.
        required: false
        type: boolean
        default: false
      - name: orderby
        in: query
        description: The option to order the response.
        required: false
        type: string
        default: UpdatedAtDesc
        enum:
        - CreatedAtDesc
        - CreatedAtAsc
        - UpdatedAtDesc
        - UpdatedAtAsc
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedServiceList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
    post:
      tags:
      - Modelmanagement
      summary: Microsoft Azure Create A Service
      description: Create a Service with the specified payload.
      operationId: microsoftAzureServicesCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: request
        in: body
        description: The payload that is used to create the Service.
        required: true
        schema:
          $ref: '#/definitions/CreateServiceRequest'
      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:
  ModelEnvironmentDefinition:
    type: object
    properties:
      name:
        description: The name of the environment.
        type: string
        example: mydevenvironment
      version:
        description: The environment version.
        type: string
        example: '1'
      python:
        $ref: '#/definitions/ModelPythonSection'
        description: Settings for a Python environment.
      environmentVariables:
        description: Definition of environment variables to be defined in the environment.
        type: object
        additionalProperties:
          type: string
      docker:
        $ref: '#/definitions/ModelDockerSection'
        description: The definition of a Docker container.
      spark:
        $ref: '#/definitions/ModelSparkSection'
        description: The configuration for a Spark environment.
      inferencingStackVersion:
        description: The Inferencing stack version.
        type: string
        example: latest
  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'
  PaginatedServiceList:
    description: A paginated list of Services.
    type: object
    properties:
      value:
        description: An array of objects of type Service.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ServiceResponseBase'
      nextLink:
        description: A continuation link (absolute URI) to the next page of results in the list.
        type: string
  AuthKeys:
    type: object
    properties:
      primaryKey:
        description: The primary key.
        type: string
      secondaryKey:
        description: The secondary key.
        type: string
  ContainerRegistry:
    type: object
    properties:
      address:
        type: string
      username:
        type: string
      password:
        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
  JsonPatchOperation:
    description: The Json Patch definition.
    type: object
    properties:
      value:
        description: The value.
        type: object
      path:
        description: The target location.
        type: string
      op:
        description: The operation.
        type: string
      from:
        description: The source location.
        type: string
  CreateServiceRequest:
    description: The base class for creating a service.
    required:
    - name
    - computeType
    type: object
    properties:
      name:
        description: The service name.
        type: string
      description:
        description: The description of the service.
        type: string
      kvTags:
        description: The service tag dictionary. Tags are mutable.
        type: object
        additionalProperties:
          type: string
      properties:
        description: The service properties dictionary. Properties are immutable.
        type: object
        additionalProperties:
          type: string
      keys:
        $ref: '#/definitions/AuthKeys'
        description: The authentication keys.
      computeType:
        description: The compute environment type for the service.
        enum:
        - ACI
        - AKS
        - AMLCOMPUTE
        - IOT
        - AKSENDPOINT
        - UNKNOWN
        type: string
        example: AKS
        x-ms-enum:
          name: ComputeEnvironmentType
          modelAsString: false
      deploymentType:
        description: The deployment type for the service.
        enum:
        - GRPCRealtimeEndpoint
        - HttpRealtimeEndpoint
        - Batch
        type: string
        example: HttpRealtimeEndpoint
        x-ms-enum:
          name: DeploymentType
          modelAsString: false
      imageId:
        description: The Image Id.
        type: string
      environmentImageRequest:
        $ref: '#/definitions/EnvironmentImageRequest'
        description: The Environment, models and assets needed for inferencing.
      location:
        description: The location of the service.
        type: string
    discriminator: computeType
  ModelSparkSection:
    type: object
    properties:
      repositories:
        description: The list of spark repositories.
        uniqueItems: false
        type: array
        items:
          type: string
      packages:
        description: The Spark packages to use.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SparkMavenPackage'
      precachePackages:
        description: Whether to precache the packages.
        type: boolean
        example: 'True'
  SparkMavenPackage:
    type: object
    properties:
      group:
        type: string
      artifact:
        type: string
      version:
        type: string
  ModelDockerSection:
    type: object
    properties:
      baseImage:
        description: Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.
        type: string
        example: ubuntu:latest
      baseDockerfile:
        description: Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.
        type: string
        example: "FROM ubuntu:latest\r\nRUN echo \"Hello world!\""
      enabled:
        description: Set True to perform this run inside a Docker container.
        type: boolean
        example: 'True'
      sharedVolumes:
        description: Set False if necessary to work around shared volume bugs on Windows.
        type: boolean
        example: 'True'
      gpuSupport:
        description: Run with NVidia Docker extension to support GPUs.
        type: boolean
        example: 'False'
      shmSize:
        description: The shared memory size setting for NVidia GPUs.
        type: string
        example: 1g
      arguments:
        description: Extra arguments to the Docker run command.
        uniqueItems: false
        type: array
        items:
          type: string
      baseImageRegistry:
        $ref: '#/definitions/ContainerRegistry'
        description: Image registry that contains the base image.
  EnvironmentImageAsset:
    description: An Image asset.
    type: object
    properties:
      id:
        description: The Asset Id.
        type: string
      mimeType:
        description: The mime type.
        type: string
      url:
        description: The Url of the Asset.
        type: string
      unpack:
        description: Whether the Asset is unpacked.
        type: boolean
  ModelPythonSection:
    type: object
    properties:
      interpreterPath:
        description: The python interpreter path. This is only used when user_managed_dependencies=True.
        type: string
      userManagedDependencies:
        description: True means that AzureML reuses an existing python environment; False means that AzureML will create a python environment based on the Conda dependencies specification.
        type: boolean
      condaDependencies:
        type: object
      baseCondaEnvironment:
        type: string
  ServiceResponseBase:
    description: The base service response. The correct inherited response based on computeType will be returned (ex. ACIServiceResponse)
    required:
    - computeType
    type: object
    properties:
      id:
        description: The service Id.
        type: string
      name:
        description: The service name.
        type: string
      description:
        description: The service description.
        type: string
      kvTags:
        description: The service tag dictionary. Tags are mutable.
        type: object
        additionalProperties:
          type: string
      properties:
        description: The service property dictionary. Properties are immutable.
        type: object
        additionalProperties:
          type: string
      operationId:
        description: The ID of the latest asynchronous operation for this service.
        type: string
      state:
        description: The current state of the service.
        enum:
        - Transitioning
        - Healthy
        - Unhealthy
        - Failed
        type: string
        example: Healthy
        x-ms-enum:
          name: WebServiceState
          modelAsString: false
      createdTime:
        format: date-time
        description: The time the service was created.
        type: string
      updatedTime:
        format: date-time
        description: The time the service was updated.
        type: string
      error:
        $ref: '#/definitions/ModelErrorResponse'
        description: The error details.
      computeType:
        description: The compute environment type for the service.
        enum:
        - ACI
        - AKS
        - AMLCOMPUTE
        - IOT
        - AKSENDPOINT
        - UNKNOWN
        type: string
        example: AKS
        x-ms-enum:
          name: ComputeEnvironmentType
          modelAsString: false
      deploymentType:
        description: The deployment type for the service.
        enum:
        - GRPCRealtimeEndpoint
        - HttpRealtimeEndpoint
        - Batch
        type: string
        example: HttpRealtimeEndpoint
        x-ms-enum:
          name: DeploymentType
          modelAsString: false
    discriminator: computeType
  EnvironmentImageRequest:
    description: Request to create a Docker image based on Environment.
    type: object
    properties:
      driverProgram:
        description: The name of the driver file.
        type: string
      assets:
        description: The list of assets.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/EnvironmentImageAsset'
      modelIds:
        description: The list of model Ids.
        uniqueItems: false
        type: array
        items:
          type: string
        example: '[mymodel:1, mymodel:2]'
      environment:
        $ref: '#/definitions/ModelEnvironmentDefinition'
        description: The details of the AZURE ML environment.
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'