openapi-directory/api/azure.com/machinelearningservices-datastore.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"Azure Machine Learning Datastore Management Client","version":"2019-09-30","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-09-30/datastore.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"machinelearningservices-datastore","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"tags":[],"paths":{"/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores":{"delete":{"description":"Delete all Datastores in the workspace.","operationId":"DataStores_DeleteAll","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"}],"responses":{"200":{"description":"All the Datastores in the workspace are deleted successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Delete all Datastores.","tags":["DataStore"]},"get":{"description":"Get the list of Datastores attached to the workspace.","operationId":"DataStores_List","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"},{"description":"List of Datastore names.","in":"query","name":"dataStoreNames","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":false}},{"description":"The Continuation Token.","in":"query","name":"continuationToken","required":false,"schema":{"type":"string"}},{"description":"Count of Datastores to be returned.","in":"query","name":"count","required":false,"schema":{"type":"integer","format":"int32","default":30}},{"description":"Whether to include the datastore secret in the response.","in":"query","name":"includeSecret","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"The list of Datastores are returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDataStoreList"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Get Datastores list.","tags":["DataStore"],"x-ms-pageable":{"nextLinkName":"nextLink"}},"post":{"description":"Create or update a Datastore in the given workspace.","operationId":"DataStores_Create","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"},{"description":"If set to true, the call will create an Datastore if it doesn't exist.","in":"query","name":"createIfNotExists","required":false,"schema":{"type":"boolean","default":false}},{"description":"If set to true, the call will skip Datastore validation.","in":"query","name":"skipValidation","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"$ref":"#/components/requestBodies/DataStore"},"responses":{"200":{"description":"The Datastore is created/updated successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Create or update a Datastore.","tags":["DataStore"]}},"/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}":{"delete":{"description":"Delete a Datastore with a specific name.","operationId":"DataStores_Delete","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"},{"description":"The Datastore name.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The Datastore is deleted successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Delete a Datastore.","tags":["DataStore"]},"get":{"description":"Get details of a Datastore with a specific name.","operationId":"DataStores_Get","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"},{"description":"The Datastore name.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The Datastore details are returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStore"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Get Datastore details.","tags":["DataStore"]},"put":{"description":"Update or create a Datastore in the given workspace.","operationId":"DataStores_Update","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"},{"description":"The Datastore name.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"If set to true, the call will create an Datastore if it doesn't exist.","in":"query","name":"createIfNotExists","required":false,"schema":{"type":"boolean","default":false}},{"description":"If set to true, the call will skip Datastore validation.","in":"query","name":"skipValidation","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"$ref":"#/components/requestBodies/DataStore"},"responses":{"200":{"description":"The Datastore is created/updated successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Update or create a Datastore.","tags":["DataStore"]}},"/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/default":{"get":{"description":"Get the default Datastore in the workspace.","operationId":"DataStores_GetDefault","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"}],"responses":{"200":{"description":"The default Datastore is returned successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStore"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Get the default Datastore.","tags":["DataStoreDefault"]}},"/datastore/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/default/{name}":{"put":{"description":"Set a default Datastore in the workspace.","operationId":"DataStores_SetDefault","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/workspaceNameParameter"},{"description":"The Datastore name.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The default Datastore is set successfully."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Set a default Datastore.","tags":["DataStoreDefault"]}}},"servers":[{"url":"https://azure.local"}],"components":{"parameters":{"resourceGroupNameParameter":{"description":"The Name of the resource group in which the workspace is located.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"subscriptionIdParameter":{"description":"The Azure Subscription ID.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","format":"uuid"}},"workspaceNameParameter":{"description":"The name of the workspace.","in":"path","name":"workspaceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}}},"requestBodies":{"DataStore":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataStore"}}},"description":"The Datastore details."}},"securitySchemes":{"azure_auth":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"AzureDataLake":{"properties":{"authorityUrl":{"description":"The authority URL used for authentication","type":"string"},"certificate":{"description":"The content of the certificate used for authentication","type":"string"},"clientId":{"description":"The Client ID/Application ID","format":"uuid","type":"string"},"clientSecret":{"description":"The client secret","type":"string"},"isCertAuth":{"description":"Is it using certificate to authenticate. If false then use client secret","type":"boolean"},"resourceGroup":{"description":"Resource Group Name","type":"string"},"resourceUri":{"description":"The resource the service principal/app has access to","type":"string"},"storeName":{"description":"The Azure Data Lake store name","type":"string"},"subscriptionId":{"description":"Subscription Id","format":"uuid","type":"string"},"tenantId":{"description":"The ID of the tenant the service principal/app belongs to","format":"uuid","type":"string"},"thumbprint":{"description":"The thumbprint of the certificate above","type":"string"}},"type":"object"},"AzurePostgreSql":{"properties":{"databaseName":{"description":"The Azure PostgreSQL database name","type":"string"},"endpoint":{"description":"The Azure PostgreSQL server host endpoint","type":"string"},"portNumber":{"description":"The Azure PostgreSQL port number","type":"string"},"resourceGroup":{"description":"Resource Group Name","type":"string"},"serverName":{"description":"The Azure PostgreSQL server name","type":"string"},"subscriptionId":{"description":"Subscription Id","format":"uuid","type":"string"},"userId":{"description":"The Azure PostgreSQL user id","type":"string"},"userPassword":{"description":"The Azure PostgreSQL user password","type":"string"}},"type":"object"},"AzureSqlDatabase":{"properties":{"authorityUrl":{"description":"The authority URL used for authentication","type":"string"},"certificate":{"description":"The content of the certificate used for authentication","type":"string"},"clientId":{"description":"The Client ID/Application ID","format":"uuid","type":"string"},"clientSecret":{"description":"The client secret","type":"string"},"databaseName":{"description":"The Azure SQL database name","type":"string"},"endpoint":{"description":"The server host endpoint","type":"string"},"isCertAuth":{"description":"Is it using certificate to authenticate. If false then use client secret","type":"boolean"},"resourceGroup":{"description":"Resource Group Name","type":"string"},"resourceUri":{"description":"The resource the service principal/app has access to","type":"string"},"serverName":{"description":"The Azure SQL server name","type":"string"},"subscriptionId":{"description":"Subscription Id","format":"uuid","type":"string"},"tenantId":{"description":"The ID of the tenant the service principal/app belongs to","format":"uuid","type":"string"},"thumbprint":{"description":"The thumbprint of the certificate above","type":"string"}},"type":"object"},"AzureStorage":{"properties":{"accountKey":{"description":"Storage Account Key (Deprecated)","type":"string"},"accountName":{"description":"Storage Account Name","type":"string"},"areWorkspaceManagedIdentitiesAllowed":{"description":"Indicate if we are using Workspace ManagedIdentities/MSI token","type":"boolean"},"blobCacheTimeout":{"description":"If this is an Microsoft.MachineLearning.DataStore.Contracts.DataStoreType.AzureBlob, the length of time (in seconds) to cache files locally after they are accessed (downloaded).","format":"int32","type":"integer"},"clientCredentials":{"$ref":"#/components/schemas/ClientCredentials"},"containerName":{"description":"The storage container name","type":"string"},"credential":{"description":"The credential","type":"string"},"credentialType":{"description":"The credential type","enum":["None","Sas","AccountKey","ClientCredentials"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"AzureStorageCredentialTypes"}},"endpoint":{"description":"The host of the container","type":"string"},"isSas":{"description":"Indicate if we are using SAS token or Account Key (Deprecated)","type":"boolean"},"protocol":{"description":"The protocol to use. Defaults to https","type":"string"},"resourceGroup":{"description":"Resource Group Name","type":"string"},"sasToken":{"description":"SAS Token for the container (Deprecated)","type":"string"},"subscriptionId":{"description":"Subscription Id","format":"uuid","type":"string"}},"type":"object"},"ClientCredentials":{"properties":{"authorityUrl":{"description":"The authority URL used for authentication","type":"string"},"certificate":{"description":"The content of the certificate used for authentication","type":"string"},"clientId":{"description":"The Client ID/Application ID","format":"uuid","type":"string"},"clientSecret":{"description":"The client secret","type":"string"},"isCertAuth":{"description":"Is it using certificate to authenticate. If false then use client secret","type":"boolean"},"resourceGroup":{"description":"Resource Group Name","type":"string"},"resourceUri":{"description":"The resource the service principal/app has access to","type":"string"},"subscriptionId":{"description":"Subscription Id","format":"uuid","type":"string"},"tenantId":{"description":"The ID of the tenant the service principal/app belongs to","format":"uuid","type":"string"},"thumbprint":{"description":"The thumbprint of the certificate above","type":"string"}},"type":"object"},"DataStore":{"properties":{"azureDataLakeSection":{"$ref":"#/components/schemas/AzureDataLake"},"azurePostgreSqlSection":{"$ref":"#/components/schemas/AzurePostgreSql"},"azureSqlDatabaseSection":{"$ref":"#/components/schemas/AzureSqlDatabase"},"azureStorageSection":{"$ref":"#/components/schemas/AzureStorage"},"dataStoreType":{"description":"The Azure storage service this datastore points to.","enum":["AzureBlob","AzureFile","AzureDataLake","AzureSqlDatabase","AzurePostgreSql","DBFS","AzureDataLakeGen2","GlusterFs"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"DataStoreType"}},"glusterFsSection":{"$ref":"#/components/schemas/GlusterFs"},"hasBeenValidated":{"description":"A read only property that denotes whether the service datastore has been validated with credentials.","type":"boolean"},"name":{"description":"Name of the datastore","type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Tags to datastore","type":"object"}},"type":"object"},"ErrorDetails":{"description":"The error details.","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"}},"type":"object"},"ErrorResponse":{"description":"The error response.","properties":{"correlation":{"additionalProperties":{"type":"string"},"description":"Dictionary containing correlation details for the error.","type":"object"},"environment":{"description":"The hosting environment.","type":"string"},"error":{"$ref":"#/components/schemas/RootError"},"location":{"description":"The Azure region.","type":"string"},"time":{"description":"The time in UTC.","format":"date-time","type":"string"}},"type":"object"},"GlusterFs":{"properties":{"serverAddress":{"description":"The server address of one of the servers that hosts the GlusterFS. Can be either the IP address\r\nor server name.","type":"string"},"volumeName":{"description":"The name of the created GlusterFS volume.","type":"string"}},"type":"object"},"InnerErrorResponse":{"description":"A nested structure of errors.","properties":{"code":{"description":"The error code.","type":"string"},"innerError":{"$ref":"#/components/schemas/InnerErrorResponse"}},"type":"object"},"PaginatedDataStoreList":{"description":"A paginated list of DataStores.","properties":{"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"},"value":{"description":"An array of objects of type DataStore.","items":{"$ref":"#/components/schemas/DataStore"},"type":"array","uniqueItems":false}},"type":"object"},"RootError":{"description":"The root error.","properties":{"code":{"description":"The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.","type":"string"},"details":{"description":"The related errors that occurred during the request.","items":{"$ref":"#/components/schemas/ErrorDetails"},"type":"array","uniqueItems":false},"innerError":{"$ref":"#/components/schemas/InnerErrorResponse"},"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"}},"type":"object"}}}}