@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Azure Machine Learning Model Management Service
@version 2019-09-30
@auth OAuth2
@common_fields {subscriptionId: any # The Azure Subscription ID., resourceGroup: any # The Name of the resource group in which the workspace is located., workspace: any # The name of the workspace.}
@endpoints 23
@hint download_for_search
@toc modelmanagement(23)

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets
@desc Query the list of Assets in a workspace.
@optional {runId: any # The run Id associated with the Assets., name: any # The object name., count: any # The number of items to retrieve in a page., $skipToken: any # The continuation token to retrieve the next page., tags: any # A set of tags with which to filter the returned models.
             It is a comma separated string of tags key or tags key=value
             Example: tagKey1,tagKey2,tagKey3=value3, properties: any # A set of properties with which to filter the returned models.
             It is a comma separated string of properties key and/or properties key=value
             Example: propKey1,propKey2,propKey3=value3, orderby: any # An option for specifying how to order the list.}
@returns(200) Success

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets
@desc Create an Asset.
@optional {asset: map # The Asset to be created.}
@returns(200) Success

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets/{id}
@desc Get an Asset.
@required {id: any # The Asset Id.}
@returns(200) Success

@endpoint DELETE /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets/{id}
@desc Delete an Asset.
@required {id: any # The Id of the Asset to delete.}
@returns(200) The resource exists and was deleted successfully.
@returns(204) The resource does not exist and the request was well formed.

@endpoint PATCH /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/assets/{id}
@desc Update an Asset.
@required {id: any # The Id of the Asset to patch., patch: [map] # The payload that is used to patch an Asset.}
@returns(200) Success

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}
@desc Gets a model.
@required {id: any # The model id.}
@returns(200) Success

@endpoint DELETE /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}
@desc Delete the specified Model.
@required {id: any # The model id.}
@returns(200) The resource exists and was deleted successfully.
@returns(204) The resource does not exist and the request was well formed.

@endpoint PATCH /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}
@desc Patch a specific model.
@required {id: any # The model id., patch: [map] # The payload that is used to patch the model.}
@returns(200) Success

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models
@desc Query the list of Models in a workspace.
@optional {name: any # The object name., framework: any # The framework., description: any # The object description., count: any # The number of items to retrieve in a page., $skipToken: any # The continuation token to retrieve the next page., tags: any # A set of tags with which to filter the returned models.
             It is a comma separated string of tags key or tags key=value
             Example: tagKey1,tagKey2,tagKey3=value3, properties: any # A set of properties with which to filter the returned models.
             It is a comma separated string of properties key and/or properties key=value
             Example: propKey1,propKey2,propKey3=value3, runId: any # The runId which created the model., orderBy: any # An option to specify how the models are ordered in the response.}
@returns(200) Success

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models
@desc Register a model.
@required {model: map # The payload that is used to register the model.}
@returns(200) The model registration was successful.

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}/metrics
@desc Retrieve the metrics for a Model.
@required {id: any # The Model Id.}
@optional {startDate: any # The start date from which to retrieve metrics, ISO 8601 literal format., endDate: any # The end date from which to retrieve metrics, ISO 8601 literal format.}
@returns(200) Success

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/operations/{id}
@desc Get the status of an async operation.
@required {id: any # The operation id.}
@returns(200) Success

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles/{id}
@desc Get a Profile.
@required {imageId: any # The Image Id., id: any # The Profile Id.}
@returns(200) Success

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles
@desc Get a list of Image Profiles.
@required {imageId: any # The Image Id.}
@optional {name: any # The Profile name., description: any # The Profile description., tags: any # A set of tags with which to filter the returned models.
             It is a comma separated string of tags key or tags key=value
             Example: tagKey1,tagKey2,tagKey3=value3, properties: any # A set of properties with which to filter the returned models.
             It is a comma separated string of properties key and/or properties key=value
             Example: propKey1,propKey2,propKey3=value3, count: any # The number of items to retrieve in a page., $skipToken: any # The continuation token to retrieve the next page., orderBy: any # The option to order the response.}
@returns(200) Success

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/images/{imageId}/profiles
@desc Create a Profile.
@required {imageId: any # The Image Id., inputRequest: map # The payload that is used to create the Profile.}
@returns(202) 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.

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}
@desc Get a Service.
@required {id: any # The Service Id.}
@optional {expand: any # Set to True to include Model details.}
@returns(200) Success

@endpoint DELETE /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}
@desc Delete a Service.
@required {id: any # The Service Id.}
@returns(200) The resource exists and was deleted successfully.
@returns(202) Success
@returns(204) The resource does not exist and the request was well formed.

@endpoint PATCH /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}
@desc Patch a Service.
@required {id: any # The Service Id., patch: [map] # The payload that is used to patch the Service.}
@returns(200) Success
@returns(202) 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.

@endpoint GET /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services
@desc Query the list of Services in a Workspace.
@optional {imageId: any # The Image Id., imageName: any # The Image name., modelId: any # The Model Id., modelName: any # The Model name., name: any # The object name., count: any # The number of items to retrieve in a page., computeType: any # The compute environment type., $skipToken: any # The continuation token to retrieve the next page., tags: any # A set of tags with which to filter the returned models.
             It is a comma separated string of tags key or tags key=value
             Example: tagKey1,tagKey2,tagKey3=value3, properties: any # A set of properties with which to filter the returned models.
             It is a comma separated string of properties key and/or properties key=value
             Example: propKey1,propKey2,propKey3=value3, expand: any # Set to True to include Model details., orderby: any # The option to order the response.}
@returns(200) Success

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services
@desc Create a Service.
@required {request: map # The payload that is used to create the Service.}
@returns(202) 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.

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/listkeys
@desc Lists Service keys.
@required {id: any # The Service Id.}
@returns(200) Success

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/regenerateKeys
@desc Regenerate Service Keys.
@required {id: any # The Service Id., request: map # The payload that is used to regenerate keys.}
@returns(200) Success
@returns(202) 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.

@endpoint POST /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/services/{id}/token
@desc Generate Service Access Token.
@required {id: any # The Service Id.}
@returns(201) Success

@end