{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-machinelearningservices-machinelearningservices","description":"Azure Machine Learning Workspaces","version":"2019-06-01","base_url":"https://management.azure.com","endpoints":20,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Azure Machine Learning Workspaces\n@base https://management.azure.com\n@version 2019-06-01\n@auth OAuth2\n@common_fields {api-version: any # Version of Azure Machine Learning resource provider API., subscriptionId: any # Azure subscription identifier.}\n@endpoints 20\n@toc providers(1), subscriptions(19)\n\n@group providers\n@endpoint GET /providers/Microsoft.MachineLearningServices/operations\n@desc Lists all of the available Azure Machine Learning Workspaces REST API operations.\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n@desc Gets the properties of the specified machine learning workspace.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n@desc Creates or updates a workspace with the specified parameters.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., parameters: map # The parameters for creating or updating a machine learning workspace.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n@returns(201) The request was successful; the request was well-formed and received properly.\n@returns(202) The request was successful; the request was well-formed and received properly.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n@desc Deletes a machine learning workspace.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n@returns(202) The request was accepted; the request was well-formed and received properly.\n@returns(204) The machine learning workspace does not exist in the subscription.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n@desc Updates a machine learning workspace with the specified parameters.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., parameters: any # The parameters for updating a machine learning workspace.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces\n@desc Lists all the available machine learning workspaces under the specified resource group.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located.}\n@optional {$skiptoken: any # Continuation token for pagination.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys\n@desc Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys\n@desc Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages\n@desc Gets the current usage information as well as limits for AML resources for given subscription and location.\n@required {location: any # The location for which resource usage is queried.}\n@optional {expandChildren: any # Specifies if detailed usages of child resources are required.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes\n@desc Returns supported VM Sizes in a location\n@required {location: any # The location upon which virtual-machine-sizes is queried.}\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas\n@desc Update quota for each VM family in workspace.\n@required {location: any # The location for update quota is queried., parameters: any # Quota update parameters.}\n@returns(200) The operation was successful.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/Quotas\n@desc Gets the currently assigned Workspace Quotas based on VMFamily.\n@required {location: any # The location for which resource usage is queried.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces\n@desc Lists all the available machine learning workspaces under the specified subscription.\n@optional {$skiptoken: any # Continuation token for pagination.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes\n@desc Gets computes in specified workspace.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace.}\n@optional {$skiptoken: any # Continuation token for pagination.}\n@returns(200) The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n@desc Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., computeName: any # Name of the Azure Machine Learning compute.}\n@returns(200) Success.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n@desc Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., computeName: any # Name of the Azure Machine Learning compute., parameters: map # Payload with Machine Learning compute definition.}\n@returns(200) Compute creation or update initiated.\n@returns(201) Compute creation or update initiated.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n@desc Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., computeName: any # Name of the Azure Machine Learning compute., parameters: any # Additional parameters for cluster update.}\n@returns(200) Compute update initiated.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n@desc Deletes specified Machine Learning compute.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., computeName: any # Name of the Azure Machine Learning compute., underlyingResourceAction: any # Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.}\n@returns(200) The request was successful; the request was well-formed and received properly.\n@returns(202) Compute deletion initiated.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes\n@desc Get the details (e.g IP address, port etc) of all the compute nodes in the compute.\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., computeName: any # Name of the Azure Machine Learning compute.}\n@returns(200) The operation was successful. The response contains the list of IP addresses.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys\n@desc Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).\n@required {resourceGroupName: any # Name of the resource group in which workspace is located., workspaceName: any # Name of Azure Machine Learning workspace., computeName: any # Name of the Azure Machine Learning compute.}\n@returns(200) Success.\n\n@endgroup\n\n@end\n"}