From 8feb7d84319124ff3a447daffef894da18ef0077 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 14:12:59 -0700 Subject: [PATCH] Revert back to old file with only reorder for better compare --- .../2023-06-01-preview/workspaceRP.json | 2304 +++++++---------- 1 file changed, 964 insertions(+), 1340 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index c7b35d5bf195..e9af6316eddb 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json @@ -28,16 +28,18 @@ "tags": [ "Operation" ], - "summary": "Lists all of the available Azure Machine Learning Workspaces REST API operations", + "description": "Lists all of the available Azure Machine Learning Services REST API operations.", "operationId": "Operations_List", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/Workspace/operationsList.json" + } + }, "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", @@ -46,17 +48,12 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "OperationsList": { - "$ref": "./examples/Workspace/operationsList.json" - } - }, "x-ms-pageable": { "nextLinkName": null } @@ -67,17 +64,19 @@ "tags": [ "Workspaces" ], - "summary": "Lists all the available machine learning workspaces under the specified subscription.", + "description": "Lists all the available machine learning workspaces under the specified subscription.", "operationId": "Workspaces_ListBySubscription", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/Workspace/listBySubscription.json" + } + }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/PaginationParameter" @@ -94,17 +93,12 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "Get Workspaces by subscription": { - "$ref": "./examples/Workspace/listBySubscription.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -115,20 +109,22 @@ "tags": [ "Workspaces" ], - "summary": "Lists all the available machine learning workspaces under the specified resource group.", + "description": "Lists all the available machine learning workspaces under the specified resource group.", "operationId": "Workspaces_ListByResourceGroup", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/Workspace/listByResourceGroup.json" + } + }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/PaginationParameter" @@ -145,17 +141,12 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "Get Workspaces by Resource Group": { - "$ref": "./examples/Workspace/listByResourceGroup.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -166,12 +157,18 @@ "tags": [ "Workspaces" ], - "summary": "Deletes a machine learning workspace.", + "description": "Deletes a machine learning workspace.", "operationId": "Workspaces_Delete", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/Workspace/delete.json" + } + }, + "x-ms-long-running-operation": true, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -181,47 +178,43 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/WorkspaceForceToPurgeParameter" } ], "responses": { "200": { - "description": "Success" + "description": "The request was successful; the request was well-formed and received properly." }, "202": { - "description": "Accepted" + "description": "The request was accepted; the request was well-formed and received properly." }, "204": { - "description": "No Content" + "description": "The machine learning workspace does not exist in the subscription." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Delete Workspace": { - "$ref": "./examples/Workspace/delete.json" - } - }, - "x-ms-long-running-operation": true + } }, "get": { "tags": [ "Workspaces" ], - "summary": "Gets the properties of the specified machine learning workspace.", + "description": "Gets the properties of the specified machine learning workspace.", "operationId": "Workspaces_Get", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -230,9 +223,6 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -243,31 +233,29 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Get Workspace": { - "$ref": "./examples/Workspace/get.json" - } } }, "patch": { "tags": [ "Workspaces" ], - "summary": "Updates a machine learning workspace with the specified parameters.", + "description": "Updates a machine learning workspace with the specified parameters.", "operationId": "Workspaces_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -278,11 +266,8 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { + "name": "parameters", "in": "body", - "name": "body", "description": "The parameters for updating a machine learning workspace.", "required": true, "schema": { @@ -298,35 +283,32 @@ } }, "202": { - "description": "Accepted" + "description": "The request was successful; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Update Workspace": { - "$ref": "./examples/Workspace/update.json" - } - }, - "x-ms-long-running-operation": true + } }, "put": { "tags": [ "Workspaces" ], - "summary": "Creates or updates a workspace with the specified parameters.", + "description": "Creates or updates a workspace with the specified parameters.", "operationId": "Workspaces_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -337,11 +319,8 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { + "name": "parameters", "in": "body", - "name": "body", "description": "The parameters for creating or updating a machine learning workspace.", "required": true, "schema": { @@ -357,49 +336,23 @@ } }, "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } + "description": "The request was successful; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Create Workspace": { - "$ref": "./examples/Workspace/create.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { "get": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], - "summary": "Lists all the available machine learning workspaces connections under the specified workspace.", "operationId": "WorkspaceConnections_List", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -408,7 +361,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/TargetParameter" @@ -447,13 +400,9 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { "delete": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], - "summary": "Delete machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Delete", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -462,7 +411,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -472,17 +421,17 @@ } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "Success" } }, "x-ms-examples": { @@ -493,13 +442,9 @@ }, "get": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], - "summary": "Lists machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Get", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -508,7 +453,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -537,18 +482,11 @@ } } }, - "patch": { + "put": { "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Update", - "summary": "Update machine learning workspaces connections under the specified workspace.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "V2WorkspaceConnectionResource" ], + "operationId": "WorkspaceConnections_Create", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -557,7 +495,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -566,11 +504,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { + "name": "parameters", "in": "body", - "name": "body", - "description": "Parameters for workspace connection update.", + "description": "The object for creating or updating a new workspace connection", + "required": true, "schema": { - "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } } ], @@ -589,17 +528,19 @@ } }, "x-ms-examples": { - "UpdateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/update.json" + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { "tags": [ - "WorkspaceConnectionV2Resource" + "Workspaces" ], - "summary": "Create or update machine learning workspaces connections under the specified workspace.", - "operationId": "WorkspaceConnections_Create", + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", "consumes": [ "application/json" ], @@ -616,26 +557,39 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/ConnectionName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", - "name": "body", - "description": "The object for creating or updating a new workspace connection", + "name": "parameters", + "description": "The parameter of diagnosing workspace health", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/DiagnoseWorkspaceParameters" } } ], "responses": { + "202": { + "description": "Success", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/DiagnoseResponseResult" } }, "default": { @@ -646,74 +600,32 @@ } }, "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { "post": { "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_ListSecrets", - "summary": "List all the secrets of a machine learning workspaces connections.", - "produces": [ - "application/json" + "Workspaces" ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/listSecrets.json" + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Diagnose workspace setup issue.", - "operationId": "Workspaces_Diagnose", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -722,71 +634,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The parameter of diagnosing workspace health", - "schema": { - "$ref": "#/definitions/DiagnoseWorkspaceParameters" - } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "$ref": "#/definitions/ListWorkspaceKeysResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Diagnose Workspace": { - "$ref": "./examples/Workspace/diagnose.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { "post": { "tags": [ - "ProxyOperations" - ], - "summary": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.", - "operationId": "Workspaces_ListKeys", - "produces": [ - "application/json" + "Workspaces" ], + "description": "return notebook access token and refresh token", + "operationId": "Workspaces_ListNotebookAccessToken", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listNotebookAccessToken.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -795,43 +676,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListWorkspaceKeysResult" + "$ref": "#/definitions/NotebookAccessTokenResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listKeys.json" - } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { "post": { "tags": [ "ProxyOperations" ], - "summary": "Get Azure Machine Learning Workspace notebook access token", - "operationId": "Workspaces_ListNotebookAccessToken", - "produces": [ - "application/json" - ], + "operationId": "Workspaces_ListNotebookKeys", + "description": "List keys of a notebook.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -840,43 +718,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/NotebookAccessTokenResult" + "$ref": "#/definitions/ListNotebookKeysResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listNotebookAccessToken.json" - } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { "post": { "tags": [ "ProxyOperations" ], - "summary": "Lists keys of Azure Machine Learning Workspaces notebook.", - "operationId": "Workspaces_ListNotebookKeys", - "produces": [ - "application/json" - ], + "operationId": "Workspaces_ListStorageAccountKeys", + "description": "List storage account keys of a workspace.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -885,39 +760,31 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListNotebookKeysResult" + "$ref": "#/definitions/ListStorageAccountKeysResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Notebook/listKeys.json" - } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { "tags": [ - "ProxyOperations" + "OutboundNetworkDependenciesEndpoints" ], - "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", - "operationId": "Workspaces_ListStorageAccountKeys", + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", "produces": [ "application/json" ], @@ -937,9 +804,9 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { - "$ref": "#/definitions/ListStorageAccountKeysResult" + "$ref": "#/definitions/ExternalFQDNResponse" } }, "default": { @@ -950,19 +817,19 @@ } }, "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.json" + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { "get": { "tags": [ - "OutboundNetworkDependenciesEndpoints" + "ManagedNetwork" ], - "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_List", "produces": [ "application/json" ], @@ -982,9 +849,9 @@ ], "responses": { "200": { - "description": "Success", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ExternalFQDNResponse" + "$ref": "#/definitions/OutboundRuleListResult" } }, "default": { @@ -994,23 +861,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ListOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ExternalFQDN/get.json" + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { "tags": [ "ManagedNetwork" ], - "summary": "Lists the managed network outbound rules for a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_List", - "produces": [ - "application/json" - ], + "description": "Deletes an outbound rule from the managed network of a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_Delete", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1021,17 +888,29 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "#/parameters/RuleName" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleListResult" + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } } }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, "default": { "description": "Error", "schema": { @@ -1040,25 +919,21 @@ } }, "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + }, "get": { "tags": [ "ManagedNetwork" ], + "description": "Gets an outbound rule from the managed network of a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_Get", - "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1100,14 +975,8 @@ "tags": [ "ManagedNetwork" ], + "description": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", - "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1125,38 +994,31 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { + "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", "in": "body", - "name": "body", + "name": "parameters", "required": true, - "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", "schema": { "$ref": "#/definitions/OutboundRuleBasicResource" } } ], "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - }, "202": { "description": "Accepted", "headers": { "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } }, + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, "default": { "description": "Error", "schema": { @@ -1180,12 +1042,21 @@ "tags": [ "ProxyOperations" ], - "summary": "Prepare Azure Machine Learning Workspace's notebook resource", "operationId": "Workspaces_PrepareNotebook", - "produces": [ - "application/json" - ], + "description": "Prepare a notebook.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1194,66 +1065,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { "$ref": "#/definitions/NotebookResourceInfo" } }, "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } + "description": "The request was successful; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Prepare Notebook": { - "$ref": "./examples/Notebook/prepare.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { "get": { "tags": [ - "WorkspacePrivateEndpointConnections" + "PrivateEndpointConnections" ], - "summary": "Called by end-users to get all PE connections.", "operationId": "PrivateEndpointConnections_List", - "produces": [ - "application/json" - ], + "description": "List all the private endpoint connections associated with the workspace.", + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, @@ -1262,27 +1107,25 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "OK -- Successfully retrieved private endpoint connections.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "StorageAccountListPrivateEndpointConnections": { - "$ref": "./examples/PrivateEndpointConnection/list.json" - } - }, "x-ms-pageable": { "nextLinkName": null } @@ -1293,11 +1136,13 @@ "tags": [ "WorkspacePrivateEndpointConnections" ], - "summary": "Called by end-users to delete a PE connection.", "operationId": "PrivateEndpointConnections_Delete", - "produces": [ - "application/json" - ], + "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceDeletePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1317,33 +1162,30 @@ ], "responses": { "200": { - "description": "Success" + "description": "OK -- Delete the private endpoint connection successfully." }, "204": { - "description": "No Content" + "description": "No Content -- The private endpoint connection does not exist." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/delete.json" - } } }, "get": { "tags": [ "WorkspacePrivateEndpointConnections" ], - "summary": "Called by end-users to get a PE connection.", "operationId": "PrivateEndpointConnections_Get", - "produces": [ - "application/json" - ], + "description": "Gets the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1363,36 +1205,30 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "OK -- Get the private endpoint connection properties successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspaceGetPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/get.json" - } } }, "put": { "tags": [ "WorkspacePrivateEndpointConnections" ], - "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Update the state of specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1410,33 +1246,28 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { + "name": "properties", "in": "body", - "name": "body", - "description": "PrivateEndpointConnection object", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" - } + }, + "description": "The private endpoint connection properties." } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "OK -- Update the private endpoint connection properties successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" - } } } }, @@ -1445,11 +1276,13 @@ "tags": [ "WorkspacePrivateLinkResources" ], - "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", "operationId": "PrivateLinkResources_List", - "produces": [ - "application/json" - ], + "description": "Gets the private link resources that need to be created for a workspace.", + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1466,25 +1299,17 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Successfully retrieved private link resources.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspaceListPrivateLinkResources": { - "$ref": "./examples/PrivateLinkResource/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, @@ -1493,15 +1318,21 @@ "tags": [ "ManagedNetwork" ], + "description": "Provisions the managed network of a machine learning workspace.", "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", - "summary": "Provisions the managed network of a machine learning workspace.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provision.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1512,12 +1343,9 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", "description": "Managed Network Provisioning Options for a machine learning workspace.", + "in": "body", + "name": "parameters", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionOptions" } @@ -1525,7 +1353,7 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success.", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionStatus" } @@ -1536,13 +1364,6 @@ "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } }, @@ -1552,29 +1373,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Provision ManagedNetwork": { - "$ref": "./examples/ManagedNetwork/provision.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { "post": { "tags": [ - "ProxyOperations" + "Workspaces" ], - "summary": "Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry", + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", "operationId": "Workspaces_ResyncKeys", - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/Workspace/resyncKeys.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1583,46 +1401,21 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success" + "description": "The request was successful; the request was well-formed and received properly." }, "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } + "description": "The request was accepted; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Resync Workspace Keys": { - "$ref": "./examples/Workspace/resyncKeys.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } } @@ -1640,27 +1433,42 @@ "$ref": "#/definitions/WorkspaceConnectionAccessKey" } }, + "additionalProperties": false, "x-ms-discriminator-value": "AccessKey" }, "AmlOperation": { - "description": "Azure Machine Learning team account REST API operation", + "description": "Azure Machine Learning REST API operation", "type": "object", "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, "display": { - "description": "Gets or sets display name of operation", - "$ref": "#/definitions/OperationDisplay" + "description": "Display name of operation", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } }, "isDataAction": { "description": "Indicates whether the operation applies to data-plane", "type": "boolean" - }, - "name": { - "description": "Gets or sets operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "origin": { - "description": "The intended executor of the operation: user/system", - "type": "string" } } }, @@ -1669,42 +1477,26 @@ "description": "An array of operations supported by the resource provider.", "properties": { "value": { - "description": "Gets or sets list of AML team account operations supported by the\r\nAML team account resource provider.", "type": "array", "items": { "$ref": "#/definitions/AmlOperation" }, "x-ms-identifiers": [ "name" - ] + ], + "description": "List of AML operations supported by the AML resource provider." } } }, - "ApiKeyAuthWorkspaceConnectionProperties": { - "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "ComputeRuntimeDto": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionApiKey" - } - }, - "x-ms-discriminator-value": "ApiKey" - }, - "ComputeRuntimeDto": { - "type": "object", - "properties": { - "sparkRuntimeVersion": { - "type": "string" + "sparkRuntimeVersion": { + "type": "string" } } }, "ConnectionAuthType": { - "description": "Authentication type of the connection target", "enum": [ "PAT", "ManagedIdentity", @@ -1712,37 +1504,32 @@ "None", "SAS", "ServicePrincipal", - "AccessKey", - "ApiKey", - "CustomKeys" + "AccessKey" ], "type": "string", + "description": "Authentication type of the connection target", "x-ms-enum": { "name": "ConnectionAuthType", "modelAsString": true } }, "ConnectionCategory": { - "description": "Category of the connection", "enum": [ "PythonFeed", "ContainerRegistry", "Git", + "FeatureStore", "S3", "Snowflake", "AzureSqlDb", "AzureSynapseAnalytics", "AzureMySqlDb", "AzurePostgresDb", - "ADLSGen2", - "Redis", - "ApiKey", - "AzureOpenAI", - "CognitiveSearch", - "CognitiveService", - "CustomKeys" + "AzureDataLakeGen2", + "Redis" ], "type": "string", + "description": "Category of the connection", "x-ms-enum": { "name": "ConnectionCategory", "modelAsString": true @@ -1752,85 +1539,77 @@ "type": "object", "properties": { "collectionsThroughput": { + "type": "integer", "format": "int32", - "type": "integer" + "description": "The throughput of the collections in cosmosdb database" } } }, - "CustomKeys": { + "DiagnoseRequestProperties": { "type": "object", - "description": "Custom Keys credential object", "properties": { - "keys": { + "udr": { + "description": "Setting for diagnosing user defined routing", "type": "object", "additionalProperties": { - "type": "string" + "type": "object" } - } - } - }, - "CustomKeysWorkspaceConnectionProperties": { - "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/CustomKeys" - } - }, - "x-ms-discriminator-value": "CustomKeys" - }, - "DiagnoseRequestProperties": { - "type": "object", - "properties": { - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", + }, + "nsg": { + "description": "Setting for diagnosing network security group", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", + "resourceLock": { + "description": "Setting for diagnosing resource lock", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, "dnsResolution": { "description": "Setting for diagnosing dns resolution", "type": "object", - "additionalProperties": {} - }, - "keyVault": { - "description": "Setting for diagnosing dependent key vault", - "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "nsg": { - "description": "Setting for diagnosing network security group", + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", + "keyVault": { + "description": "Setting for diagnosing dependent key vault", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "storageAccount": { - "description": "Setting for diagnosing dependent storage account", + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "udr": { - "description": "Setting for diagnosing user defined routing", + "others": { + "description": "Setting for diagnosing unclassified category of problems", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } } } }, @@ -1932,118 +1711,112 @@ "code": { "description": "Code for workspace setup error", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true }, "level": { "description": "Level of workspace setup error", - "$ref": "#/definitions/DiagnoseResultLevel", + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } }, "message": { "description": "Message of workspace setup error", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true } } }, - "DiagnoseResultLevel": { - "enum": [ - "Warning", - "Error", - "Information" - ], - "type": "string", - "description": "Level of workspace setup error", - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } - }, "DiagnoseWorkspaceParameters": { - "description": "Parameters to diagnose a workspace", "type": "object", + "description": "Parameters to diagnose a workspace", "properties": { "value": { + "description": "Value of Parameters", "$ref": "#/definitions/DiagnoseRequestProperties" } } }, - "EncryptionKeyVaultUpdateProperties": { + "EncryptionKeyVaultProperties": { + "properties": { + "keyVaultArmId": { + "description": "The ArmId of the keyVault where the customer owned encryption key is present.", + "type": "string" + }, + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identityClientId": { + "description": "For future use - The client id of the identity which will be used to access key vault.", + "type": "string" + } + }, "required": [ - "keyIdentifier" + "keyIdentifier", + "keyVaultArmId" ], - "type": "object", + "type": "object" + }, + "EncryptionKeyVaultUpdateProperties": { "properties": { "keyIdentifier": { - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", + "description": "Key Vault uri to access the encryption key.", "type": "string" } - } - }, - "EncryptionProperty": { + }, "required": [ - "keyVaultProperties", - "status" + "keyIdentifier" ], - "type": "object", + "type": "object" + }, + "EncryptionProperty": { "properties": { - "cosmosDbResourceId": { - "description": "The byok cosmosdb account that customer brings to store customer's data\r\nwith encryption", - "type": "string" + "status": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } }, "identity": { - "description": "Identity to be used with the keyVault", - "$ref": "#/definitions/IdentityForCmk" + "$ref": "#/definitions/IdentityForCmk", + "description": "The identity that will be used to access the key vault for encryption at rest." }, "keyVaultProperties": { - "description": "KeyVault details to do the encryption", - "$ref": "#/definitions/KeyVaultProperties" - }, - "searchAccountResourceId": { - "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", - "type": "string" - }, - "status": { - "$ref": "#/definitions/EncryptionStatus" - }, - "storageAccountResourceId": { - "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", - "type": "string" + "$ref": "#/definitions/EncryptionKeyVaultProperties", + "description": "Customer Key vault properties." } - } - }, - "EncryptionStatus": { - "description": "Indicates whether or not the encryption is enabled for the workspace.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "EncryptionStatus", - "modelAsString": true - } - }, - "EncryptionUpdateProperties": { + }, "required": [ + "status", "keyVaultProperties" ], - "type": "object", + "type": "object" + }, + "EncryptionUpdateProperties": { "properties": { "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties", + "description": "Customer Key vault properties." } - } + }, + "required": [ + "keyVaultProperties" + ], + "type": "object" }, "ExternalFQDNResponse": { "type": "object", @@ -2051,7 +1824,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/FQDNEndpointsPropertyBag" + "$ref": "#/definitions/FQDNEndpoints" }, "x-ms-identifiers": [ "/properties/category" @@ -2086,6 +1859,14 @@ } }, "FQDNEndpoints": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpointsProperties" + } + } + }, + "FQDNEndpointsProperties": { "type": "object", "properties": { "category": { @@ -2102,15 +1883,6 @@ } } }, - "FQDNEndpointsPropertyBag": { - "type": "object", - "description": "Property bag for FQDN endpoints result", - "properties": { - "properties": { - "$ref": "#/definitions/FQDNEndpoints" - } - } - }, "FeatureStoreSettings": { "type": "object", "properties": { @@ -2126,8 +1898,8 @@ } }, "FqdnOutboundRule": { - "type": "object", "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2141,11 +1913,11 @@ "x-ms-discriminator-value": "FQDN" }, "IdentityForCmk": { + "description": "Identity that will be used to access key vault for encryption at rest", "type": "object", - "description": "Identity object used for encryption.", "properties": { "userAssignedIdentity": { - "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", + "description": "The ArmId of the user assigned identity that will be used to access the customer managed key vault", "type": "string" } } @@ -2163,51 +1935,17 @@ "modelAsString": true } }, - "KeyVaultProperties": { - "required": [ - "keyIdentifier", - "keyVaultArmId" - ], - "type": "object", - "description": "Customer Key vault properties.", - "properties": { - "identityClientId": { - "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", - "type": "string" - }, - "keyIdentifier": { - "description": "KeyVault key identifier to encrypt the data", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, - "keyVaultArmId": { - "description": "KeyVault Arm Id that contains the data encryption key", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - } - } - }, "ListNotebookKeysResult": { "type": "object", "properties": { "primaryAccessKey": { - "description": "The primary access key of the Notebook", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true }, "secondaryAccessKey": { - "description": "The secondary access key of the Notebook", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true } } @@ -2216,12 +1954,8 @@ "type": "object", "properties": { "userStorageKey": { - "description": "The access key of the storage", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true } } @@ -2229,37 +1963,27 @@ "ListWorkspaceKeysResult": { "type": "object", "properties": { - "appInsightsInstrumentationKey": { - "description": "The access key of the workspace app insights", + "userStorageKey": { + "readOnly": true, "type": "string", + "x-ms-secret": true + }, + "userStorageResourceId": { "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string", "x-ms-secret": true }, "containerRegistryCredentials": { + "readOnly": true, "$ref": "#/definitions/RegistryListCredentialsResult" }, "notebookAccessKeys": { - "$ref": "#/definitions/ListNotebookKeysResult" - }, - "userStorageArmId": { - "description": "The arm Id key of the workspace storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "userStorageKey": { - "description": "The access key of the workspace storage", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "$ref": "#/definitions/ListNotebookKeysResult" } } }, @@ -2275,6 +1999,7 @@ "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" } }, + "additionalProperties": false, "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedNetworkProvisionOptions": { @@ -2290,11 +2015,11 @@ "description": "Status of the Provisioning for the managed network of a machine learning workspace.", "type": "object", "properties": { - "sparkReady": { - "type": "boolean" - }, "status": { "$ref": "#/definitions/ManagedNetworkStatus" + }, + "sparkReady": { + "type": "boolean" } } }, @@ -2340,69 +2065,46 @@ "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } ], + "additionalProperties": false, "x-ms-discriminator-value": "None" }, "NotebookAccessTokenResult": { "type": "object", "properties": { - "accessToken": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "expiresIn": { - "format": "int32", - "type": "integer", + "notebookResourceId": { "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, "hostName": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "notebookResourceId": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, "publicDns": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, - "refreshToken": { - "type": "string", + "accessToken": { "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true }, - "scope": { - "type": "string", + "tokenType": { "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, - "tokenType": { + "expiresIn": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "refreshToken": { + "readOnly": true, "type": "string", + "x-ms-secret": true + }, + "scope": { "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" } } }, @@ -2424,38 +2126,14 @@ "fqdn": { "type": "string" }, - "isPrivateLinkEnabled": { - "type": "boolean" + "resourceId": { + "type": "string", + "description": "the data plane resourceId that used to initialize notebook component" }, "notebookPreparationError": { + "$ref": "#/definitions/NotebookPreparationError", "description": "The error that occurs when preparing notebook.", - "$ref": "#/definitions/NotebookPreparationError" - }, - "resourceId": { - "description": "the data plane resourceId that used to initialize notebook component", - "type": "string" - } - } - }, - "OperationDisplay": { - "description": "Display name of operation", - "type": "object", - "properties": { - "description": { - "description": "Gets or sets the description for the operation.", - "type": "string" - }, - "operation": { - "description": "Gets or sets the operation that users can perform.", - "type": "string" - }, - "provider": { - "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", - "type": "string" - }, - "resource": { - "description": "Gets or sets the resource on which the operation is performed.", - "type": "string" + "x-nullable": true } } }, @@ -2466,14 +2144,14 @@ ], "type": "object", "properties": { - "category": { - "$ref": "#/definitions/RuleCategory" + "type": { + "$ref": "#/definitions/RuleType" }, "status": { "$ref": "#/definitions/RuleStatus" }, - "type": { - "$ref": "#/definitions/RuleType" + "category": { + "$ref": "#/definitions/RuleCategory" } }, "discriminator": "type" @@ -2493,22 +2171,23 @@ "properties": { "$ref": "#/definitions/OutboundRule" } - } + }, + "additionalProperties": false }, "OutboundRuleListResult": { "description": "List of outbound rules for the managed network of a machine learning workspace.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { "$ref": "#/definitions/OutboundRuleBasicResource" } + }, + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" } } }, @@ -2524,65 +2203,70 @@ "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" } }, + "additionalProperties": false, "x-ms-discriminator-value": "PAT" }, "Password": { "type": "object", "properties": { "name": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "type": "string" }, "value": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "type": "string" } } }, - "PrivateEndpointConnection": { + "PrivateEndpoint": { "type": "object", - "description": "The Private Endpoint Connection resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" } - ], + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." }, "location": { - "description": "Same as workspace location.", + "description": "Specifies the location of the resource.", "type": "string" }, - "properties": { - "description": "Private endpoint connection properties.", - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "x-ms-client-flatten": true - }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" - }, "tags": { + "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." } - } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." }, "PrivateEndpointConnectionListResult": { "type": "object", - "description": "List of private endpoint connection associated with the specified workspace", "properties": { "value": { "type": "array", @@ -2591,23 +2275,29 @@ "$ref": "#/definitions/PrivateEndpointConnection" } } - } + }, + "description": "List of private endpoint connection associated with the specified workspace" }, "PrivateEndpointConnectionProperties": { - "description": "Private endpoint connection properties.", "type": "object", "properties": { "privateEndpoint": { - "$ref": "#/definitions/WorkspacePrivateEndpointResource" + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { - "description": "The connection state.", - "$ref": "#/definitions/PrivateLinkServiceConnectionState" + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { - "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." } - } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." }, "PrivateEndpointConnectionProvisioningState": { "type": "string", @@ -2625,20 +2315,20 @@ } }, "PrivateEndpointDestination": { - "type": "object", "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "properties": { "serviceResourceId": { "type": "string" }, + "subresourceTarget": { + "type": "string" + }, "sparkEnabled": { "type": "boolean" }, "sparkStatus": { "$ref": "#/definitions/RuleStatus" - }, - "subresourceTarget": { - "type": "string" } } }, @@ -2658,144 +2348,122 @@ "x-ms-discriminator-value": "PrivateEndpoint" }, "PrivateEndpointServiceConnectionStatus": { - "description": "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)", + "type": "string", + "description": "The private endpoint connection status.", "enum": [ - "Approved", "Pending", + "Approved", "Rejected", "Disconnected", "Timeout" ], - "type": "string", "x-ms-enum": { - "name": "EndpointServiceConnectionStatus", + "name": "PrivateEndpointServiceConnectionStatus", "modelAsString": true } }, "PrivateLinkResource": { "type": "object", - "description": "A private link resource", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "location": { - "description": "Same as workspace location.", - "type": "string" - }, "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", "x-ms-client-flatten": true }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" }, "tags": { + "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." } - } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" }, "PrivateLinkResourceListResult": { - "description": "A list of private link resources", "type": "object", "properties": { "value": { "type": "array", + "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } } - } + }, + "description": "A list of private link resources" }, "PrivateLinkResourceProperties": { "type": "object", - "description": "Properties of a private link resource.", "properties": { "groupId": { "description": "The private link resource group id.", - "type": "string" + "type": "string", + "readOnly": true }, "requiredMembers": { "description": "The private link resource required member names.", "type": "array", "items": { "type": "string" - } + }, + "readOnly": true }, "requiredZoneNames": { - "description": "The private link resource Private link DNS zone name.", "type": "array", "items": { "type": "string" - } + }, + "description": "The private link resource Private link DNS zone name." } - } + }, + "description": "Properties of a private link resource." }, "PrivateLinkServiceConnectionState": { "type": "object", - "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { - "actionsRequired": { - "description": "Some RP chose \"None\". Other RPs use this for region expansion.", - "type": "string" + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." }, "description": { - "description": "User-defined message that, per NRP doc, may be used for approval-related message.", - "type": "string" + "type": "string", + "description": "The reason for approval/rejection of the connection." }, - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." } - } - }, - "ProvisioningState": { - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "PublicNetworkAccessType": { - "description": "The public network access flag.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccessType", - "modelAsString": true - } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." }, "RegistryListCredentialsResult": { "type": "object", "properties": { "location": { - "description": "The location of the workspace ACR", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" }, "passwords": { "type": "array", @@ -2805,29 +2473,9 @@ "x-ms-identifiers": [ "name" ] - }, - "username": { - "description": "The username of the workspace ACR", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] } } }, - "RuleAction": { - "description": "The action enum for networking rule.", - "enum": [ - "Allow", - "Deny" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleAction", - "modelAsString": true - } - }, "RuleCategory": { "description": "Category of a managed network Outbound Rule of a machine learning workspace.", "enum": [ @@ -2842,7 +2490,7 @@ } }, "RuleStatus": { - "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "description": "Status of a managed network Outbound Rule of a machine learning workspace.", "enum": [ "Inactive", "Active" @@ -2878,13 +2526,15 @@ "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" } }, + "additionalProperties": false, "x-ms-discriminator-value": "SAS" }, "ServiceManagedResourcesSettings": { "type": "object", "properties": { "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings" + "$ref": "#/definitions/CosmosDbSettings", + "description": "The settings for the service managed cosmosdb account." } } }, @@ -2900,37 +2550,27 @@ "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" } }, + "additionalProperties": false, "x-ms-discriminator-value": "ServicePrincipal" }, "ServiceTagDestination": { - "type": "object", "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "properties": { - "action": { - "$ref": "#/definitions/RuleAction" - }, - "addressPrefixes": { - "description": "Optional, if provided, the ServiceTag property will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "portRanges": { + "serviceTag": { "type": "string" }, "protocol": { "type": "string" }, - "serviceTag": { + "portRanges": { "type": "string" } } }, "ServiceTagOutboundRule": { - "type": "object", "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2947,35 +2587,37 @@ "type": "object", "properties": { "name": { - "description": "Unique name of the private link", + "description": "Unique name of the private link.", "type": "string" }, "properties": { "$ref": "#/definitions/SharedPrivateLinkResourceProperty", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "description": "Resource properties." } } }, "SharedPrivateLinkResourceProperty": { "type": "object", - "description": "Properties of a shared private link resource.", "properties": { - "groupId": { - "description": "group id of the private link", + "privateLinkResourceId": { + "description": "The resource id that private link links to.", "type": "string" }, - "privateLinkResourceId": { - "description": "the resource id that private link links to", + "groupId": { + "description": "The private link resource group id.", "type": "string" }, "requestMessage": { - "description": "Request message", + "description": "Request message.", "type": "string" }, "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } - } + }, + "description": "Properties of a shared private link resource." }, "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { "type": "object", @@ -2989,12 +2631,10 @@ "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" } }, + "additionalProperties": false, "x-ms-discriminator-value": "UsernamePassword" }, "Workspace": { - "required": [ - "properties" - ], "type": "object", "description": "An object that represents a machine learning workspace.", "allOf": [ @@ -3003,29 +2643,32 @@ } ], "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "type": "string" - }, - "location": { - "type": "string" - }, "properties": { - "description": "Additional attributes of the entity.", "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", "x-ms-client-flatten": true }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" }, "tags": { + "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + }, + "kind": { + "type": "string" } } }, @@ -3036,29 +2679,23 @@ "type": "string" }, "secretAccessKey": { - "type": "string" - } - } - }, - "WorkspaceConnectionApiKey": { - "type": "object", - "description": "Api key object for workspace connection credential.", - "properties": { - "key": { - "type": "string" + "type": "string", + "x-ms-secret": true } - } + }, + "additionalProperties": false }, "WorkspaceConnectionManagedIdentity": { "type": "object", "properties": { - "clientId": { + "resourceId": { "type": "string" }, - "resourceId": { + "clientId": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionPersonalAccessToken": { "type": "object", @@ -3066,7 +2703,8 @@ "pat": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionPropertiesV2": { "required": [ @@ -3075,24 +2713,34 @@ "type": "object", "properties": { "authType": { - "description": "Authentication type of the connection target", "$ref": "#/definitions/ConnectionAuthType" }, - "category": { - "description": "Category of the connection", - "$ref": "#/definitions/ConnectionCategory" - }, "expiryTime": { - "format": "date-time", "type": "string" }, - "metadata": { - "type": "object" + "category": { + "$ref": "#/definitions/ConnectionCategory" }, "target": { "type": "string" + }, + "value": { + "description": "Value details of the workspace connection.", + "type": "string" + }, + "valueFormat": { + "description": "format for the workspace connection value", + "type": "string", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "ValueFormat", + "modelAsString": true + } } }, + "additionalProperties": false, "discriminator": "authType" }, "WorkspaceConnectionPropertiesV2BasicResource": { @@ -3109,21 +2757,24 @@ "properties": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { "type": "object", "properties": { - "nextLink": { - "type": "string" - }, "value": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } + }, + "nextLink": { + "readOnly": true, + "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionServicePrincipal": { "type": "object", @@ -3132,12 +2783,14 @@ "type": "string" }, "clientSecret": { - "type": "string" + "type": "string", + "x-ms-secret": true }, "tenantId": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionSharedAccessSignature": { "type": "object", @@ -3145,374 +2798,343 @@ "sas": { "type": "string" } - } - }, - "WorkspaceConnectionUpdateParameter": { - "type": "object", - "description": "The properties that the machine learning workspace connection will be updated with.", - "properties": { - "properties": { - "description": "The properties that the machine learning workspace connection will be updated with.", - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - } + }, + "additionalProperties": false }, "WorkspaceConnectionUsernamePassword": { "type": "object", "properties": { - "password": { - "type": "string" - }, "username": { "type": "string" - } - } - }, - "WorkspaceHubConfig": { - "type": "object", - "description": "WorkspaceHub's configuration object.", - "properties": { - "additionalWorkspaceStorageAccounts": { - "type": "array", - "items": { - "type": "string" - } }, - "defaultWorkspaceResourceGroup": { + "password": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceListResult": { - "description": "The result of a request to list machine learning workspaces.", "type": "object", + "description": "The result of a request to list machine learning workspaces.", "properties": { - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { "$ref": "#/definitions/Workspace" } - } - } - }, - "WorkspacePrivateEndpointResource": { - "type": "object", - "description": "The Private Endpoint resource.", - "properties": { - "id": { - "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] }, - "subnetArmId": { - "description": "The subnetId that the private endpoint is connected to.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" } } }, "WorkspaceProperties": { - "description": "The properties of a machine learning workspace.", "type": "object", + "description": "The properties of a machine learning workspace.", "properties": { - "allowPublicAccessWhenBehindVnet": { - "description": "The flag to indicate whether to allow public access when behind VNet.", - "type": "boolean" + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", + "description": { + "description": "The description of this workspace.", "type": "string" }, - "associatedWorkspaces": { - "type": "array", - "items": { - "type": "string" - } + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" }, - "containerRegistries": { - "type": "array", - "items": { - "type": "string" - } + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" }, "containerRegistry": { "description": "ARM id of the container registry associated with this workspace.", - "type": "string" + "type": "string", + "x-nullable": true }, - "description": { - "description": "The description of this workspace.", + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", "type": "string" }, "discoveryUrl": { "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", "type": "string" }, - "enableDataIsolation": { - "type": "boolean" + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "SoftDeleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." }, "encryption": { - "$ref": "#/definitions/EncryptionProperty" - }, - "existingWorkspaces": { - "type": "array", - "items": { - "type": "string" - } - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of Azure ML workspace." }, "hbiWorkspace": { + "type": "boolean", "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", - "type": "boolean" + "default": false }, - "hubResourceId": { - "type": "string" + "serviceProvisionedResourceGroup": { + "type": "string", + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "readOnly": true + }, + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true }, "imageBuildCompute": { "description": "The compute name for image build", "type": "string" }, - "keyVault": { - "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" - }, - "keyVaults": { - "type": "array", - "items": { - "type": "string" - } - }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false }, - "mlFlowTrackingUri": { - "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "publicNetworkAccess": { "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "notebookInfo": { - "description": "The notebook info of Azure ML workspace.", - "$ref": "#/definitions/NotebookResourceInfo", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "primaryUserAssignedIdentity": { - "description": "The user assigned identity resource id that represents the workspace identity.", - "type": "string" + "description": "Whether requests from Public Network are allowed.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } }, "privateEndpointConnections": { - "description": "The list of private endpoint connections in the workspace.", + "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, - "readOnly": true, - "x-ms-mutability": [ - "read" - ], "x-ms-identifiers": [ "name" - ] - }, - "privateLinkCount": { - "format": "int32", - "description": "Count of private connections in the workspace", - "type": "integer", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "provisioningState": { - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", - "$ref": "#/definitions/ProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "publicNetworkAccess": { - "description": "Whether requests from Public Network are allowed.", - "$ref": "#/definitions/PublicNetworkAccessType" - }, - "serviceManagedResourcesSettings": { - "description": "The service managed resource settings.", - "$ref": "#/definitions/ServiceManagedResourcesSettings" - }, - "serviceProvisionedResourceGroup": { - "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + ], + "description": "The list of private endpoint connections in the workspace." }, "sharedPrivateLinkResources": { - "description": "The list of shared private link resources in this workspace.", "type": "array", "items": { "$ref": "#/definitions/SharedPrivateLinkResource" }, "x-ms-identifiers": [ "name" - ] + ], + "description": "The list of shared private link resources in this workspace." }, - "softDeleteRetentionInDays": { - "format": "int32", - "description": "Retention time in days after workspace get soft deleted.", - "type": "integer" + "notebookInfo": { + "readOnly": true, + "$ref": "#/definitions/NotebookResourceInfo", + "description": "The notebook info of Azure ML workspace." }, - "storageAccount": { - "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" }, - "storageAccounts": { - "type": "array", - "items": { - "type": "string" - } + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true }, "storageHnsEnabled": { "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", "type": "boolean", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "systemDatastoresAuthMode": { - "description": "The auth mode used for accessing the system datastores of the workspace.", - "type": "string" + "readOnly": true }, - "tenantId": { - "description": "The tenant id associated with this workspace.", + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true }, "v1LegacyMode": { "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "default": false, "type": "boolean" }, - "workspaceHubConfig": { - "$ref": "#/definitions/WorkspaceHubConfig" + "softDeletedAt": { + "description": "The timestamp when the workspace was soft deleted", + "type": "string", + "readOnly": true }, - "workspaceId": { - "description": "The immutable id associated with this workspace.", + "scheduledPurgeDate": { + "description": "The timestamp when the soft deleted workspace is going to be purged", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true + }, + "systemDatastoresAuthMode": { + "description": "The auth mode used for accessing the system datastores of the workspace", + "type": "string" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "description": "Retention time in days after workspace get soft deleted." + }, + "enableDataIsolation": { + "description": "A flag to determine if workspace has data isolation enabled. The flag can only be set at the creation phase, it can't be updated.", + "default": false, + "type": "boolean" + }, + "storageAccounts": { + "description": ": A list of storage accounts used by Hub.", + "type": "array", + "items": { + "type": "string" + } + }, + "keyVaults": { + "description": "A list of key vaults used by Hub.", + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "description": "A list of container registries used by Hub.", + "type": "array", + "items": { + "type": "string" + } + }, + "existingWorkspaces": { + "description": "A list of existing workspaces used by Hub to perform convert.", + "type": "array", + "items": { + "type": "string" + } + }, + "hubResourceId": { + "description": "Resource Id of Hub used for lean workspace.", + "type": "string" + }, + "associatedWorkspaces": { + "description": "A list of lean workspaces associated with Hub.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" } } }, "WorkspacePropertiesUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", "type": "object", + "description": "The parameters for updating the properties of a machine learning workspace.", "properties": { - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string" - }, "description": { "description": "The description of this workspace.", "type": "string" }, - "enableDataIsolation": { - "type": "boolean" - }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties" - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", + "description": "The friendly name for this workspace.", "type": "string" }, "imageBuildCompute": { "description": "The compute name for image build", "type": "string" }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." }, "primaryUserAssignedIdentity": { "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" }, "publicNetworkAccess": { + "type": "string", "description": "Whether requests from Public Network are allowed.", - "$ref": "#/definitions/PublicNetworkAccessType" + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } }, - "serviceManagedResourcesSettings": { - "description": "The service managed resource settings.", - "$ref": "#/definitions/ServiceManagedResourcesSettings" + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" }, - "softDeleteRetentionInDays": { - "format": "int32", - "description": "Retention time in days after workspace get soft deleted.", - "type": "integer" + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" }, - "v1LegacyMode": { - "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", - "type": "boolean" + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties", + "description": "The encryption settings of the workspace." + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" } } }, "WorkspaceUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", "type": "object", + "description": "The parameters for updating a machine learning workspace.", "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "properties": { - "description": "The properties that the machine learning workspace will be updated with.", - "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", - "x-ms-client-flatten": true - }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" - }, "tags": { "description": "The resource tags for the machine learning workspace.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true } } } @@ -3521,18 +3143,19 @@ "WorkspaceKindParameter": { "in": "query", "name": "kind", - "description": "Kind of workspace.", "type": "string", + "description": "Kind of workspace.", + "required": false, "x-ms-parameter-location": "method" }, "WorkspaceNameParameter": { - "in": "path", "name": "workspaceName", "description": "Name of Azure Machine Learning workspace.", - "required": true, + "in": "path", "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" }, "PaginationParameter": { "in": "query", @@ -3545,57 +3168,58 @@ "WorkspaceForceToPurgeParameter": { "in": "query", "name": "forceToPurge", - "description": "Flag to indicate delete is a purge request.", "type": "boolean", - "default": false, + "description": "Flag to indicate delete is a purge request.", + "required": false, "x-ms-parameter-location": "method" }, "TargetParameter": { "in": "query", "name": "target", - "description": "Target of the workspace connection.", "type": "string", + "description": "Target of the workspace connection.", + "required": false, "x-ms-parameter-location": "method" }, "CategoryParameter": { "in": "query", "name": "category", - "description": "Category of the workspace connection.", "type": "string", + "description": "Category of the workspace connection.", + "required": false, "x-ms-parameter-location": "method" }, "ConnectionName": { - "in": "path", "name": "connectionName", - "description": "Friendly name of the workspace connection", + "in": "path", "required": true, "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "description": "Friendly name of the workspace connection", + "x-ms-parameter-location": "method" }, "RuleName": { - "in": "path", "name": "ruleName", - "description": "Name of the workspace managed network outbound rule", + "in": "path", "required": true, "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "description": "Name of the workspace managed network outbound rule", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" }, "PrivateEndpointConnectionName": { - "in": "path", "name": "privateEndpointConnectionName", - "description": "NRP Private Endpoint Connection Name", + "in": "path", "required": true, "type": "string", + "description": "The name of the private endpoint connection associated with the workspace", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", - "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account"