{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-machinelearningservices-artifact","description":"Artifact API","version":"2019-09-30","base_url":"","endpoints":18,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Artifact API\n@version 2019-09-30\n@auth OAuth2\n@common_fields {subscriptionId: any # The Azure Subscription ID., resourceGroupName: any # The Name of the resource group in which the workspace is located., workspaceName: any # The name of the workspace.}\n@endpoints 18\n@toc artifact(18)\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/metadata\n@desc Create Artifact.\n@required {artifact: map # The Artifact details.}\n@returns(200) The Artifact is created successfully.\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/register\n@desc Create an Artifact for an existing data location.\n@required {artifact: map # The Artifact creation details.}\n@returns(200) The Artifact is created successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/metadata\n@desc Get Artifact metadata by Id.\n@required {origin: any # The origin of the Artifact., container: any # The container name., path: any # The Artifact Path.}\n@returns(200) The details of the Artifact are returned successfully.\n\n@endpoint DELETE /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/metadata\n@desc Delete Artifact Metadata.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path., hardDelete: any # If set to true. The delete cannot be revert at later time.}\n@returns(200) The Artifact metadata deleted successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}\n@desc Get Artifacts metadata in a container or path.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path., continuationToken: any # The continuation token.}\n@returns(200) The details of the Artifacts are returned successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/content\n@desc Get Artifact content by Id.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path.}\n@returns(200) File Response\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/content\n@desc Upload Artifact content.\n@required {origin: any # The origin of the Artifact., container: any # The container name., content: str(binary) # The file upload.}\n@optional {path: any # The Artifact Path., index: any # The index., append: any # Whether or not to append the content or replace it., allowOverwrite: any # whether to allow overwrite if Artifact Content exist already. when set to true, Overwrite happens if Artifact Content already exists}\n@returns(200) The Artifact content is uploaded successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/contentinfo\n@desc Get Artifact content information.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path.}\n@returns(200) The Artifact content information is returned successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/contentinfo/storageuri\n@desc Get Artifact storage content information.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path.}\n@returns(200) The Artifact storage content information is returned successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/write\n@desc Get writable shared access signature for Artifact.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path.}\n@returns(200) The Artifact writable shared access signature is returned successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/prefix/contentinfo\n@desc Get shared access signature for an Artifact\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path., continuationToken: any # The continuation token.}\n@returns(200) The Artifact writable shared access signature is returned successfully.\n\n@endpoint GET /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/prefix/contentinfo/storageuri\n@desc Get storage Uri for Artifacts in a path.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {path: any # The Artifact Path., continuationToken: any # The continuation token.}\n@returns(200) The Artifact storage uri is returned successfully.\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/batch/metadata\n@desc Get Batch Artifacts by Ids.\n@required {artifactIds: map # The command for Batch Artifact get request.}\n@returns(200) The requested Batch Artifacts are returned successfully.\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/storageuri/batch/metadata\n@desc Get Batch Artifacts storage by Ids.\n@required {artifactIds: map # The list of artifactIds to get.}\n@returns(200) The Batch Artifact's storage are returned successfully.\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/ingest/containersas\n@desc Batch ingest using shared access signature.\n@required {origin: any # The origin of the Artifact., container: any # The container name., artifactContainerSas: map # The artifact container shared access signature to use for batch ingest.}\n@returns(200) The Batch is ingested using shared access signature successfully.\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/metadata\n@desc Create a batch of empty Artifacts.\n@required {origin: any # The origin of the Artifact., container: any # The container name., artifactPaths: map # The list of Artifact paths to create.}\n@returns(200) The Batch of empty Artifacts created successfully.\n\n@endpoint POST /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/metadata:delete\n@desc Delete Batch of Artifact Metadata.\n@required {origin: any # The origin of the Artifact., container: any # The container name., artifactPaths: map # The list of Artifact paths to delete.}\n@optional {hardDelete: any # If set to true, the delete cannot be reverted at a later time.}\n@returns(200) The batch delete of Artifact metadata completed successfully.\n\n@endpoint DELETE /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch\n@desc Delete Artifact Metadata.\n@required {origin: any # The origin of the Artifact., container: any # The container name.}\n@optional {hardDelete: any # If set to true. The delete cannot be revert at later time.}\n@returns(200) The Artifact metadata deleted successfully.\n\n@end\n"}