{"files":{"SKILL.md":"---\nname: azure-machine-learning-workspaces\ndescription: \"Azure Machine Learning Workspaces API skill. Use when working with Azure Machine Learning Workspaces for providers, subscriptions. Covers 20 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Azure Machine Learning Workspaces\nAPI version: 2019-06-01\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://management.azure.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /providers/Microsoft.MachineLearningServices/operations -- lists all of the available azure machine learning workspaces rest api operations.\n3. POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys -- create first listKey\n\n## Endpoints\n20 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Providers\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /providers/Microsoft.MachineLearningServices/operations | Lists all of the available Azure Machine Learning Workspaces REST API operations. |\n\n### Subscriptions\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName} | Gets the properties of the specified machine learning workspace. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName} | Creates or updates a workspace with the specified parameters. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName} | Deletes a machine learning workspace. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName} | Updates a machine learning workspace with the specified parameters. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces | Lists all the available machine learning workspaces under the specified resource group. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys | Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys | Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages | Gets the current usage information as well as limits for AML resources for given subscription and location. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes | Returns supported VM Sizes in a location |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas | Update quota for each VM family in workspace. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/Quotas | Gets the currently assigned Workspace Quotas based on VMFamily. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces | Lists all the available machine learning workspaces under the specified subscription. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes | Gets computes in specified workspace. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName} | Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName} | 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| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName} | Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName} | Deletes specified Machine Learning compute. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes | Get the details (e.g IP address, port etc) of all the compute nodes in the compute. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys | Gets secrets related to Machine Learning compute (storage keys, service credentials, etc). |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all operations?\" -> GET /providers/Microsoft.MachineLearningServices/operations\n- \"Get workspace details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n- \"Update a workspace?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n- \"Delete a workspace?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n- \"Partially update a workspace?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}\n- \"List all workspaces?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces\n- \"Create a listKey?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys\n- \"Create a resyncKey?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys\n- \"List all usages?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages\n- \"List all vmSizes?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes\n- \"Create a updateQuota?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas\n- \"List all Quotas?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/Quotas\n- \"List all computes?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes\n- \"Get compute details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n- \"Update a compute?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n- \"Partially update a compute?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n- \"Delete a compute?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}\n- \"Create a listNode?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@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"}}