diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json index 68f33827a95e..962aad7a4df1 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json @@ -5,7 +5,7 @@ "workspaceName": "aml-workspace-name", "ruleName": "some_string", "api-version": "2023-06-01-preview", - "parameters": { + "body": { "properties": { "type": "FQDN", "destination": "some_string", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json index 59c71714157f..d751a70db3e0 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json @@ -4,7 +4,7 @@ "resourceGroupName": "test-rg", "workspaceName": "aml-workspace-name", "api-version": "2023-06-01-preview", - "parameters": { + "body": { "includeSpark": false } }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json index 4dd7bc8d7e16..ca47c41f7437 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json @@ -6,7 +6,7 @@ "privateEndpointConnectionName": "{privateEndpointConnectionName}", "api-version": "2023-06-01-preview", "monitor": "true", - "properties": { + "body": { "properties": { "privateLinkServiceConnectionState": { "status": "Approved", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json index a944a4650d1c..cb9f8f6d1179 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json @@ -4,7 +4,7 @@ "resourceGroupName": "workspace-1234", "workspaceName": "testworkspace", "api-version": "2023-06-01-preview", - "parameters": { + "body": { "location": "eastus2euap", "identity": { "type": "SystemAssigned,UserAssigned", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json index 03d62321ddeb..a4cf7186fc21 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json @@ -4,7 +4,7 @@ "resourceGroupName": "workspace-1234", "workspaceName": "testworkspace", "api-version": "2023-06-01-preview", - "parameters": { + "body": { "value": { "udr": {}, "nsg": {}, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json index 2b177ce111af..315ecd2da5b8 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json @@ -9,7 +9,7 @@ "200": { "body": { "userStorageKey": null, - "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "userStorageArmId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", "appInsightsInstrumentationKey": null, "containerRegistryCredentials": { "location": null, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json index 79c0d3a5ab43..e5d65966f8de 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json @@ -4,7 +4,7 @@ "resourceGroupName": "workspace-1234", "workspaceName": "testworkspace", "api-version": "2023-06-01-preview", - "parameters": { + "body": { "properties": { "friendlyName": "New friendly name", "description": "new description", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json index d5a8986a22c7..1d692c7c107f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json @@ -5,7 +5,7 @@ "workspaceName": "workspace-1", "connectionName": "connection-1", "api-version": "2023-06-01-preview", - "parameters": { + "body": { "properties": { "category": "ContainerRegistry", "expiryTime": "2024-03-15T14:30:00Z", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json new file mode 100644 index 000000000000..5c0f93a9dbd7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "connectionName": "some_string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "CustomKeys", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json new file mode 100644 index 000000000000..2e841ac6798a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "connectionName": "some_string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json index 5b88825a3513..359ef637c72f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json @@ -1255,84 +1255,6 @@ }, "description": "Quota update parameters." }, - "DiagnoseRequestProperties": { - "type": "object", - "properties": { - "udr": { - "description": "Setting for diagnosing user defined routing", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "nsg": { - "description": "Setting for diagnosing network security group", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "dnsResolution": { - "description": "Setting for diagnosing dns resolution", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "storageAccount": { - "description": "Setting for diagnosing dependent storage account", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "keyVault": { - "description": "Setting for diagnosing dependent key vault", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - }, - "DiagnoseWorkspaceParameters": { - "type": "object", - "description": "Parameters to diagnose a workspace", - "properties": { - "value": { - "description": "Value of Parameters", - "$ref": "#/definitions/DiagnoseRequestProperties" - } - } - }, "UpdateWorkspaceQuotasResult": { "type": "object", "properties": { 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 e786e1697d60..4f5280261a58 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 @@ -22,35 +22,22 @@ ] } ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, "paths": { "/providers/Microsoft.MachineLearningServices/operations": { "get": { "tags": [ "Operation" ], - "description": "Lists all of the available Azure Machine Learning Services REST API operations.", + "summary": "Lists all of the available Azure Machine Learning Workspaces 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.", @@ -59,74 +46,81 @@ } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "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 } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { "get": { "tags": [ "Workspaces" ], - "description": "Gets the properties of the specified machine learning workspace.", - "operationId": "Workspaces_Get", - "x-ms-examples": { - "Get Workspace": { - "$ref": "./examples/Workspace/get.json" - } - }, + "summary": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "produces": [ + "application/json" + ], "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$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" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceKindParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/Workspace" + "$ref": "#/definitions/WorkspaceListResult" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "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" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { "tags": [ "Workspaces" ], - "description": "Creates or updates a workspace with the specified parameters.", - "operationId": "Workspaces_CreateOrUpdate", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create Workspace": { - "$ref": "./examples/Workspace/create.json" - } - }, + "summary": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -134,52 +128,50 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "name": "parameters", - "in": "body", - "description": "The parameters for creating or updating a machine learning workspace.", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } + "$ref": "#/parameters/PaginationParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/Workspace" + "$ref": "#/definitions/WorkspaceListResult" } }, - "202": { - "description": "The request was successful; the request was well-formed and received properly." - }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "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" } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { "delete": { "tags": [ "Workspaces" ], - "description": "Deletes a machine learning workspace.", + "summary": "Deletes a machine learning workspace.", "operationId": "Workspaces_Delete", - "x-ms-examples": { - "Delete Workspace": { - "$ref": "./examples/Workspace/delete.json" - } - }, - "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -189,44 +181,47 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/WorkspaceForceToPurgeParameter" } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly." + "description": "Success" }, "202": { - "description": "The request was accepted; the request was well-formed and received properly." + "description": "Accepted" }, "204": { - "description": "The machine learning workspace does not exist in the subscription." + "description": "No Content" }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "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 }, - "patch": { + "get": { "tags": [ "Workspaces" ], - "description": "Updates a machine learning workspace with the specified parameters.", - "operationId": "Workspaces_Update", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update Workspace": { - "$ref": "./examples/Workspace/update.json" - } - }, + "summary": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -237,13 +232,7 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "name": "parameters", - "in": "body", - "description": "The parameters for updating a machine learning workspace.", - "required": true, - "schema": { - "$ref": "#/definitions/WorkspaceUpdateParameters" - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -253,34 +242,32 @@ "$ref": "#/definitions/Workspace" } }, - "202": { - "description": "The request was successful; the request was well-formed and received properly." - }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { - "get": { + }, + "patch": { "tags": [ "Workspaces" ], - "description": "Lists all the available machine learning workspaces under the specified resource group.", - "operationId": "Workspaces_ListByResourceGroup", - "x-ms-examples": { - "Get Workspaces by Resource Group": { - "$ref": "./examples/Workspace/listByResourceGroup.json" - } - }, + "summary": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "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" }, @@ -288,38 +275,51 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/PaginationParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/WorkspaceKindParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/WorkspaceListResult" + "$ref": "#/definitions/Workspace" } }, + "202": { + "description": "Accepted" + }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { - "post": { + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { "tags": [ "Workspaces" ], - "summary": "Diagnose workspace setup issue.", - "operationId": "Workspaces_Diagnose", + "summary": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", "consumes": [ "application/json" ], @@ -341,16 +341,23 @@ }, { "in": "body", - "name": "parameters", - "description": "The parameter of diagnosing workspace health", + "name": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, "schema": { - "$ref": "#/definitions/DiagnoseWorkspaceParameters" + "$ref": "#/definitions/Workspace" } } ], "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, "202": { - "description": "Success", + "description": "Accepted", "headers": { "Location": { "description": "URI to poll for asynchronous operation result.", @@ -365,12 +372,6 @@ } } }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" - } - }, "default": { "description": "Error", "schema": { @@ -379,8 +380,8 @@ } }, "x-ms-examples": { - "Diagnose Workspace": { - "$ref": "./examples/Workspace/diagnose.json" + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" } }, "x-ms-long-running-operation": true, @@ -389,22 +390,17 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { "tags": [ - "Workspaces" + "V2WorkspaceConnectionResource" ], - "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": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listKeys.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, + "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" }, @@ -413,41 +409,52 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + }, + { + "$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/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "ListWorkspaceConnections": { + "$ref": "./examples/WorkspaceConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { + "delete": { "tags": [ - "Workspaces" + "V2WorkspaceConnectionResource" + ], + "summary": "Delete machine learning workspaces connections by name.", + "operationId": "WorkspaceConnections_Delete", + "produces": [ + "application/json" ], - "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", - "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" }, @@ -456,85 +463,93 @@ }, { "$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." + "description": "Success" }, - "202": { - "description": "The request was accepted; the request was well-formed and received properly." + "204": { + "description": "No Content" }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + }, "get": { "tags": [ - "Workspaces" + "V2WorkspaceConnectionResource" + ], + "summary": "Lists machine learning workspaces connections by name.", + "operationId": "WorkspaceConnections_Get", + "produces": [ + "application/json" ], - "description": "Lists all the available machine learning workspaces under the specified subscription.", - "operationId": "Workspaces_ListBySubscription", - "x-ms-examples": { - "Get Workspaces by subscription": { - "$ref": "./examples/Workspace/listBySubscription.json" - } - }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/PaginationParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/WorkspaceKindParameter" + "$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/WorkspaceListResult" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { - "post": { + }, + "patch": { "tags": [ - "Workspaces" + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_Update", + "summary": "Update machine learning workspaces connections under the specified workspace.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "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" }, @@ -543,81 +558,110 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Parameters for workspace connection update.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/NotebookAccessTokenResult" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" + } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { - "get": { + }, + "put": { "tags": [ - "PrivateEndpointConnections" + "V2WorkspaceConnectionResource" + ], + "summary": "Create or update machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "operationId": "PrivateEndpointConnections_List", - "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" }, { "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "#/parameters/ConnectionName" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "body", + "description": "The object for creating or updating a new workspace connection", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } } ], "responses": { "200": { - "description": "OK -- Successfully retrieved private endpoint connections.", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionListResult" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": null + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "post": { "tags": [ - "WorkspacePrivateEndpointConnections" + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_ListSecrets", + "summary": "List all the secrets of a machine learning workspaces connections.", + "produces": [ + "application/json" ], - "operationId": "PrivateEndpointConnections_Get", - "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" @@ -629,7 +673,7 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/PrivateEndpointConnectionName" + "$ref": "#/parameters/ConnectionName" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -637,30 +681,38 @@ ], "responses": { "200": { - "description": "OK -- Get the private endpoint connection properties successfully.", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { "tags": [ - "WorkspacePrivateEndpointConnections" + "ProxyOperations" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "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" @@ -671,48 +723,69 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/PrivateEndpointConnectionName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "name": "properties", "in": "body", - "required": true, + "name": "body", + "description": "The parameter of diagnosing workspace health", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "description": "The private endpoint connection properties." + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } } ], "responses": { "200": { - "description": "OK -- Update the private endpoint connection properties successfully.", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$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 + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - } - }, - "delete": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnections_Delete", - "description": "Deletes the specified private endpoint connection associated with the workspace.", + }, "x-ms-examples": { - "WorkspaceDeletePrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/delete.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}/listKeys": { + "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" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -723,41 +796,41 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/PrivateEndpointConnectionName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "OK -- Delete the private endpoint connection successfully." - }, - "204": { - "description": "No Content -- The private endpoint connection does not exist." + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "Error", "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}/privateLinkResources": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "post": { "tags": [ - "WorkspacePrivateLinkResources" + "ProxyOperations" + ], + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "produces": [ + "application/json" ], - "operationId": "PrivateLinkResources_List", - "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" @@ -774,40 +847,36 @@ ], "responses": { "200": { - "description": "Successfully retrieved private link resources.", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/PrivateLinkResourceListResult" + "$ref": "#/definitions/NotebookAccessTokenResult" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "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}/prepareNotebook": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { "post": { "tags": [ "ProxyOperations" ], - "operationId": "Workspaces_PrepareNotebook", - "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" - } - }, + "summary": "Lists keys of Azure Machine Learning Workspaces notebook.", + "operationId": "Workspaces_ListNotebookKeys", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -816,24 +885,29 @@ }, { "$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.", "schema": { - "$ref": "#/definitions/NotebookResourceInfo" + "$ref": "#/definitions/ListNotebookKeysResult" } }, - "202": { - "description": "The request was successful; the request was well-formed and received properly." - }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } } } }, @@ -842,17 +916,12 @@ "tags": [ "ProxyOperations" ], + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", "operationId": "Workspaces_ListStorageAccountKeys", - "description": "List storage account keys of a workspace.", - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.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" }, @@ -861,6 +930,9 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -871,30 +943,30 @@ } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { "tags": [ - "ProxyOperations" + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "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" }, @@ -903,30 +975,42 @@ }, { "$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/ListNotebookKeysResult" + "$ref": "#/definitions/ExternalFQDNResponse" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "get": { "tags": [ - "V2WorkspaceConnectionResource" + "ManagedNetwork" + ], + "summary": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_List", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Create", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -935,29 +1019,17 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ConnectionName" + "$ref": "#/parameters/WorkspaceNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The object for creating or updating a new workspace connection", - "required": true, - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/OutboundRuleListResult" } }, "default": { @@ -968,16 +1040,25 @@ } }, "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { "tags": [ - "V2WorkspaceConnectionResource" + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Delete", + "summary": "Deletes an outbound rule from the managed network of a machine learning workspace.", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Get", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -986,22 +1067,31 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/ConnectionName" + "$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/WorkspaceConnectionPropertiesV2BasicResource" + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } } }, + "204": { + "description": "No Content" + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, "default": { "description": "Error", "schema": { @@ -1010,16 +1100,21 @@ } }, "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/get.json" + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" } - } + }, + "x-ms-long-running-operation": true }, - "delete": { + "get": { "tags": [ - "V2WorkspaceConnectionResource" + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Get", + "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Delete", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1028,42 +1123,47 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/ConnectionName" + "$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/OutboundRuleBasicResource" + } + }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } - }, - "200": { - "description": "Success" - }, - "204": { - "description": "Success" } }, "x-ms-examples": { - "DeleteWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/delete.json" + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { - "get": { + }, + "put": { "tags": [ - "V2WorkspaceConnectionResource" + "ManagedNetwork" + ], + "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" ], - "operationId": "WorkspaceConnections_List", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1072,23 +1172,45 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/TargetParameter" + "$ref": "#/parameters/RuleName" }, { - "$ref": "#/parameters/CategoryParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "body", + "name": "body", + "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/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + "$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 + } } }, "default": { @@ -1099,22 +1221,23 @@ } }, "x-ms-examples": { - "ListWorkspaceConnections": { - "$ref": "./examples/WorkspaceConnection/list.json" + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.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": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { "tags": [ - "ManagedNetwork" + "ProxyOperations" ], - "description": "Lists the managed network outbound rules for a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_List", + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", + "operationId": "Workspaces_PrepareNotebook", "produces": [ "application/json" ], @@ -1136,7 +1259,23 @@ "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/OutboundRuleListResult" + "$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 + } } }, "default": { @@ -1146,23 +1285,27 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" + "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}/outboundRules/{ruleName}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { "tags": [ - "ManagedNetwork" + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get all PE connections.", + "operationId": "PrivateEndpointConnections_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" @@ -1173,28 +1316,16 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/RuleName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "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." + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } }, "default": { "description": "Error", @@ -1204,21 +1335,25 @@ } }, "x-ms-examples": { - "Delete ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/deleteRule.json" + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": null } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "delete": { "tags": [ - "ManagedNetwork" + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to delete a PE connection.", + "operationId": "PrivateEndpointConnections_Delete", + "produces": [ + "application/json" ], - "description": "Gets an outbound rule from the managed network of a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_Get", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1230,7 +1365,7 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/RuleName" + "$ref": "#/parameters/PrivateEndpointConnectionName" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1238,10 +1373,10 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } + "description": "Success" + }, + "204": { + "description": "No Content" }, "default": { "description": "Error", @@ -1251,17 +1386,20 @@ } }, "x-ms-examples": { - "Get ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/getRule.json" + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" } } }, - "put": { + "get": { "tags": [ - "ManagedNetwork" + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get a PE connection.", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" ], - "description": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1273,35 +1411,17 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/RuleName" + "$ref": "#/parameters/PrivateEndpointConnectionName" }, { "$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": "parameters", - "required": true, - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } } ], "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - } - } - }, "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" + "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { @@ -1312,36 +1432,24 @@ } }, "x-ms-examples": { - "CreateOrUpdate ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/createOrUpdateRule.json" + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.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}/provisionManagedNetwork": { - "post": { + }, + "put": { "tags": [ - "ManagedNetwork" + "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": "Provisions the managed network of a machine learning workspace.", - "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", - "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" }, @@ -1352,28 +1460,26 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "description": "Managed Network Provisioning Options for a machine learning workspace.", + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { "in": "body", - "name": "parameters", + "name": "body", + "description": "PrivateEndpointConnection object", + "required": true, "schema": { - "$ref": "#/definitions/ManagedNetworkProvisionOptions" + "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { - "description": "Success.", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ManagedNetworkProvisionStatus" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - } + "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { @@ -1382,16 +1488,21 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { "get": { "tags": [ - "OutboundNetworkDependenciesEndpoints" + "WorkspacePrivateLinkResources" ], - "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "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" ], @@ -1411,9 +1522,9 @@ ], "responses": { "200": { - "description": "Success", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ExternalFQDNResponse" + "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { @@ -1424,123 +1535,188 @@ } }, "x-ms-examples": { - "ListOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ExternalFQDN/get.json" + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": null } } - } - }, - "parameters": { - "WorkspaceNameParameter": { - "name": "workspaceName", - "description": "Name of Azure Machine Learning workspace.", - "in": "path", - "type": "string", - "required": true, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", - "x-ms-parameter-location": "method" - }, - "PaginationParameter": { - "in": "query", - "name": "$skip", - "type": "string", - "description": "Continuation token for pagination.", - "required": false, - "x-ms-parameter-location": "method" - }, - "PrivateEndpointConnectionName": { - "name": "privateEndpointConnectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private endpoint connection associated with the workspace", - "x-ms-parameter-location": "method" - }, - "ConnectionName": { - "name": "connectionName", - "in": "path", - "required": true, - "type": "string", - "description": "Friendly name of the workspace connection", - "x-ms-parameter-location": "method" - }, - "RuleName": { - "name": "ruleName", - "in": "path", - "required": true, - "type": "string", - "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" - }, - "TargetParameter": { - "in": "query", - "name": "target", - "type": "string", - "description": "Target of the workspace connection.", - "required": false, - "x-ms-parameter-location": "method" - }, - "CategoryParameter": { - "in": "query", - "name": "category", - "type": "string", - "description": "Category of the workspace connection.", - "required": false, - "x-ms-parameter-location": "method" }, - "WorkspaceKindParameter": { - "in": "query", - "name": "kind", - "type": "string", - "description": "Kind of workspace.", - "required": false, - "x-ms-parameter-location": "method" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": { + "post": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "summary": "Provisions 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" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$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.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionOptions" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + }, + "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 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$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" + } + } }, - "WorkspaceForceToPurgeParameter": { - "in": "query", - "name": "forceToPurge", - "type": "boolean", - "description": "Flag to indicate delete is a purge request.", - "required": false, - "x-ms-parameter-location": "method" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "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" + ], + "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": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "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 + } + } + }, + "default": { + "description": "Error", + "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" + } + } } }, "definitions": { + "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" + }, "AmlOperation": { - "description": "Azure Machine Learning REST API operation", + "description": "Azure Machine Learning team account REST API operation", "type": "object", "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, "display": { - "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" - } - } + "description": "Gets or sets display name of operation", + "$ref": "#/definitions/OperationDisplay" }, "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" } } }, @@ -1549,792 +1725,944 @@ "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." + ] } } }, - "Workspace": { + "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", "type": "object", - "description": "An object that represents a machine learning workspace.", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } ], "properties": { - "properties": { - "$ref": "#/definitions/WorkspaceProperties", - "description": "The properties of the machine learning workspace.", - "x-ms-client-flatten": true - }, - "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.", + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" + }, + "ComputeRuntimeDto": { + "type": "object", + "properties": { + "sparkRuntimeVersion": { + "type": "string" + } + } + }, + "ConnectionAuthType": { + "description": "Authentication type of the connection target", + "enum": [ + "PAT", + "ManagedIdentity", + "UsernamePassword", + "None", + "SAS", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionAuthType", + "modelAsString": true + } + }, + "ConnectionCategory": { + "description": "Category of the connection", + "enum": [ + "PythonFeed", + "ContainerRegistry", + "Git", + "S3", + "Snowflake", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "CognitiveSearch", + "CognitiveService", + "CustomKeys" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionCategory", + "modelAsString": true + } + }, + "CosmosDbSettings": { + "type": "object", + "properties": { + "collectionsThroughput": { + "format": "int32", + "type": "integer" + } + } + }, + "CustomKeys": { + "type": "object", + "description": "Custom Keys credential object", + "properties": { + "keys": { "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" } } }, - "WorkspaceProperties": { + "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", - "description": "The properties of a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], "properties": { - "workspaceId": { - "description": "The immutable id associated with this workspace.", - "type": "string", - "readOnly": true + "credentials": { + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": {} }, - "description": { - "description": "The description of this workspace.", - "type": "string" + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": {} }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": {} }, "keyVault": { - "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": {} }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": {} }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string", - "x-nullable": true + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": {} }, - "storageAccount": { - "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} }, - "discoveryUrl": { - "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", - "type": "string" + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} }, - "provisioningState": { + "udr": { + "description": "Setting for diagnosing user defined routing", + "type": "object", + "additionalProperties": {} + } + } + }, + "DiagnoseResponseResult": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "userDefinedRouteResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "networkSecurityRuleResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "resourceLockResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "dnsResolutionResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "storageAccountResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "keyVaultResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "containerRegistryResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "applicationInsightsResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "otherResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + } + } + } + } + }, + "DiagnoseResult": { + "type": "object", + "description": "Result of Diagnose", + "properties": { + "code": { + "description": "Code for workspace setup error", "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", - "description": "The encryption settings of Azure ML workspace." + "x-ms-mutability": [ + "read" + ] }, - "hbiWorkspace": { - "type": "boolean", - "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", - "default": false + "level": { + "description": "Level of workspace setup error", + "$ref": "#/definitions/DiagnoseResultLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "serviceProvisionedResourceGroup": { + "message": { + "description": "Message of workspace setup error", "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 + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "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", + "properties": { + "value": { + "$ref": "#/definitions/DiagnoseRequestProperties" + } + } + }, + "EncryptionKeyVaultUpdateProperties": { + "required": [ + "keyIdentifier" + ], + "type": "object", + "properties": { + "keyIdentifier": { + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "EncryptionProperty": { + "required": [ + "keyVaultProperties", + "status" + ], + "type": "object", + "properties": { + "cosmosDbResourceId": { + "description": "The byok cosmosdb account that customer brings to store customer's data\r\nwith encryption", + "type": "string" }, - "privateLinkCount": { - "type": "integer", - "format": "int32", - "description": "Count of private connections in the workspace", - "readOnly": true + "identity": { + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" }, - "imageBuildCompute": { - "description": "The compute name for image build", - "type": "string" + "keyVaultProperties": { + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" }, - "allowPublicAccessWhenBehindVnet": { - "type": "boolean", - "description": "The flag to indicate whether to allow public access when behind VNet.", - "default": false + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" }, - "publicNetworkAccess": { - "type": "string", - "description": "Whether requests from Public Network are allowed.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "PublicNetworkAccess" - } + "status": { + "$ref": "#/definitions/EncryptionStatus" }, - "privateEndpointConnections": { - "readOnly": true, + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + } + } + }, + "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": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } + } + }, + "ExternalFQDNResponse": { + "type": "object", + "properties": { + "value": { "type": "array", "items": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/FQDNEndpointsPropertyBag" }, "x-ms-identifiers": [ - "name" - ], - "description": "The list of private endpoint connections in the workspace." + "/properties/category" + ] + } + } + }, + "FQDNEndpoint": { + "type": "object", + "properties": { + "domainName": { + "type": "string" }, - "sharedPrivateLinkResources": { + "endpointDetails": { "type": "array", "items": { - "$ref": "#/definitions/SharedPrivateLinkResource" + "$ref": "#/definitions/FQDNEndpointDetail" }, "x-ms-identifiers": [ - "name" - ], - "description": "The list of shared private link resources in this workspace." - }, - "notebookInfo": { - "readOnly": true, - "$ref": "#/definitions/NotebookResourceInfo", - "description": "The notebook info of Azure ML workspace." - }, - "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" - }, - "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 - }, - "mlFlowTrackingUri": { - "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", - "type": "string", - "readOnly": true - }, - "v1LegacyMode": { - "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", - "default": false, - "type": "boolean" - }, - "softDeletedAt": { - "description": "The timestamp when the workspace was soft deleted", - "type": "string", - "readOnly": true - }, - "scheduledPurgeDate": { - "description": "The timestamp when the soft deleted workspace is going to be purged", - "type": "string", - "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.", + "port" + ] + } + } + }, + "FQDNEndpointDetail": { + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "FQDNEndpoints": { + "type": "object", + "properties": { + "category": { "type": "string" }, - "associatedWorkspaces": { - "description": "A list of lean workspaces associated with Hub.", + "endpoints": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/FQDNEndpoint" }, - "readOnly": true - }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "x-ms-identifiers": [ + "domainName" + ] } } }, - "WorkspaceUpdateParameters": { + "FQDNEndpointsPropertyBag": { "type": "object", - "description": "The parameters for updating a machine learning workspace.", + "description": "Property bag for FQDN endpoints result", "properties": { - "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 + "$ref": "#/definitions/FQDNEndpoints" } } }, - "WorkspacePropertiesUpdateParameters": { + "FeatureStoreSettings": { "type": "object", - "description": "The parameters for updating the properties of a machine learning workspace.", "properties": { - "description": { - "description": "The description of this workspace.", - "type": "string" + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" }, - "friendlyName": { - "description": "The friendly name for this workspace.", + "offlineStoreConnectionName": { "type": "string" }, - "imageBuildCompute": { - "description": "The compute name for image build", + "onlineStoreConnectionName": { "type": "string" - }, - "serviceManagedResourcesSettings": { - "$ref": "#/definitions/ServiceManagedResourcesSettings", - "description": "The service managed resource settings." - }, - "primaryUserAssignedIdentity": { - "description": "The user assigned identity resource id that represents the workspace identity.", + } + } + }, + "FqdnOutboundRule": { + "type": "object", + "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { "type": "string" - }, - "publicNetworkAccess": { - "type": "string", - "description": "Whether requests from Public Network are allowed.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "PublicNetworkAccess" - } - }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", + } + }, + "x-ms-discriminator-value": "FQDN" + }, + "IdentityForCmk": { + "type": "object", + "description": "Identity object used for encryption.", + "properties": { + "userAssignedIdentity": { + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", + } + } + }, + "IsolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", + "enum": [ + "Disabled", + "AllowInternetOutbound", + "AllowOnlyApprovedOutbound" + ], + "type": "string", + "x-ms-enum": { + "name": "IsolationMode", + "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" }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties", - "description": "The encryption settings of the workspace." - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" } } }, - "WorkspaceListResult": { + "ListNotebookKeysResult": { "type": "object", - "description": "The result of a request to list machine learning workspaces.", "properties": { - "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" - } + "primaryAccessKey": { + "description": "The primary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, - "nextLink": { - "description": "The URI that can be used to request the next list of machine learning workspaces.", - "type": "string" + "secondaryAccessKey": { + "description": "The secondary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } } }, - "DiagnoseRequestProperties": { + "ListStorageAccountKeysResult": { "type": "object", "properties": { - "udr": { - "description": "Setting for diagnosing user defined routing", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "nsg": { - "description": "Setting for diagnosing network security group", - "type": "object", - "additionalProperties": { - "type": "object" - } + "userStorageKey": { + "description": "The access key of the storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "appInsightsInstrumentationKey": { + "description": "The access key of the workspace app insights", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", - "type": "object", - "additionalProperties": { - "type": "object" - } + "containerRegistryCredentials": { + "$ref": "#/definitions/RegistryListCredentialsResult" }, - "dnsResolution": { - "description": "Setting for diagnosing dns resolution", - "type": "object", - "additionalProperties": { - "type": "object" - } + "notebookAccessKeys": { + "$ref": "#/definitions/ListNotebookKeysResult" }, - "storageAccount": { - "description": "Setting for diagnosing dependent storage account", - "type": "object", - "additionalProperties": { - "type": "object" - } + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "keyVault": { - "description": "Setting for diagnosing dependent key vault", - "type": "object", - "additionalProperties": { - "type": "object" - } + "userStorageKey": { + "description": "The access key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" + }, + "ManagedNetworkProvisionOptions": { + "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" + } + } + }, + "ManagedNetworkProvisionStatus": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "sparkReady": { + "type": "boolean" }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", - "type": "object", - "additionalProperties": { - "type": "object" - } + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" + } + } + }, + "ManagedNetworkSettings": { + "description": "Managed Network settings for a machine learning workspace.", + "type": "object", + "properties": { + "isolationMode": { + "$ref": "#/definitions/IsolationMode" }, - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", - "type": "object", - "additionalProperties": { - "type": "object" - } + "networkId": { + "type": "string", + "readOnly": true }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", + "outboundRules": { "type": "object", "additionalProperties": { - "type": "object" - } + "$ref": "#/definitions/OutboundRule" + }, + "x-nullable": true + }, + "status": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" } } }, - "DiagnoseWorkspaceParameters": { + "ManagedNetworkStatus": { + "description": "Status for the managed network of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } + }, + "NoneAuthTypeWorkspaceConnectionProperties": { "type": "object", - "description": "Parameters to diagnose a workspace", - "properties": { - "value": { - "description": "Value of Parameters", - "$ref": "#/definitions/DiagnoseRequestProperties" + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } - } + ], + "x-ms-discriminator-value": "None" }, - "DiagnoseResult": { + "NotebookAccessTokenResult": { "type": "object", - "description": "Result of Diagnose", "properties": { - "code": { - "description": "Code for workspace setup error", + "accessToken": { "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, - "level": { - "description": "Level of workspace setup error", - "enum": [ - "Warning", - "Error", - "Information" + "expiresIn": { + "format": "int32", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "hostName": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "notebookResourceId": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicDns": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "refreshToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" ], + "x-ms-secret": true + }, + "scope": { "type": "string", "readOnly": true, - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } + "x-ms-mutability": [ + "read" + ] }, - "message": { - "description": "Message of workspace setup error", + "tokenType": { "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } } }, - "DiagnoseResponseResult": { + "NotebookPreparationError": { "type": "object", "properties": { - "value": { - "type": "object", - "properties": { - "userDefinedRouteResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "networkSecurityRuleResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "resourceLockResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "dnsResolutionResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "storageAccountResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "keyVaultResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "containerRegistryResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "applicationInsightsResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - }, - "otherResults": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnoseResult" - }, - "x-ms-identifiers": [ - "message" - ] - } - } + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" } } }, - "ListWorkspaceKeysResult": { + "NotebookResourceInfo": { "type": "object", "properties": { - "userStorageKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true - }, - "userStorageResourceId": { - "readOnly": true, + "fqdn": { "type": "string" }, - "appInsightsInstrumentationKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true + "isPrivateLinkEnabled": { + "type": "boolean" }, - "containerRegistryCredentials": { - "readOnly": true, - "$ref": "#/definitions/RegistryListCredentialsResult" + "notebookPreparationError": { + "description": "The error that occurs when preparing notebook.", + "$ref": "#/definitions/NotebookPreparationError" }, - "notebookAccessKeys": { - "readOnly": true, - "$ref": "#/definitions/ListNotebookKeysResult" + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" } } }, - "NotebookAccessTokenResult": { + "OperationDisplay": { + "description": "Display name of operation", "type": "object", "properties": { - "notebookResourceId": { - "readOnly": true, + "description": { + "description": "Gets or sets the description for the operation.", "type": "string" }, - "hostName": { - "readOnly": true, + "operation": { + "description": "Gets or sets the operation that users can perform.", "type": "string" }, - "publicDns": { - "readOnly": true, + "provider": { + "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", "type": "string" }, - "accessToken": { - "readOnly": true, - "type": "string", - "x-ms-secret": true - }, - "tokenType": { - "readOnly": true, + "resource": { + "description": "Gets or sets the resource on which the operation is performed.", "type": "string" + } + } + }, + "OutboundRule": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory" }, - "expiresIn": { - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "refreshToken": { - "readOnly": true, - "type": "string", - "x-ms-secret": true + "status": { + "$ref": "#/definitions/RuleStatus" }, - "scope": { - "readOnly": true, - "type": "string" + "type": { + "$ref": "#/definitions/RuleType" + } + }, + "discriminator": "type" + }, + "OutboundRuleBasicResource": { + "description": "Outbound Rule Basic Resource for the managed network of a machine learning workspace.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OutboundRule" } } }, - "RegistryListCredentialsResult": { + "OutboundRuleListResult": { + "description": "List of outbound rules for the managed network of a machine learning workspace.", "type": "object", "properties": { - "location": { - "readOnly": true, - "type": "string" - }, - "username": { - "readOnly": true, + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", "type": "string" }, - "passwords": { + "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/Password" - }, - "x-ms-identifiers": [ - "name" - ] + "$ref": "#/definitions/OutboundRuleBasicResource" + } } } }, + "PATAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" + } + }, + "x-ms-discriminator-value": "PAT" + }, "Password": { "type": "object", "properties": { "name": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, "value": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } } }, - "PrivateEndpointConnectionListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Array of private endpoint connections", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - } - }, - "description": "List of private endpoint connection associated with the specified workspace" - }, "PrivateEndpointConnection": { "type": "object", + "description": "The Private Endpoint Connection resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "properties": { - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "x-ms-client-flatten": true, - "description": "Resource properties." - }, "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The identity of the resource." + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "location": { - "description": "Specifies the location of the resource.", + "description": "Same as workspace location.", "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" + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "List of private endpoint connection associated with the specified workspace", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } } - ], - "description": "The Private Endpoint Connection resource." + } }, "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties.", "type": "object", "properties": { "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpoint", - "description": "The resource of private end point." + "$ref": "#/definitions/WorkspacePrivateEndpointResource" }, "privateLinkServiceConnectionState": { - "$ref": "#/definitions/PrivateLinkServiceConnectionState", - "description": "A collection of information about the state of the connection between service consumer and provider." + "description": "The connection state.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" }, "provisioningState": { - "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", - "description": "The provisioning state of the private endpoint connection resource." - } - }, - "required": [ - "privateLinkServiceConnectionState" - ], - "description": "Properties of the PrivateEndpointConnectProperties." - }, - "PrivateEndpoint": { - "type": "object", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The ARM identifier for Private Endpoint" - } - }, - "description": "The Private Endpoint resource." - }, - "PrivateLinkServiceConnectionState": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." - }, - "description": { - "type": "string", - "description": "The reason for approval/rejection of the connection." - }, - "actionsRequired": { - "type": "string", - "description": "A message indicating if changes on the service provider require any updates on the consumer." + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" } - }, - "description": "A collection of information about the state of the connection between service consumer and provider." - }, - "PrivateEndpointServiceConnectionStatus": { - "type": "string", - "description": "The private endpoint connection status.", - "enum": [ - "Pending", - "Approved", - "Rejected", - "Disconnected", - "Timeout" - ], - "x-ms-enum": { - "name": "PrivateEndpointServiceConnectionStatus", - "modelAsString": true } }, "PrivateEndpointConnectionProvisioningState": { @@ -2352,401 +2680,249 @@ "modelAsString": true } }, - "PrivateLinkResourceListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Array of private link resources", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } - } - }, - "description": "A list of private link resources" - }, - "PrivateLinkResource": { - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - }, - "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" - }, - "PrivateLinkResourceProperties": { - "type": "object", - "properties": { - "groupId": { - "description": "The private link resource group id.", - "type": "string", - "readOnly": true - }, - "requiredMembers": { - "description": "The private link resource required member names.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "requiredZoneNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The private link resource Private link DNS zone name." - } - }, - "description": "Properties of a private link resource." - }, - "SharedPrivateLinkResource": { - "type": "object", - "properties": { - "name": { - "description": "Unique name of the private link.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/SharedPrivateLinkResourceProperty", - "x-ms-client-flatten": true, - "description": "Resource properties." - } - } - }, - "SharedPrivateLinkResourceProperty": { + "PrivateEndpointDestination": { "type": "object", + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", "properties": { - "privateLinkResourceId": { - "description": "The resource id that private link links to.", - "type": "string" - }, - "groupId": { - "description": "The private link resource group id.", - "type": "string" - }, - "requestMessage": { - "description": "Request message.", + "serviceResourceId": { "type": "string" }, - "status": { - "$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." - }, - "EncryptionProperty": { - "properties": { - "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": { - "$ref": "#/definitions/IdentityForCmk", - "description": "The identity that will be used to access the key vault for encryption at rest." - }, - "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultProperties", - "description": "Customer Key vault properties." - } - }, - "required": [ - "status", - "keyVaultProperties" - ], - "type": "object" - }, - "EncryptionKeyVaultProperties": { - "properties": { - "keyVaultArmId": { - "description": "The ArmId of the keyVault where the customer owned encryption key is present.", - "type": "string" + "sparkEnabled": { + "type": "boolean" }, - "keyIdentifier": { - "description": "Key vault uri to access the encryption key.", - "type": "string" + "sparkStatus": { + "$ref": "#/definitions/RuleStatus" }, - "identityClientId": { - "description": "For future use - The client id of the identity which will be used to access key vault.", - "type": "string" - } - }, - "required": [ - "keyIdentifier", - "keyVaultArmId" - ], - "type": "object" - }, - "IdentityForCmk": { - "description": "Identity that will be used to access key vault for encryption at rest", - "type": "object", - "properties": { - "userAssignedIdentity": { - "description": "The ArmId of the user assigned identity that will be used to access the customer managed key vault", + "subresourceTarget": { "type": "string" } } }, - "EncryptionUpdateProperties": { - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties", - "description": "Customer Key vault properties." + "PrivateEndpointOutboundRule": { + "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" } - }, - "required": [ - "keyVaultProperties" ], - "type": "object" - }, - "EncryptionKeyVaultUpdateProperties": { "properties": { - "keyIdentifier": { - "description": "Key Vault uri to access the encryption key.", - "type": "string" + "destination": { + "$ref": "#/definitions/PrivateEndpointDestination" } }, - "required": [ - "keyIdentifier" - ], - "type": "object" + "x-ms-discriminator-value": "PrivateEndpoint" }, - "ServiceManagedResourcesSettings": { - "type": "object", - "properties": { - "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings", - "description": "The settings for the service managed cosmosdb account." - } + "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)", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointServiceConnectionStatus", + "modelAsString": true } }, - "CosmosDbSettings": { + "PrivateLinkResource": { "type": "object", - "properties": { - "collectionsThroughput": { - "type": "integer", - "format": "int32", - "description": "The throughput of the collections in cosmosdb database" + "description": "A private link resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } - } - }, - "NotebookResourceInfo": { - "type": "object", + ], "properties": { - "fqdn": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", "type": "string" }, - "resourceId": { - "type": "string", - "description": "the data plane resourceId that used to initialize notebook component" + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "x-ms-client-flatten": true }, - "notebookPreparationError": { - "$ref": "#/definitions/NotebookPreparationError", - "description": "The error that occurs when preparing notebook.", - "x-nullable": 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": { + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "NotebookPreparationError": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", "type": "object", "properties": { - "errorMessage": { - "type": "string" - }, - "statusCode": { - "format": "int32", - "type": "integer" + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } } } }, - "ListNotebookKeysResult": { + "PrivateLinkResourceProperties": { "type": "object", + "description": "Properties of a private link resource.", "properties": { - "primaryAccessKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true + "groupId": { + "description": "The private link resource group id.", + "type": "string" }, - "secondaryAccessKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", + "type": "array", + "items": { + "type": "string" + } } } }, - "ListStorageAccountKeysResult": { + "PrivateLinkServiceConnectionState": { "type": "object", + "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { - "userStorageKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string" + }, + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } } }, - "ConnectionAuthType": { + "ProvisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", "enum": [ - "PAT", - "ManagedIdentity", - "UsernamePassword", - "None", - "SAS", - "ServicePrincipal", - "AccessKey" + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" ], "type": "string", - "description": "Authentication type of the connection target", "x-ms-enum": { - "name": "ConnectionAuthType", + "name": "ProvisioningState", "modelAsString": true } }, - "ConnectionCategory": { + "PublicNetworkAccessType": { + "description": "The public network access flag.", "enum": [ - "PythonFeed", - "ContainerRegistry", - "Git", - "FeatureStore", - "S3", - "Snowflake", - "AzureSqlDb", - "AzureSynapseAnalytics", - "AzureMySqlDb", - "AzurePostgresDb", - "AzureDataLakeGen2", - "Redis" + "Enabled", + "Disabled" ], "type": "string", - "description": "Category of the connection", "x-ms-enum": { - "name": "ConnectionCategory", + "name": "PublicNetworkAccessType", "modelAsString": true } }, - "WorkspaceConnectionUsernamePassword": { + "RegistryListCredentialsResult": { "type": "object", "properties": { - "username": { - "type": "string" + "location": { + "description": "The location of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "password": { - "type": "string" - } - }, - "additionalProperties": false - }, - "WorkspaceConnectionPersonalAccessToken": { - "type": "object", - "properties": { - "pat": { - "type": "string" - } - }, - "additionalProperties": false - }, - "PATAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" - } - }, - "additionalProperties": false, - "x-ms-discriminator-value": "PAT" - }, - "WorkspaceConnectionSharedAccessSignature": { - "type": "object", - "properties": { - "sas": { - "type": "string" + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "username": { + "description": "The username of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } - }, - "additionalProperties": false + } }, - "SASAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } + "RuleAction": { + "description": "The action enum for networking rule.", + "enum": [ + "Allow", + "Deny" ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" - } - }, - "additionalProperties": false, - "x-ms-discriminator-value": "SAS" + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } }, - "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } + "RuleCategory": { + "description": "Category of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Required", + "Recommended", + "UserDefined" ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" - } - }, - "additionalProperties": false, - "x-ms-discriminator-value": "UsernamePassword" + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } }, - "WorkspaceConnectionAccessKey": { - "type": "object", - "properties": { - "accessKeyId": { - "type": "string" - }, - "secretAccessKey": { - "type": "string", - "x-ms-secret": true - } - }, - "additionalProperties": false + "RuleStatus": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } }, - "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "RuleType": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "SASAuthTypeWorkspaceConnectionProperties": { "type": "object", "allOf": [ { @@ -2755,27 +2931,18 @@ ], "properties": { "credentials": { - "$ref": "#/definitions/WorkspaceConnectionAccessKey" + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" } }, - "additionalProperties": false, - "x-ms-discriminator-value": "AccessKey" + "x-ms-discriminator-value": "SAS" }, - "WorkspaceConnectionServicePrincipal": { + "ServiceManagedResourcesSettings": { "type": "object", "properties": { - "clientId": { - "type": "string" - }, - "clientSecret": { - "type": "string", - "x-ms-secret": true - }, - "tenantId": { - "type": "string" + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings" } - }, - "additionalProperties": false + } }, "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { "type": "object", @@ -2789,321 +2956,200 @@ "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" } }, - "additionalProperties": false, "x-ms-discriminator-value": "ServicePrincipal" }, - "WorkspaceConnectionPropertiesV2": { - "required": [ - "authType" - ], + "ServiceTagDestination": { "type": "object", + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", "properties": { - "authType": { - "$ref": "#/definitions/ConnectionAuthType" + "action": { + "$ref": "#/definitions/RuleAction" }, - "expiryTime": { - "type": "string" - }, - "category": { - "$ref": "#/definitions/ConnectionCategory" - }, - "target": { - "type": "string" + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true }, - "value": { - "description": "Value details of the workspace connection.", + "portRanges": { "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" - }, - "NoneAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "additionalProperties": false, - "x-ms-discriminator-value": "None" - }, - "WorkspaceConnectionManagedIdentity": { - "type": "object", - "properties": { - "resourceId": { + "protocol": { "type": "string" }, - "clientId": { + "serviceTag": { "type": "string" } - }, - "additionalProperties": false + } }, - "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { + "ServiceTagOutboundRule": { "type": "object", + "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", "allOf": [ { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "$ref": "#/definitions/OutboundRule" } ], "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + "destination": { + "$ref": "#/definitions/ServiceTagDestination" } }, - "additionalProperties": false, - "x-ms-discriminator-value": "ManagedIdentity" - }, - "ManagedNetworkProvisionOptions": { - "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", - "type": "object", - "properties": { - "includeSpark": { - "type": "boolean" - } - } + "x-ms-discriminator-value": "ServiceTag" }, - "ManagedNetworkProvisionStatus": { - "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "SharedPrivateLinkResource": { "type": "object", "properties": { - "status": { - "$ref": "#/definitions/ManagedNetworkStatus" + "name": { + "description": "Unique name of the private link", + "type": "string" }, - "sparkReady": { - "type": "boolean" + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true } } }, - "ManagedNetworkSettings": { - "description": "Managed Network settings for a machine learning workspace.", + "SharedPrivateLinkResourceProperty": { "type": "object", + "description": "Properties of a shared private link resource.", "properties": { - "isolationMode": { - "$ref": "#/definitions/IsolationMode" + "groupId": { + "description": "group id of the private link", + "type": "string" }, - "networkId": { - "type": "string", - "readOnly": true + "privateLinkResourceId": { + "description": "the resource id that private link links to", + "type": "string" }, - "outboundRules": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/OutboundRule" - }, - "x-nullable": true + "requestMessage": { + "description": "Request message", + "type": "string" }, "status": { - "$ref": "#/definitions/ManagedNetworkProvisionStatus" + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } } }, - "ManagedNetworkStatus": { - "description": "Status for the managed network of a machine learning workspace.", - "enum": [ - "Inactive", - "Active" - ], - "type": "string", - "x-ms-enum": { - "name": "ManagedNetworkStatus", - "modelAsString": true - } - }, - "IsolationMode": { - "description": "Isolation mode for the managed network of a machine learning workspace.", - "enum": [ - "Disabled", - "AllowInternetOutbound", - "AllowOnlyApprovedOutbound" + "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } ], - "type": "string", - "x-ms-enum": { - "name": "IsolationMode", - "modelAsString": true - } + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + } + }, + "x-ms-discriminator-value": "UsernamePassword" }, - "OutboundRuleBasicResource": { - "description": "Outbound Rule Basic Resource for the managed network of a machine learning workspace.", + "Workspace": { "required": [ "properties" ], "type": "object", + "description": "An object that represents a machine learning workspace.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ], "properties": { - "properties": { - "$ref": "#/definitions/OutboundRule" - } - }, - "additionalProperties": false - }, - "OutboundRuleListResult": { - "description": "List of outbound rules for the managed network of a machine learning workspace.", - "type": "object", - "properties": { - "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" - } + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "kind": { "type": "string" - } - } - }, - "OutboundRule": { - "description": "Outbound Rule for the managed network of a machine learning workspace.", - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/RuleType" }, - "status": { - "$ref": "#/definitions/RuleStatus" + "location": { + "type": "string" }, - "category": { - "$ref": "#/definitions/RuleCategory" - } - }, - "discriminator": "type" - }, - "RuleCategory": { - "description": "Category of a managed network Outbound Rule of a machine learning workspace.", - "enum": [ - "Required", - "Recommended", - "UserDefined" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleCategory", - "modelAsString": true - } - }, - "RuleStatus": { - "description": "Status of a managed network Outbound Rule of a machine learning workspace.", - "enum": [ - "Inactive", - "Active" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleStatus", - "modelAsString": true - } - }, - "RuleType": { - "description": "Type of a managed network Outbound Rule of a machine learning workspace.", - "enum": [ - "FQDN", - "PrivateEndpoint", - "ServiceTag" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleType", - "modelAsString": true + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/WorkspaceProperties", + "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": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } }, - "FqdnOutboundRule": { - "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionAccessKey": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], "properties": { - "destination": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { "type": "string" } - }, - "x-ms-discriminator-value": "FQDN" + } }, - "PrivateEndpointOutboundRule": { - "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionApiKey": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], + "description": "Api key object for workspace connection credential.", "properties": { - "destination": { - "$ref": "#/definitions/PrivateEndpointDestination" + "key": { + "type": "string" } - }, - "x-ms-discriminator-value": "PrivateEndpoint" + } }, - "PrivateEndpointDestination": { - "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionManagedIdentity": { "type": "object", "properties": { - "serviceResourceId": { + "clientId": { "type": "string" }, - "subresourceTarget": { + "resourceId": { "type": "string" - }, - "sparkEnabled": { - "type": "boolean" - }, - "sparkStatus": { - "$ref": "#/definitions/RuleStatus" } } }, - "ServiceTagOutboundRule": { - "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionPersonalAccessToken": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], "properties": { - "destination": { - "$ref": "#/definitions/ServiceTagDestination" + "pat": { + "type": "string" } - }, - "x-ms-discriminator-value": "ServiceTag" + } }, - "ServiceTagDestination": { - "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionPropertiesV2": { + "required": [ + "authType" + ], "type": "object", "properties": { - "serviceTag": { - "type": "string" + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" }, - "protocol": { + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "expiryTime": { + "format": "date-time", "type": "string" }, - "portRanges": { + "metadata": { + "type": "object" + }, + "target": { "type": "string" } - } + }, + "discriminator": "authType" }, "WorkspaceConnectionPropertiesV2BasicResource": { "required": [ @@ -3119,111 +3165,497 @@ "properties": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } - }, - "additionalProperties": false + } }, "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { "type": "object", "properties": { + "nextLink": { + "type": "string" + }, "value": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } + } + } + }, + "WorkspaceConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, + "WorkspaceConnectionSharedAccessSignature": { + "type": "object", + "properties": { + "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" + } + } + }, + "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": { + "type": "string" + } + } + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "type": "object", + "properties": { "nextLink": { - "readOnly": true, + "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" + } } - }, - "additionalProperties": false + } }, - "FQDNEndpointDetail": { + "WorkspacePrivateEndpointResource": { "type": "object", + "description": "The Private Endpoint resource.", "properties": { - "port": { - "format": "int32", - "type": "integer" + "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" + ] } } }, - "FQDNEndpoint": { + "WorkspaceProperties": { + "description": "The properties of a machine learning workspace.", "type": "object", "properties": { - "domainName": { + "allowPublicAccessWhenBehindVnet": { + "description": "The flag to indicate whether to allow public access when behind VNet.", + "type": "boolean" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "associatedWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "type": "array", + "items": { + "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" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "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" + }, + "hbiWorkspace": { + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "type": "boolean" + }, + "hubResourceId": { + "type": "string" + }, + "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" + }, + "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" + ] + }, + "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" }, - "endpointDetails": { + "privateEndpointConnections": { + "description": "The list of private endpoint connections in the workspace.", "type": "array", "items": { - "$ref": "#/definitions/FQDNEndpointDetail" + "$ref": "#/definitions/PrivateEndpointConnection" }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-identifiers": [ - "port" + "name" ] - } - } - }, - "FQDNEndpointsProperties": { - "type": "object", - "properties": { - "category": { - "type": "string" }, - "endpoints": { + "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" + ] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources in this workspace.", "type": "array", "items": { - "$ref": "#/definitions/FQDNEndpoint" + "$ref": "#/definitions/SharedPrivateLinkResource" }, "x-ms-identifiers": [ - "domainName" + "name" ] - } - } - }, - "FQDNEndpoints": { - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/FQDNEndpointsProperties" - } - } - }, - "ExternalFQDNResponse": { - "type": "object", - "properties": { - "value": { + }, + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccounts": { "type": "array", "items": { - "$ref": "#/definitions/FQDNEndpoints" - }, - "x-ms-identifiers": [ - "/properties/category" + "type": "string" + } + }, + "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" + }, + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + }, + "workspaceHubConfig": { + "$ref": "#/definitions/WorkspaceHubConfig" + }, + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" ] } } }, - "FeatureStoreSettings": { + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", "type": "object", "properties": { - "computeRuntime": { - "$ref": "#/definitions/ComputeRuntimeDto" + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" }, - "offlineStoreConnectionName": { + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", "type": "string" }, - "onlineStoreConnectionName": { + "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", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" } } }, - "ComputeRuntimeDto": { + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", "type": "object", "properties": { - "sparkRuntimeVersion": { - "type": "string" + "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" + } } } } + }, + "parameters": { + "WorkspaceKindParameter": { + "in": "query", + "name": "kind", + "description": "Kind of workspace.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "in": "path", + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WorkspaceForceToPurgeParameter": { + "in": "query", + "name": "forceToPurge", + "description": "Flag to indicate delete is a purge request.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "description": "Target of the workspace connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "description": "Category of the workspace connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "in": "path", + "name": "connectionName", + "description": "Friendly name of the workspace connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "RuleName": { + "in": "path", + "name": "ruleName", + "description": "Name of the workspace managed network outbound rule", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "PrivateEndpointConnectionName": { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "NRP Private Endpoint Connection Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } } } diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index cedec56e2175..7aa94dc3eef6 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -376,4 +376,4 @@ See configuration in [readme.go.md](./readme.go.md) ## Java -See configuration in [readme.java.md](./readme.java.md) +See configuration in [readme.java.md](./readme.java.md) \ No newline at end of file