From 9bfe17c11b4f8a93c518f62952fb919114f8f934 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Tue, 6 Jun 2023 09:52:48 -0700 Subject: [PATCH 01/19] Update workspace rp swagger with automation result rename pe definition to avoid conflict fix update PE name Update connection credential hide armid fix more things Fix enum issue fix polymorphism Update examples Update body name and example fix more issue update response body Fix Revert "file change" This reverts commit 4a1fdccf6eb22e1dda82d3acce8065fae171f422. file change Update swagger fix errors update format add example for connetion list secrets api run prettier --- custom-words.txt | 2 + .../ManagedNetwork/createOrUpdateRule.json | 2 +- .../examples/ManagedNetwork/deleteRule.json | 18 - .../examples/ManagedNetwork/provision.json | 2 +- .../createOrUpdate.json | 2 +- .../examples/Workspace/create.json | 2 +- .../examples/Workspace/diagnose.json | 2 +- .../examples/Workspace/listKeys.json | 2 +- .../examples/Workspace/update.json | 2 +- .../examples/WorkspaceConnection/create.json | 2 +- .../WorkspaceConnection/listSecrets.json | 38 + .../examples/WorkspaceConnection/update.json | 51 + .../machineLearningServices.json | 78 - .../2023-06-01-preview/workspaceRP.json | 3958 +++++++++-------- 14 files changed, 2228 insertions(+), 1933 deletions(-) delete mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json diff --git a/custom-words.txt b/custom-words.txt index e460d7f7ad01..41a4f5a38ea4 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1659,6 +1659,7 @@ preloading prem premieraddonoffers premieraddons +preparenotebook Preprovisioned Preprovisioning prerestore @@ -1838,6 +1839,7 @@ restrant restype resumable resync +resynckeys resynchronization Resynchronize retaineddata 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/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json deleted file mode 100644 index 0584ddea1faa..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "test-rg", - "workspaceName": "aml-workspace-name", - "ruleName": "some_string", - "api-version": "2023-06-01-preview" - }, - "responses": { - "202": { - "headers": { - "Location": "example_location" - } - }, - "200": {}, - "204": {} - } -} 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 a58ec8ab898f..a2f150ca0efa 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..c7cbfd55a40a 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,78 @@ } }, "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/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$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 +125,47 @@ "$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/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" }, @@ -190,43 +176,50 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/WorkspaceForceToPurgeParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "forceToPurge", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" } ], "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 +230,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 +240,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 +273,49 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/PaginationParameter" + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/WorkspaceKindParameter" + "in": "body", + "name": "body", + "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 +337,22 @@ }, { "in": "body", - "name": "parameters", - "description": "The parameter of diagnosing workspace health", + "name": "body", + "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 +367,6 @@ } } }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" - } - }, "default": { "description": "Error", "schema": { @@ -379,8 +375,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 +385,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { "tags": [ - "Workspaces" + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_List", + "produces": [ + "application/json" ], - "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" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -413,41 +403,51 @@ }, { "$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" + "WorkspaceConnectionV2Resource" + ], + "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 +456,91 @@ }, { "$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" + "WorkspaceConnectionV2Resource" + ], + "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/WorkspaceNameParameter" }, { - "$ref": "#/parameters/PaginationParameter" + "$ref": "#/parameters/ConnectionName" }, { - "$ref": "#/parameters/WorkspaceKindParameter" + "$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" + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Update", + "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 +549,106 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "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" + "WorkspaceConnectionV2Resource" + ], + "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", + "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" + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_ListSecrets", + "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 +660,7 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/PrivateEndpointConnectionName" + "$ref": "#/parameters/ConnectionName" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -637,30 +668,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,93 +710,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" } }, - "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/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." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } + "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}/privateLinkResources": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { "tags": [ - "WorkspacePrivateLinkResources" + "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" ], - "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,85 +789,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/ListWorkspaceKeysResult" } }, "default": { - "description": "Error response describing why the operation failed", + "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { - "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" - } - }, - "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/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/NotebookResourceInfo" - } - }, - "202": { - "description": "The request was successful; the request was well-formed and received properly." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { "post": { "tags": [ "ProxyOperations" ], - "operationId": "Workspaces_ListStorageAccountKeys", - "description": "List storage account keys of a workspace.", - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.json" - } - }, + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "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,21 +827,29 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListStorageAccountKeysResult" + "$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" + } } } }, @@ -884,17 +858,12 @@ "tags": [ "ProxyOperations" ], + "summary": "Lists keys of Azure Machine Learning Workspaces notebook.", "operationId": "Workspaces_ListNotebookKeys", - "description": "List keys of a notebook.", - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Notebook/listKeys.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" }, @@ -903,6 +872,9 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -913,20 +885,29 @@ } }, "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" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "post": { "tags": [ - "V2WorkspaceConnectionResource" + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", + "operationId": "Workspaces_ListStorageAccountKeys", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Create", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -935,29 +916,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/ListStorageAccountKeysResult" } }, "default": { @@ -968,16 +937,22 @@ } }, "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { "get": { "tags": [ - "V2WorkspaceConnectionResource" + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "outboundNetworkDependenciesEndpoints", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Get", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -986,10 +961,7 @@ "$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" @@ -997,9 +969,9 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/ExternalFQDNResponse" } }, "default": { @@ -1010,16 +982,21 @@ } }, "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/get.json" + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "get": { "tags": [ - "V2WorkspaceConnectionResource" + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_List", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Delete", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1028,42 +1005,45 @@ "$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" } ], "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, "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" + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { "get": { "tags": [ - "V2WorkspaceConnectionResource" + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Get", + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_List", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1072,13 +1052,10 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/TargetParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/CategoryParameter" + "$ref": "#/parameters/RuleName" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1088,7 +1065,7 @@ "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + "$ref": "#/definitions/OutboundRuleBasicResource" } }, "default": { @@ -1099,22 +1076,19 @@ } }, "x-ms-examples": { - "ListWorkspaceConnections": { - "$ref": "./examples/WorkspaceConnection/list.json" + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { - "get": { + }, + "put": { "tags": [ "ManagedNetwork" ], - "description": "Lists the managed network outbound rules for a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_List", + "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -1128,15 +1102,42 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "#/parameters/RuleName" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/OutboundRuleListResult" + "$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": { @@ -1146,23 +1147,27 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.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}/prepareNotebook": { + "post": { "tags": [ - "ManagedNetwork" + "ProxyOperations" + ], + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", + "operationId": "Workspaces_PrepareNotebook", + "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,29 +1178,33 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/RuleName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/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 } } }, - "204": { - "description": "The machine learning workspace does not exist in the subscription." - }, - "200": { - "description": "The request was successful; the request was well-formed and received properly." - }, "default": { "description": "Error", "schema": { @@ -1204,21 +1213,26 @@ } }, "x-ms-examples": { - "Delete ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/deleteRule.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}/privateEndpointConnections": { "get": { "tags": [ - "ManagedNetwork" + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get all PE connections.", + "operationId": "PrivateEndpointConnections_List", + "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" @@ -1229,9 +1243,6 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/RuleName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -1240,7 +1251,7 @@ "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" + "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { @@ -1251,17 +1262,25 @@ } }, "x-ms-examples": { - "Get ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/getRule.json" + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": null } - }, - "put": { + } + }, + "/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": "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 +1292,63 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "#/parameters/RuleName" + "$ref": "#/parameters/PrivateEndpointConnectionName" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" }, - { - "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", - "in": "body", - "name": "parameters", - "required": true, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - } - } + "summary": "Called by end-users to get a PE connection.", + "operationId": "PrivateEndpointConnections_Get", + "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": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$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" + "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { @@ -1312,36 +1359,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 +1387,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 +1415,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 +1449,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,1284 +1462,1342 @@ } }, "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_Post", + "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", + "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" } } }, "AmlOperationListResult": { "type": "object", - "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.", - "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" + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" } - } + }, + "x-ms-discriminator-value": "ApiKey" }, - "WorkspaceProperties": { + "ComputeRuntimeDto": { "type": "object", - "description": "The properties of a machine learning workspace.", "properties": { - "workspaceId": { - "description": "The immutable id associated with this workspace.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" - }, - "keyVault": { - "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" - }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string", - "x-nullable": true - }, - "storageAccount": { - "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" - }, - "discoveryUrl": { - "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "sparkRuntimeVersion": { "type": "string" - }, - "provisioningState": { - "type": "string", - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled", - "SoftDeleted" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - }, - "readOnly": true, - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." - }, - "encryption": { - "$ref": "#/definitions/EncryptionProperty", - "description": "The encryption settings of Azure ML workspace." - }, - "hbiWorkspace": { - "type": "boolean", - "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", - "default": false - }, - "serviceProvisionedResourceGroup": { - "type": "string", - "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", - "readOnly": true - }, - "privateLinkCount": { - "type": "integer", + } + } + }, + "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", - "description": "Count of private connections in the workspace", - "readOnly": true - }, - "imageBuildCompute": { - "description": "The compute name for image build", - "type": "string" - }, - "allowPublicAccessWhenBehindVnet": { - "type": "boolean", - "description": "The flag to indicate whether to allow public access when behind VNet.", - "default": false - }, - "publicNetworkAccess": { - "type": "string", - "description": "Whether requests from Public Network are allowed.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "PublicNetworkAccess" + "type": "integer" + } + } + }, + "Credentials": { + "type": "object" + }, + "CustomKeys": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" } + } + } + }, + "CustomKeysWorkspaceConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": {} }, - "privateEndpointConnections": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The list of private endpoint connections in the workspace." + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": {} }, - "sharedPrivateLinkResources": { - "type": "array", - "items": { - "$ref": "#/definitions/SharedPrivateLinkResource" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The list of shared private link resources in this workspace." + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": {} }, - "notebookInfo": { - "readOnly": true, - "$ref": "#/definitions/NotebookResourceInfo", - "description": "The notebook info of Azure ML workspace." + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": {} }, - "serviceManagedResourcesSettings": { - "$ref": "#/definitions/ServiceManagedResourcesSettings", - "description": "The service managed resource settings." + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": {} }, - "primaryUserAssignedIdentity": { - "description": "The user assigned identity resource id that represents the workspace identity.", - "type": "string" + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": {} }, - "tenantId": { - "description": "The tenant id associated with this workspace.", - "type": "string", - "readOnly": true + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} }, - "storageHnsEnabled": { - "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", - "type": "boolean", - "readOnly": true + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} }, - "mlFlowTrackingUri": { - "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "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", + "properties": { + "code": { + "description": "Code for workspace setup error", "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" + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "softDeletedAt": { - "description": "The timestamp when the workspace was soft deleted", - "type": "string", - "readOnly": true + "level": { + "description": "Level of workspace setup error", + "$ref": "#/definitions/DiagnoseResultLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "scheduledPurgeDate": { - "description": "The timestamp when the soft deleted workspace is going to be purged", + "message": { + "description": "Message of workspace setup error", "type": "string", - "readOnly": true - }, - "systemDatastoresAuthMode": { - "description": "The auth mode used for accessing the system datastores of the workspace", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "DiagnoseResultLevel": { + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "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" }, - "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" + "identity": { + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" }, - "storageAccounts": { - "description": ": A list of storage accounts used by Hub.", - "type": "array", - "items": { - "type": "string" - } + "keyVaultProperties": { + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" }, - "keyVaults": { - "description": "A list of key vaults used by Hub.", - "type": "array", - "items": { - "type": "string" - } + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" }, - "containerRegistries": { - "description": "A list of container registries used by Hub.", - "type": "array", - "items": { - "type": "string" - } + "status": { + "$ref": "#/definitions/EncryptionStatus" }, - "existingWorkspaces": { - "description": "A list of existing workspaces used by Hub to perform convert.", + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + } + } + }, + "EncryptionStatus": { + "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": { - "type": "string" - } - }, - "hubResourceId": { - "description": "Resource Id of Hub used for lean workspace.", + "$ref": "#/definitions/FQDNEndpointsPropertyBag" + }, + "x-ms-identifiers": [ + "/properties/category" + ] + } + } + }, + "FQDNEndpoint": { + "type": "object", + "properties": { + "domainName": { "type": "string" }, - "associatedWorkspaces": { - "description": "A list of lean workspaces associated with Hub.", + "endpointDetails": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/FQDNEndpointDetail" }, - "readOnly": true - }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "x-ms-identifiers": [ + "port" + ] } } }, - "WorkspaceUpdateParameters": { + "FQDNEndpointDetail": { "type": "object", - "description": "The parameters for updating a machine learning workspace.", "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 + "port": { + "format": "int32", + "type": "integer" } } }, - "WorkspacePropertiesUpdateParameters": { + "FQDNEndpoints": { "type": "object", - "description": "The parameters for updating the properties of a machine learning workspace.", "properties": { - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for this workspace.", - "type": "string" - }, - "imageBuildCompute": { - "description": "The compute name for image build", - "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.", + "category": { "type": "string" }, - "publicNetworkAccess": { - "type": "string", - "description": "Whether requests from Public Network are allowed.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "PublicNetworkAccess" - } + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "FQDNEndpointsPropertyBag": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpoints" + } + } + }, + "FeatureStoreSettings": { + "type": "object", + "properties": { + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", + "offlineStoreConnectionName": { "type": "string" }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", + "onlineStoreConnectionName": { "type": "string" - }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties", - "description": "The encryption settings of the workspace." - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" } } }, - "WorkspaceListResult": { + "FqdnOutboundRule": { "type": "object", - "description": "The result of a request to list machine learning workspaces.", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], "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" - } - }, - "nextLink": { - "description": "The URI that can be used to request the next list of machine learning workspaces.", + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" + }, + "IValue": { + "type": "object" + }, + "IdentityForCmk": { + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", "type": "string" } } }, - "DiagnoseRequestProperties": { + "KeyVaultProperties": { + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], "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" - } + "identityClientId": { + "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", + "type": "string" }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", - "type": "object", - "additionalProperties": { - "type": "object" - } + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" }, - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", - "type": "object", - "additionalProperties": { - "type": "object" - } + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "ListNotebookKeysResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "description": "The primary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", - "type": "object", - "additionalProperties": { - "type": "object" - } + "secondaryAccessKey": { + "description": "The secondary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } } }, - "DiagnoseWorkspaceParameters": { + "ListStorageAccountKeysResult": { "type": "object", - "description": "Parameters to diagnose a workspace", "properties": { - "value": { - "description": "Value of Parameters", - "$ref": "#/definitions/DiagnoseRequestProperties" + "userStorageKey": { + "description": "The access key of the storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } } }, - "DiagnoseResult": { + "ListWorkspaceKeysResult": { "type": "object", - "description": "Result of Diagnose", "properties": { - "code": { - "description": "Code for workspace setup error", + "appInsightsInstrumentationKey": { + "description": "The access key of the workspace app insights", "type": "string", - "readOnly": true - }, - "level": { - "description": "Level of workspace setup error", - "enum": [ - "Warning", - "Error", - "Information" + "readOnly": true, + "x-ms-mutability": [ + "read" ], + "x-ms-secret": true + }, + "containerRegistryCredentials": { + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/ListNotebookKeysResult" + }, + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", "type": "string", "readOnly": true, - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } + "x-ms-mutability": [ + "read" + ] }, - "message": { - "description": "Message of workspace setup error", + "userStorageKey": { + "description": "The access key of the workspace storage", "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } } }, - "DiagnoseResponseResult": { + "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], "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" - ] - } - } + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" + }, + "ManagedNetworkProvisionOptions": { + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" } } }, - "ListWorkspaceKeysResult": { + "ManagedNetworkProvisionStatus": { "type": "object", "properties": { - "userStorageKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true - }, - "userStorageResourceId": { - "readOnly": true, - "type": "string" - }, - "appInsightsInstrumentationKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true - }, - "containerRegistryCredentials": { - "readOnly": true, - "$ref": "#/definitions/RegistryListCredentialsResult" + "sparkReady": { + "type": "boolean" }, - "notebookAccessKeys": { - "readOnly": true, - "$ref": "#/definitions/ListNotebookKeysResult" + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" } } }, + "ManagedNetworkStatus": { + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } + }, + "NoneAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" + }, "NotebookAccessTokenResult": { "type": "object", "properties": { - "notebookResourceId": { + "accessToken": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, - "hostName": { + "expiresIn": { + "format": "int32", + "type": "integer", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, - "publicDns": { + "hostName": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, - "accessToken": { - "readOnly": true, + "notebookResourceId": { "type": "string", - "x-ms-secret": true - }, - "tokenType": { "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, - "expiresIn": { + "publicDns": { + "type": "string", "readOnly": true, - "type": "integer", - "format": "int32" + "x-ms-mutability": [ + "read" + ] }, "refreshToken": { - "readOnly": true, "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-secret": true }, "scope": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] + }, + "tokenType": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } } }, - "RegistryListCredentialsResult": { + "NotebookPreparationError": { "type": "object", "properties": { - "location": { - "readOnly": true, + "errorMessage": { "type": "string" }, - "username": { - "readOnly": true, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { "type": "string" }, - "passwords": { - "type": "array", - "items": { - "$ref": "#/definitions/Password" - }, - "x-ms-identifiers": [ - "name" - ] + "isPrivateLinkEnabled": { + "type": "boolean" + }, + "notebookPreparationError": { + "description": "The error that occurs when preparing notebook.", + "$ref": "#/definitions/NotebookPreparationError" + }, + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" } } }, - "Password": { + "OperationDisplay": { + "description": "Display name of operation", "type": "object", "properties": { - "name": { - "readOnly": true, + "description": { + "description": "Gets or sets the description for the operation.", "type": "string" }, - "value": { - "readOnly": true, + "operation": { + "description": "Gets or sets the operation that users can perform.", + "type": "string" + }, + "provider": { + "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "Gets or sets the resource on which the operation is performed.", "type": "string" } } }, - "PrivateEndpointConnectionListResult": { + "OutboundRule": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory" + }, + "status": { + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "$ref": "#/definitions/RuleType" + } + }, + "discriminator": "type" + }, + "OutboundRuleBasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OutboundRule" + } + } + }, + "OutboundRuleListResult": { "type": "object", "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", - "description": "Array of private endpoint connections", "items": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/OutboundRuleBasicResource" } } + } + }, + "PATAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" + } }, - "description": "List of private endpoint connection associated with the specified workspace" + "x-ms-discriminator-value": "PAT" }, - "PrivateEndpointConnection": { + "Password": { "type": "object", "properties": { - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "x-ms-client-flatten": true, - "description": "Resource properties." + "name": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, + "value": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/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", + "properties": { + "value": { + "type": "array", + "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." + "description": "The PE network resource that is linked to this PE connection.", + "$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." + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } + } + }, + "PrivateEndpointDestination": { + "type": "object", + "properties": { + "serviceResourceId": { + "type": "string" + }, + "sparkEnabled": { + "type": "boolean" + }, + "sparkStatus": { + "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" } - }, - "required": [ - "privateLinkServiceConnectionState" - ], - "description": "Properties of the PrivateEndpointConnectProperties." + } }, - "PrivateEndpoint": { + "PrivateEndpointOutboundRule": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The ARM identifier for Private Endpoint" + "destination": { + "$ref": "#/definitions/PrivateEndpointDestination" } }, - "description": "The Private Endpoint resource." + "x-ms-discriminator-value": "PrivateEndpoint" }, - "PrivateLinkServiceConnectionState": { + "WorkspacePrivateEndpointResource": { "type": "object", "properties": { - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." - }, - "description": { + "id": { + "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "type": "string", - "description": "The reason for approval/rejection of the connection." + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "actionsRequired": { + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", "type": "string", - "description": "A message indicating if changes on the service provider require any updates on the consumer." + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } - }, - "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.", + "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": [ - "Pending", "Approved", + "Pending", "Rejected", "Disconnected", "Timeout" ], - "x-ms-enum": { - "name": "PrivateEndpointServiceConnectionStatus", - "modelAsString": true - } - }, - "PrivateEndpointConnectionProvisioningState": { "type": "string", - "readOnly": true, - "description": "The current provisioning state.", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Failed" - ], "x-ms-enum": { - "name": "PrivateEndpointConnectionProvisioningState", + "name": "EndpointServiceConnectionStatus", "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", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "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." + "$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": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "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" + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } } - ], - "description": "A private link resource" + } }, "PrivateLinkResourceProperties": { "type": "object", "properties": { "groupId": { "description": "The private link resource group id.", - "type": "string", - "readOnly": true + "type": "string" }, "requiredMembers": { "description": "The private link resource required member names.", "type": "array", "items": { "type": "string" - }, - "readOnly": true + } }, "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", "type": "array", "items": { "type": "string" - }, - "description": "The private link resource Private link DNS zone name." - } - }, - "description": "Properties of a private link resource." - }, - "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": { + "PrivateLinkServiceConnectionState": { "type": "object", "properties": { - "privateLinkResourceId": { - "description": "The resource id that private link links to.", - "type": "string" - }, - "groupId": { - "description": "The private link resource group id.", + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", "type": "string" }, - "requestMessage": { - "description": "Request message.", + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", "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" - }, - "keyIdentifier": { - "description": "Key vault uri to access the encryption key.", - "type": "string" - }, - "identityClientId": { - "description": "For future use - The client id of the identity which will be used to access key vault.", - "type": "string" - } - }, - "required": [ - "keyIdentifier", - "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", - "type": "string" + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } } }, - "EncryptionUpdateProperties": { - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties", - "description": "Customer Key vault properties." - } - }, - "required": [ - "keyVaultProperties" - ], - "type": "object" - }, - "EncryptionKeyVaultUpdateProperties": { - "properties": { - "keyIdentifier": { - "description": "Key Vault uri to access the encryption key.", - "type": "string" - } - }, - "required": [ - "keyIdentifier" + "ProvisioningState": { + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" ], - "type": "object" - }, - "ServiceManagedResourcesSettings": { - "type": "object", - "properties": { - "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings", - "description": "The settings for the service managed cosmosdb account." - } + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true } }, - "CosmosDbSettings": { - "type": "object", - "properties": { - "collectionsThroughput": { - "type": "integer", - "format": "int32", - "description": "The throughput of the collections in cosmosdb database" - } + "PublicNetworkAccessType": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true } }, - "NotebookResourceInfo": { + "RegistryListCredentialsResult": { "type": "object", "properties": { - "fqdn": { - "type": "string" - }, - "resourceId": { + "location": { + "description": "The location of the workspace ACR", "type": "string", - "description": "the data plane resourceId that used to initialize notebook component" + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "notebookPreparationError": { - "$ref": "#/definitions/NotebookPreparationError", - "description": "The error that occurs when preparing notebook.", - "x-nullable": true - } - } - }, - "NotebookPreparationError": { - "type": "object", - "properties": { - "errorMessage": { - "type": "string" + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + }, + "x-ms-identifiers": [ + "name" + ] }, - "statusCode": { - "format": "int32", - "type": "integer" - } - } - }, - "ListNotebookKeysResult": { - "type": "object", - "properties": { - "primaryAccessKey": { - "readOnly": true, + "username": { + "description": "The username of the workspace ACR", "type": "string", - "x-ms-secret": true - }, - "secondaryAccessKey": { "readOnly": true, - "type": "string", - "x-ms-secret": true + "x-ms-mutability": [ + "read" + ] } } }, - "ListStorageAccountKeysResult": { - "type": "object", - "properties": { - "userStorageKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true - } + "RuleAction": { + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true } }, - "ConnectionAuthType": { + "RuleCategory": { "enum": [ - "PAT", - "ManagedIdentity", - "UsernamePassword", - "None", - "SAS", - "ServicePrincipal", - "AccessKey" + "Required", + "Recommended", + "UserDefined" ], "type": "string", - "description": "Authentication type of the connection target", "x-ms-enum": { - "name": "ConnectionAuthType", + "name": "RuleCategory", "modelAsString": true } }, - "ConnectionCategory": { + "RuleStatus": { "enum": [ - "PythonFeed", - "ContainerRegistry", - "Git", - "FeatureStore", - "S3", - "Snowflake", - "AzureSqlDb", - "AzureSynapseAnalytics", - "AzureMySqlDb", - "AzurePostgresDb", - "AzureDataLakeGen2", - "Redis" + "Inactive", + "Active" ], "type": "string", - "description": "Category of the connection", "x-ms-enum": { - "name": "ConnectionCategory", + "name": "RuleStatus", "modelAsString": true } }, - "WorkspaceConnectionUsernamePassword": { - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - }, - "additionalProperties": false - }, - "WorkspaceConnectionPersonalAccessToken": { - "type": "object", - "properties": { - "pat": { - "type": "string" - } - }, - "additionalProperties": false - }, - "PATAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } + "RuleType": { + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" - } - }, - "additionalProperties": false, - "x-ms-discriminator-value": "PAT" - }, - "WorkspaceConnectionSharedAccessSignature": { - "type": "object", - "properties": { - "sas": { - "type": "string" - } - }, - "additionalProperties": false + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } }, "SASAuthTypeWorkspaceConnectionProperties": { "type": "object", @@ -2715,10 +2811,17 @@ "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" } }, - "additionalProperties": false, "x-ms-discriminator-value": "SAS" }, - "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { + "ServiceManagedResourcesSettings": { + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings" + } + } + }, + "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { "type": "object", "allOf": [ { @@ -2727,57 +2830,84 @@ ], "properties": { "credentials": { - "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" } }, - "additionalProperties": false, - "x-ms-discriminator-value": "UsernamePassword" + "x-ms-discriminator-value": "ServicePrincipal" }, - "WorkspaceConnectionAccessKey": { + "ServiceTagDestination": { "type": "object", "properties": { - "accessKeyId": { + "action": { + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { "type": "string" }, - "secretAccessKey": { - "type": "string", - "x-ms-secret": true + "protocol": { + "type": "string" + }, + "serviceTag": { + "type": "string" } - }, - "additionalProperties": false + } }, - "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "ServiceTagOutboundRule": { "type": "object", "allOf": [ { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "$ref": "#/definitions/OutboundRule" } ], "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionAccessKey" + "destination": { + "$ref": "#/definitions/ServiceTagDestination" } }, - "additionalProperties": false, - "x-ms-discriminator-value": "AccessKey" + "x-ms-discriminator-value": "ServiceTag" }, - "WorkspaceConnectionServicePrincipal": { + "SharedPrivateLinkResource": { "type": "object", "properties": { - "clientId": { + "name": { + "description": "Unique name of the private link", "type": "string" }, - "clientSecret": { - "type": "string", - "x-ms-secret": true + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true + } + } + }, + "SharedPrivateLinkResourceProperty": { + "type": "object", + "properties": { + "groupId": { + "description": "group id of the private link", + "type": "string" }, - "tenantId": { + "privateLinkResourceId": { + "description": "the resource id that private link links to", + "type": "string" + }, + "requestMessage": { + "description": "Request message", "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } - }, - "additionalProperties": false + } }, - "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { + "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { "type": "object", "allOf": [ { @@ -2786,157 +2916,137 @@ ], "properties": { "credentials": { - "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" } }, - "additionalProperties": false, - "x-ms-discriminator-value": "ServicePrincipal" + "x-ms-discriminator-value": "UsernamePassword" }, - "WorkspaceConnectionPropertiesV2": { + "Workspace": { "required": [ - "authType" + "properties" ], "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "properties": { - "authType": { - "$ref": "#/definitions/ConnectionAuthType" + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, - "expiryTime": { + "kind": { "type": "string" }, - "category": { - "$ref": "#/definitions/ConnectionCategory" - }, - "target": { + "location": { "type": "string" }, - "value": { - "description": "Value details of the workspace connection.", - "type": "string" + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/WorkspaceProperties", + "x-ms-client-flatten": true }, - "valueFormat": { - "description": "format for the workspace connection value", - "type": "string", - "enum": [ - "JSON" - ], - "x-ms-enum": { - "name": "ValueFormat", - "modelAsString": 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" } } - }, - "additionalProperties": false, - "discriminator": "authType" + } }, - "NoneAuthTypeWorkspaceConnectionProperties": { + "WorkspaceConnectionAccessKey": { "type": "object", "allOf": [ { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "$ref": "#/definitions/Credentials" } ], - "additionalProperties": false, - "x-ms-discriminator-value": "None" - }, - "WorkspaceConnectionManagedIdentity": { - "type": "object", "properties": { - "resourceId": { + "accessKeyId": { "type": "string" }, - "clientId": { + "secretAccessKey": { "type": "string" } - }, - "additionalProperties": false + } }, - "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { + "WorkspaceConnectionApiKey": { "type": "object", "allOf": [ { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "$ref": "#/definitions/Credentials" } ], "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + "key": { + "type": "string" } - }, - "additionalProperties": false, - "x-ms-discriminator-value": "ManagedIdentity" + } }, - "ManagedNetworkProvisionOptions": { - "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", + "WorkspaceConnectionManagedIdentity": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], "properties": { - "includeSpark": { - "type": "boolean" + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" } } }, - "ManagedNetworkProvisionStatus": { - "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "WorkspaceConnectionPersonalAccessToken": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], "properties": { - "status": { - "$ref": "#/definitions/ManagedNetworkStatus" - }, - "sparkReady": { - "type": "boolean" + "pat": { + "type": "string" } } }, - "ManagedNetworkSettings": { - "description": "Managed Network settings for a machine learning workspace.", + "WorkspaceConnectionPropertiesV2": { + "required": [ + "authType" + ], "type": "object", "properties": { - "isolationMode": { - "$ref": "#/definitions/IsolationMode" + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" }, - "networkId": { - "type": "string", - "readOnly": true + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "expiryTime": { + "format": "date-time", + "type": "string" }, - "outboundRules": { + "metadata": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/OutboundRule" - }, - "x-nullable": true + "$ref": "#/definitions/IValue" + } }, - "status": { - "$ref": "#/definitions/ManagedNetworkProvisionStatus" + "target": { + "type": "string" } - } - }, - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "IsolationMode", - "modelAsString": true - } + }, + "discriminator": "authType" }, - "OutboundRuleBasicResource": { - "description": "Outbound Rule Basic Resource for the managed network of a machine learning workspace.", + "WorkspaceConnectionPropertiesV2BasicResource": { "required": [ "properties" ], @@ -2948,282 +3058,472 @@ ], "properties": { "properties": { - "$ref": "#/definitions/OutboundRule" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } - }, - "additionalProperties": false + } }, - "OutboundRuleListResult": { - "description": "List of outbound rules for the managed network of a machine learning workspace.", + "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { "type": "object", "properties": { + "nextLink": { + "type": "string" + }, "value": { - "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { - "$ref": "#/definitions/OutboundRuleBasicResource" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "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" - }, - "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 } }, - "FqdnOutboundRule": { - "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionServicePrincipal": { "type": "object", "allOf": [ { - "$ref": "#/definitions/OutboundRule" + "$ref": "#/definitions/Credentials" } ], "properties": { - "destination": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + }, + "tenantId": { "type": "string" } - }, - "x-ms-discriminator-value": "FQDN" + } }, - "PrivateEndpointOutboundRule": { - "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionSharedAccessSignature": { "type": "object", "allOf": [ { - "$ref": "#/definitions/OutboundRule" + "$ref": "#/definitions/Credentials" } ], "properties": { - "destination": { - "$ref": "#/definitions/PrivateEndpointDestination" + "sas": { + "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.", + "WorkspaceConnectionUpdateParameter": { "type": "object", "properties": { - "serviceResourceId": { - "type": "string" - }, - "subresourceTarget": { - "type": "string" - }, - "sparkEnabled": { - "type": "boolean" - }, - "sparkStatus": { - "$ref": "#/definitions/RuleStatus" + "properties": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } } }, - "ServiceTagOutboundRule": { - "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "WorkspaceConnectionUsernamePassword": { "type": "object", "allOf": [ { - "$ref": "#/definitions/OutboundRule" + "$ref": "#/definitions/Credentials" } ], "properties": { - "destination": { - "$ref": "#/definitions/ServiceTagDestination" + "password": { + "type": "string" + }, + "username": { + "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.", + "WorkspaceHubConfig": { "type": "object", "properties": { - "serviceTag": { - "type": "string" - }, - "protocol": { - "type": "string" + "additionalWorkspaceStorageAccounts": { + "type": "array", + "items": { + "type": "string" + } }, - "portRanges": { + "defaultWorkspaceResourceGroup": { "type": "string" } } }, - "WorkspaceConnectionPropertiesV2BasicResource": { - "required": [ - "properties" - ], + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], "properties": { - "properties": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } } - }, - "additionalProperties": false + } }, - "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { + "WorkspaceProperties": { + "description": "The properties of a machine learning workspace.", "type": "object", "properties": { - "value": { + "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": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "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" } }, - "nextLink": { + "managedNetwork": {}, + "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, - "type": "string" - } - }, - "additionalProperties": false - }, - "FQDNEndpointDetail": { - "type": "object", - "properties": { - "port": { - "format": "int32", - "type": "integer" - } - } - }, - "FQDNEndpoint": { - "type": "object", - "properties": { - "domainName": { + "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": {}, + "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": "Azure Machine Learning Workspace Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "WorkspaceForceToPurgeParameter": { + "in": "query", + "name": "forceToPurge", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "in": "path", + "name": "connectionName", + "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", + "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", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } } } From a01cbf9ce5bc3027cd6e60761ef445fc1511b115 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Wed, 7 Jun 2023 00:12:09 -0700 Subject: [PATCH 02/19] Fixing more issue --- .../2023-06-01-preview/workspaceRP.json | 6349 ++++++++--------- 1 file changed, 3174 insertions(+), 3175 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index c7cbfd55a40a..c7a2a0498ab8 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 @@ -24,3506 +24,3505 @@ ], "paths": { "/providers/Microsoft.MachineLearningServices/operations": { - "get": { - "tags": [ - "Operation" - ], - "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" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/AmlOperationListResult" - } - }, - "default": { - "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 + "get": { + "tags": [ + "Operation" + ], + "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" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/AmlOperationListResult" + } + }, + "default": { + "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}/providers/Microsoft.MachineLearningServices/workspaces": { - "get": { - "tags": [ - "Workspaces" - ], - "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/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WorkspaceKindParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "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" + "get": { + "tags": [ + "Workspaces" + ], + "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "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" + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { - "get": { - "tags": [ - "Workspaces" - ], - "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/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WorkspaceKindParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "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" + "get": { + "tags": [ + "Workspaces" + ], + "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "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" - ], - "summary": "Deletes a machine learning workspace.", - "operationId": "Workspaces_Delete", - "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": "query", - "name": "forceToPurge", - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "default": { - "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 - }, - "get": { - "tags": [ - "Workspaces" - ], - "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/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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Workspace": { - "$ref": "./examples/Workspace/get.json" - } - } - }, - "patch": { - "tags": [ - "Workspaces" - ], - "summary": "Updates a machine learning workspace with the specified parameters.", - "operationId": "Workspaces_Update", - "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", - "schema": { - "$ref": "#/definitions/WorkspaceUpdateParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update Workspace": { - "$ref": "./examples/Workspace/update.json" - } - }, - "x-ms-long-running-operation": true - }, - "put": { - "tags": [ - "Workspaces" - ], - "summary": "Creates or updates a workspace with the specified parameters.", - "operationId": "Workspaces_CreateOrUpdate", - "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", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "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" + "delete": { + "tags": [ + "Workspaces" + ], + "summary": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "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": "query", + "name": "forceToPurge", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "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 + }, + "get": { + "tags": [ + "Workspaces" + ], + "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/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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "summary": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "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", + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "summary": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "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", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "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": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "x-ms-examples": { - "Create Workspace": { - "$ref": "./examples/Workspace/create.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { - "get": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_List", - "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": "#/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/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" - } - }, - "default": { - "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" + "get": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_List", + "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": "#/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/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "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}/connections/{connectionName}": { - "delete": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Delete", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "DeleteWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/delete.json" - } - } - }, - "get": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Get", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/get.json" - } - } - }, - "patch": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Update", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "UpdateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/update.json" - } - } - }, - "put": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Create", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" - } + "delete": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Delete", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Get", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } + } + }, + "patch": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Update", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" + } + } + }, + "put": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Create", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { - "post": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_ListSecrets", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/listSecrets.json" - } + "post": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_ListSecrets", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Diagnose workspace setup issue.", - "operationId": "Workspaces_Diagnose", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/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": "The parameter of diagnosing workspace health", - "schema": { - "$ref": "#/definitions/DiagnoseWorkspaceParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/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": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/DiagnoseResponseResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "x-ms-examples": { - "Diagnose Workspace": { - "$ref": "./examples/Workspace/diagnose.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { - "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" - }, - { - "$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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ListWorkspaceKeysResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listKeys.json" - } + "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" + }, + { + "$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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "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}/listNotebookAccessToken": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Get Azure Machine Learning Workspace notebook access token", - "operationId": "Workspaces_ListNotebookAccessToken", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/NotebookAccessTokenResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listNotebookAccessToken.json" - } + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } + }, + "default": { + "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}/listNotebookKeys": { - "post": { - "tags": [ - "ProxyOperations" - ], - "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/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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ListNotebookKeysResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Notebook/listKeys.json" - } + "post": { + "tags": [ + "ProxyOperations" + ], + "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/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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListNotebookKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", - "operationId": "Workspaces_ListStorageAccountKeys", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ListStorageAccountKeysResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.json" - } + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", + "operationId": "Workspaces_ListStorageAccountKeys", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListStorageAccountKeysResult" + } + }, + "default": { + "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}/outboundNetworkDependenciesEndpoints": { - "get": { - "tags": [ - "OutboundNetworkDependenciesEndpoints" - ], - "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "outboundNetworkDependenciesEndpoints", - "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", - "schema": { - "$ref": "#/definitions/ExternalFQDNResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ListOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ExternalFQDN/get.json" - } + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "outboundNetworkDependenciesEndpoints", + "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", + "schema": { + "$ref": "#/definitions/ExternalFQDNResponse" + } + }, + "default": { + "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}/outboundRules": { - "get": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_List", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "get": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_List", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { - "get": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_Get", - "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": "#/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" - } - } - }, - "x-ms-examples": { - "Get ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/getRule.json" - } - } - }, - "put": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", - "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": "#/parameters/RuleName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "get": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Get", + "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": "#/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" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "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": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "x-ms-examples": { - "CreateOrUpdate ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/createOrUpdateRule.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}/prepareNotebook": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Prepare Azure Machine Learning Workspace's notebook resource", - "operationId": "Workspaces_PrepareNotebook", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/NotebookResourceInfo" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", + "operationId": "Workspaces_PrepareNotebook", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "x-ms-examples": { - "Prepare Notebook": { - "$ref": "./examples/Notebook/prepare.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { - "get": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to get all PE connections.", - "operationId": "PrivateEndpointConnections_List", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "StorageAccountListPrivateEndpointConnections": { - "$ref": "./examples/PrivateEndpointConnection/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get all PE connections.", + "operationId": "PrivateEndpointConnections_List", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "delete": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to delete a PE connection.", - "operationId": "PrivateEndpointConnections_Delete", - "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": "#/parameters/PrivateEndpointConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/delete.json" - } - } - }, - "get": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to get a PE connection.", - "operationId": "PrivateEndpointConnections_Get", - "produces": [ - "application/json" - ], - "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/PrivateEndpointConnectionName" - }, - { - "$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/PrivateEndpointConnection" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspaceGetPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/get.json" - } - } - }, - "put": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", - "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "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/PrivateEndpointConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "PrivateEndpointConnection object", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" - } + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to delete a PE connection.", + "operationId": "PrivateEndpointConnections_Delete", + "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": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get a PE connection.", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "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/PrivateEndpointConnectionName" + }, + { + "$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/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "PrivateEndpointConnection object", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$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}/privateLinkResources": { - "get": { - "tags": [ - "WorkspacePrivateLinkResources" - ], - "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", - "operationId": "PrivateLinkResources_List", - "produces": [ - "application/json" - ], - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/PrivateLinkResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspaceListPrivateLinkResources": { - "$ref": "./examples/PrivateLinkResource/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", + "operationId": "PrivateLinkResources_List", + "produces": [ + "application/json" + ], + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": { - "post": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkProvisions_Post", - "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", - "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" + "post": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkProvisions_Post", + "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", + "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" } - } - }, - "x-ms-examples": { - "Provision ManagedNetwork": { - "$ref": "./examples/ManagedNetwork/provision.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } - } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { - "post": { - "tags": [ - "ProxyOperations" - ], - "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" + "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" } - } - }, - "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": { +}, +"definitions": { "AccessKeyAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionAccessKey" - } - }, - "x-ms-discriminator-value": "AccessKey" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" }, "AmlOperation": { - "description": "Azure Machine Learning team account REST API operation", - "type": "object", - "properties": { - "display": { - "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" + "description": "Azure Machine Learning team account REST API operation", + "type": "object", + "properties": { + "display": { + "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" + } } - } }, "AmlOperationListResult": { - "type": "object", - "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" - ] - } - } + "type": "object", + "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" + ] + } + } }, "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", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionApiKey" - } - }, - "x-ms-discriminator-value": "ApiKey" + "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", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" }, "ComputeRuntimeDto": { - "type": "object", - "properties": { - "sparkRuntimeVersion": { - "type": "string" + "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 - } + "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" + "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 } - } }, - "Credentials": { - "type": "object" + "CosmosDbSettings": { + "type": "object", + "properties": { + "collectionsThroughput": { + "format": "int32", + "type": "integer" + } + } + }, + "Credentials": { + "type": "object" }, "CustomKeys": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "keys": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } - } }, "CustomKeysWorkspaceConnectionProperties": { - "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/CustomKeys" - } - }, - "x-ms-discriminator-value": "CustomKeys" + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" }, "DiagnoseRequestProperties": { - "type": "object", - "properties": { - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", - "type": "object", - "additionalProperties": {} - }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", - "type": "object", - "additionalProperties": {} - }, - "dnsResolution": { - "description": "Setting for diagnosing dns resolution", - "type": "object", - "additionalProperties": {} - }, - "keyVault": { - "description": "Setting for diagnosing dependent key vault", - "type": "object", - "additionalProperties": {} - }, - "nsg": { - "description": "Setting for diagnosing network security group", - "type": "object", - "additionalProperties": {} - }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", - "type": "object", - "additionalProperties": {} - }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", - "type": "object", - "additionalProperties": {} - }, - "storageAccount": { - "description": "Setting for diagnosing dependent storage account", - "type": "object", - "additionalProperties": {} - }, - "udr": { - "description": "Setting for diagnosing user defined routing", - "type": "object", - "additionalProperties": {} + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": {} + }, + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": {} + }, + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": {} + }, + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": {} + }, + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": {} + }, + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": {} + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} + }, + "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" - ] - } - } - } - } + "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", - "properties": { - "code": { - "description": "Code for workspace setup error", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "level": { - "description": "Level of workspace setup error", - "$ref": "#/definitions/DiagnoseResultLevel", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "message": { - "description": "Message of workspace setup error", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "object", + "properties": { + "code": { + "description": "Code for workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "level": { + "description": "Level of workspace setup error", + "$ref": "#/definitions/DiagnoseResultLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "message": { + "description": "Message of workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } } - } }, "DiagnoseResultLevel": { - "enum": [ - "Warning", - "Error", - "Information" - ], - "type": "string", - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } }, "DiagnoseWorkspaceParameters": { - "description": "Parameters to diagnose a workspace", - "type": "object", - "properties": { - "value": { - "$ref": "#/definitions/DiagnoseRequestProperties" + "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" - } - } + "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" - }, - "identity": { - "description": "Identity to be used with the keyVault", - "$ref": "#/definitions/IdentityForCmk" - }, - "keyVaultProperties": { - "description": "KeyVault details to do the encryption", - "$ref": "#/definitions/KeyVaultProperties" - }, - "searchAccountResourceId": { - "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", - "type": "string" - }, - "status": { - "$ref": "#/definitions/EncryptionStatus" - }, - "storageAccountResourceId": { - "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", - "type": "string" + "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" + }, + "identity": { + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" + }, + "keyVaultProperties": { + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" + }, + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "status": { + "$ref": "#/definitions/EncryptionStatus" + }, + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + } } - } }, "EncryptionStatus": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "EncryptionStatus", - "modelAsString": true - } + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } }, "EncryptionUpdateProperties": { - "required": [ - "keyVaultProperties" - ], - "type": "object", - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + "required": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } } - } }, "ExternalFQDNResponse": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FQDNEndpointsPropertyBag" - }, - "x-ms-identifiers": [ - "/properties/category" - ] - } - } + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointsPropertyBag" + }, + "x-ms-identifiers": [ + "/properties/category" + ] + } + } }, "FQDNEndpoint": { - "type": "object", - "properties": { - "domainName": { - "type": "string" - }, - "endpointDetails": { - "type": "array", - "items": { - "$ref": "#/definitions/FQDNEndpointDetail" - }, - "x-ms-identifiers": [ - "port" - ] + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "endpointDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointDetail" + }, + "x-ms-identifiers": [ + "port" + ] + } } - } }, "FQDNEndpointDetail": { - "type": "object", - "properties": { - "port": { - "format": "int32", - "type": "integer" + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" + } } - } }, "FQDNEndpoints": { - "type": "object", - "properties": { - "category": { - "type": "string" - }, - "endpoints": { - "type": "array", - "items": { - "$ref": "#/definitions/FQDNEndpoint" - }, - "x-ms-identifiers": [ - "domainName" - ] + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + }, + "x-ms-identifiers": [ + "domainName" + ] + } } - } }, "FQDNEndpointsPropertyBag": { - "type": "object", - "properties": { + "type": "object", "properties": { - "$ref": "#/definitions/FQDNEndpoints" + "properties": { + "$ref": "#/definitions/FQDNEndpoints" + } } - } }, "FeatureStoreSettings": { - "type": "object", - "properties": { - "computeRuntime": { - "$ref": "#/definitions/ComputeRuntimeDto" - }, - "offlineStoreConnectionName": { - "type": "string" - }, - "onlineStoreConnectionName": { - "type": "string" + "type": "object", + "properties": { + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" + }, + "offlineStoreConnectionName": { + "type": "string" + }, + "onlineStoreConnectionName": { + "type": "string" + } } - } }, "FqdnOutboundRule": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], - "properties": { - "destination": { - "type": "string" - } - }, - "x-ms-discriminator-value": "FQDN" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" }, "IValue": { - "type": "object" + "type": "object" }, "IdentityForCmk": { - "type": "object", - "properties": { - "userAssignedIdentity": { - "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", - "type": "string" + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", + "type": "string" + } } - } }, "KeyVaultProperties": { - "required": [ - "keyIdentifier", - "keyVaultArmId" - ], - "type": "object", - "properties": { - "identityClientId": { - "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", - "type": "string" - }, - "keyIdentifier": { - "description": "KeyVault key identifier to encrypt the data", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, - "keyVaultArmId": { - "description": "KeyVault Arm Id that contains the data encryption key", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object", + "properties": { + "identityClientId": { + "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", + "type": "string" + }, + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } } - } }, "ListNotebookKeysResult": { - "type": "object", - "properties": { - "primaryAccessKey": { - "description": "The primary access key of the Notebook", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "secondaryAccessKey": { - "description": "The secondary access key of the Notebook", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "type": "object", + "properties": { + "primaryAccessKey": { + "description": "The primary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "secondaryAccessKey": { + "description": "The secondary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } } - } }, "ListStorageAccountKeysResult": { - "type": "object", - "properties": { - "userStorageKey": { - "description": "The access key of the storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - } - } + "type": "object", + "properties": { + "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 - }, - "containerRegistryCredentials": { - "$ref": "#/definitions/RegistryListCredentialsResult" - }, - "notebookAccessKeys": { - "$ref": "#/definitions/ListNotebookKeysResult" - }, - "userStorageArmId": { - "description": "The arm Id key of the workspace storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "userStorageKey": { - "description": "The access key of the workspace storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "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 + }, + "containerRegistryCredentials": { + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/ListNotebookKeysResult" + }, + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "userStorageKey": { + "description": "The access key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } } - } }, "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" - } - }, - "x-ms-discriminator-value": "ManagedIdentity" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedNetworkProvisionOptions": { - "type": "object", - "properties": { - "includeSpark": { - "type": "boolean" + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" + } } - } }, "ManagedNetworkProvisionStatus": { - "type": "object", - "properties": { - "sparkReady": { - "type": "boolean" - }, - "status": { - "$ref": "#/definitions/ManagedNetworkStatus" + "type": "object", + "properties": { + "sparkReady": { + "type": "boolean" + }, + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" + } } - } }, "ManagedNetworkStatus": { - "enum": [ - "Inactive", - "Active" - ], - "type": "string", - "x-ms-enum": { - "name": "ManagedNetworkStatus", - "modelAsString": true - } + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } }, "NoneAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "x-ms-discriminator-value": "None" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" }, "NotebookAccessTokenResult": { - "type": "object", - "properties": { - "accessToken": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "expiresIn": { - "format": "int32", - "type": "integer", - "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-mutability": [ - "read" - ] - }, - "tokenType": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "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-mutability": [ + "read" + ] + }, + "tokenType": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } } - } }, "NotebookPreparationError": { - "type": "object", - "properties": { - "errorMessage": { - "type": "string" - }, - "statusCode": { - "format": "int32", - "type": "integer" + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } } - } }, "NotebookResourceInfo": { - "type": "object", - "properties": { - "fqdn": { - "type": "string" - }, - "isPrivateLinkEnabled": { - "type": "boolean" - }, - "notebookPreparationError": { - "description": "The error that occurs when preparing notebook.", - "$ref": "#/definitions/NotebookPreparationError" - }, - "resourceId": { - "description": "the data plane resourceId that used to initialize notebook component", - "type": "string" + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "isPrivateLinkEnabled": { + "type": "boolean" + }, + "notebookPreparationError": { + "description": "The error that occurs when preparing notebook.", + "$ref": "#/definitions/NotebookPreparationError" + }, + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" + } } - } }, "OperationDisplay": { - "description": "Display name of operation", - "type": "object", - "properties": { - "description": { - "description": "Gets or sets the description for the operation.", - "type": "string" - }, - "operation": { - "description": "Gets or sets the operation that users can perform.", - "type": "string" - }, - "provider": { - "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", - "type": "string" - }, - "resource": { - "description": "Gets or sets the resource on which the operation is performed.", - "type": "string" + "description": "Display name of operation", + "type": "object", + "properties": { + "description": { + "description": "Gets or sets the description for the operation.", + "type": "string" + }, + "operation": { + "description": "Gets or sets the operation that users can perform.", + "type": "string" + }, + "provider": { + "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "Gets or sets the resource on which the operation is performed.", + "type": "string" + } } - } }, "OutboundRule": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "category": { - "$ref": "#/definitions/RuleCategory" - }, - "status": { - "$ref": "#/definitions/RuleStatus" + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory" + }, + "status": { + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "$ref": "#/definitions/RuleType" + } }, - "type": { - "$ref": "#/definitions/RuleType" - } - }, - "discriminator": "type" + "discriminator": "type" }, "OutboundRuleBasicResource": { - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], - "properties": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "properties": { - "$ref": "#/definitions/OutboundRule" + "properties": { + "$ref": "#/definitions/OutboundRule" + } } - } }, "OutboundRuleListResult": { - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", - "type": "array", - "items": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } } - } }, "PATAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" - } - }, - "x-ms-discriminator-value": "PAT" + "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, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "value": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "value": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } } - } }, "PrivateEndpointConnection": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], - "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "location": { - "description": "Same as workspace location.", - "type": "string" - }, + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "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": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "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": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } - } }, "PrivateEndpointConnectionListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } } - } }, "PrivateEndpointConnectionProperties": { - "description": "Private endpoint connection properties.", - "type": "object", - "properties": { - "privateEndpoint": { - "description": "The PE network resource that is linked to this PE connection.", - "$ref": "#/definitions/WorkspacePrivateEndpointResource" - }, - "privateLinkServiceConnectionState": { - "description": "The connection state.", - "$ref": "#/definitions/PrivateLinkServiceConnectionState" - }, - "provisioningState": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "description": "Private endpoint connection properties.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/WorkspacePrivateEndpointResource" + }, + "privateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } } - } }, "PrivateEndpointDestination": { - "type": "object", - "properties": { - "serviceResourceId": { - "type": "string" - }, - "sparkEnabled": { - "type": "boolean" - }, - "sparkStatus": { - "$ref": "#/definitions/RuleStatus" - }, - "subresourceTarget": { - "type": "string" - } - } - }, - "PrivateEndpointOutboundRule": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], - "properties": { - "destination": { - "$ref": "#/definitions/PrivateEndpointDestination" + "type": "object", + "properties": { + "serviceResourceId": { + "type": "string" + }, + "sparkEnabled": { + "type": "boolean" + }, + "sparkStatus": { + "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" + } } - }, - "x-ms-discriminator-value": "PrivateEndpoint" }, - "WorkspacePrivateEndpointResource": { - "type": "object", - "properties": { - "id": { - "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "PrivateEndpointOutboundRule": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/PrivateEndpointDestination" + } }, - "subnetArmId": { - "description": "The subnetId that the private endpoint is connected to.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } - } + "x-ms-discriminator-value": "PrivateEndpoint" }, "PrivateEndpointServiceConnectionStatus": { - "description": "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)", - "enum": [ - "Approved", - "Pending", - "Rejected", - "Disconnected", - "Timeout" - ], - "type": "string", - "x-ms-enum": { - "name": "EndpointServiceConnectionStatus", - "modelAsString": true - } + "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 + } }, "PrivateLinkResource": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], - "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "location": { - "description": "Same as workspace location.", - "type": "string" - }, + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "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" - } + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "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" + } + } } - } }, "PrivateLinkResourceListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } } - } }, "PrivateLinkResourceProperties": { - "type": "object", - "properties": { - "groupId": { - "description": "The private link resource group id.", - "type": "string" - }, - "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" - } + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "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" + } + } } - } }, "PrivateLinkServiceConnectionState": { - "type": "object", - "properties": { - "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" + "type": "object", + "properties": { + "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" + } } - } }, "ProvisioningState": { - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } }, "PublicNetworkAccessType": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccessType", - "modelAsString": true - } + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true + } }, "RegistryListCredentialsResult": { - "type": "object", - "properties": { - "location": { - "description": "The location of the workspace ACR", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "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" - ] + "type": "object", + "properties": { + "location": { + "description": "The location of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "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" + ] + } } - } }, "RuleAction": { - "enum": [ - "Allow", - "Deny" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleAction", - "modelAsString": true - } + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } }, "RuleCategory": { - "enum": [ - "Required", - "Recommended", - "UserDefined" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleCategory", - "modelAsString": true - } + "enum": [ + "Required", + "Recommended", + "UserDefined" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } }, "RuleStatus": { - "enum": [ - "Inactive", - "Active" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleStatus", - "modelAsString": true - } + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } }, "RuleType": { - "enum": [ - "FQDN", - "PrivateEndpoint", - "ServiceTag" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleType", - "modelAsString": true - } + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } }, "SASAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" - } - }, - "x-ms-discriminator-value": "SAS" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "SAS" }, "ServiceManagedResourcesSettings": { - "type": "object", - "properties": { - "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings" + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings" + } } - } }, "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" - } - }, - "x-ms-discriminator-value": "ServicePrincipal" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" }, "ServiceTagDestination": { - "type": "object", - "properties": { - "action": { - "$ref": "#/definitions/RuleAction" - }, - "addressPrefixes": { - "description": "Optional, if provided, the ServiceTag property will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "portRanges": { - "type": "string" - }, - "protocol": { - "type": "string" - }, - "serviceTag": { - "type": "string" + "type": "object", + "properties": { + "action": { + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "serviceTag": { + "type": "string" + } } - } }, "ServiceTagOutboundRule": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], - "properties": { - "destination": { - "$ref": "#/definitions/ServiceTagDestination" - } - }, - "x-ms-discriminator-value": "ServiceTag" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/ServiceTagDestination" + } + }, + "x-ms-discriminator-value": "ServiceTag" }, "SharedPrivateLinkResource": { - "type": "object", - "properties": { - "name": { - "description": "Unique name of the private link", - "type": "string" - }, + "type": "object", "properties": { - "$ref": "#/definitions/SharedPrivateLinkResourceProperty", - "x-ms-client-flatten": true + "name": { + "description": "Unique name of the private link", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true + } } - } }, "SharedPrivateLinkResourceProperty": { - "type": "object", - "properties": { - "groupId": { - "description": "group id of the private link", - "type": "string" - }, - "privateLinkResourceId": { - "description": "the resource id that private link links to", - "type": "string" - }, - "requestMessage": { - "description": "Request message", - "type": "string" - }, - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "type": "object", + "properties": { + "groupId": { + "description": "group id of the private link", + "type": "string" + }, + "privateLinkResourceId": { + "description": "the resource id that private link links to", + "type": "string" + }, + "requestMessage": { + "description": "Request message", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } } - } }, "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" - } - }, - "x-ms-discriminator-value": "UsernamePassword" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + } + }, + "x-ms-discriminator-value": "UsernamePassword" }, "Workspace": { - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], - "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "type": "string" - }, - "location": { - "type": "string" - }, + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "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" - } + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "type": "string" + }, + "location": { + "type": "string" + }, + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/WorkspaceProperties", + "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" + } + } } - } }, "WorkspaceConnectionAccessKey": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "accessKeyId": { - "type": "string" - }, - "secretAccessKey": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + } } - } }, "WorkspaceConnectionApiKey": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "key": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "key": { + "type": "string" + } } - } }, "WorkspaceConnectionManagedIdentity": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "clientId": { - "type": "string" - }, - "resourceId": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" + } } - } }, "WorkspaceConnectionPersonalAccessToken": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "pat": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "pat": { + "type": "string" + } } - } }, "WorkspaceConnectionPropertiesV2": { - "required": [ - "authType" - ], - "type": "object", - "properties": { - "authType": { - "description": "Authentication type of the connection target", - "$ref": "#/definitions/ConnectionAuthType" - }, - "category": { - "description": "Category of the connection", - "$ref": "#/definitions/ConnectionCategory" - }, - "expiryTime": { - "format": "date-time", - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/IValue" - } + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" + }, + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/IValue" + } + }, + "target": { + "type": "string" + } }, - "target": { - "type": "string" - } - }, - "discriminator": "authType" + "discriminator": "authType" }, "WorkspaceConnectionPropertiesV2BasicResource": { - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], - "properties": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "properties": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "properties": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } } - } }, "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { - "type": "object", - "properties": { - "nextLink": { - "type": "string" - }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } } - } }, "WorkspaceConnectionServicePrincipal": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "clientId": { - "type": "string" - }, - "clientSecret": { - "type": "string" - }, - "tenantId": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + }, + "tenantId": { + "type": "string" + } } - } }, "WorkspaceConnectionSharedAccessSignature": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "sas": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "sas": { + "type": "string" + } } - } }, "WorkspaceConnectionUpdateParameter": { - "type": "object", - "properties": { + "type": "object", "properties": { - "description": "The properties that the machine learning workspace connection will be updated with.", - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + "properties": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } } - } }, "WorkspaceConnectionUsernamePassword": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "password": { - "type": "string" - }, - "username": { - "type": "string" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "password": { + "type": "string" + }, + "username": { + "type": "string" + } } - } }, "WorkspaceHubConfig": { - "type": "object", - "properties": { - "additionalWorkspaceStorageAccounts": { - "type": "array", - "items": { - "type": "string" - } - }, - "defaultWorkspaceResourceGroup": { - "type": "string" + "type": "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": { - "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" - } + "description": "The result of a request to list machine learning workspaces.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "WorkspacePrivateEndpointResource": { + "type": "object", + "properties": { + "id": { + "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } } - } }, "WorkspaceProperties": { - "description": "The properties of a machine learning workspace.", - "type": "object", - "properties": { - "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": {}, - "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" - }, - "privateEndpointConnections": { - "description": "The list of private endpoint connections in the workspace.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-identifiers": [ - "name" - ] - }, - "privateLinkCount": { - "format": "int32", - "description": "Count of private connections in the workspace", - "type": "integer", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "provisioningState": { - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", - "$ref": "#/definitions/ProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "publicNetworkAccess": { - "description": "Whether requests from Public Network are allowed.", - "$ref": "#/definitions/PublicNetworkAccessType" - }, - "serviceManagedResourcesSettings": { - "description": "The service managed resource settings.", - "$ref": "#/definitions/ServiceManagedResourcesSettings" - }, - "serviceProvisionedResourceGroup": { - "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "sharedPrivateLinkResources": { - "description": "The list of shared private link resources in this workspace.", - "type": "array", - "items": { - "$ref": "#/definitions/SharedPrivateLinkResource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "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": { - "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" - ] + "description": "The properties of a machine learning workspace.", + "type": "object", + "properties": { + "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": {}, + "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" + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections in the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-identifiers": [ + "name" + ] + }, + "privateLinkCount": { + "format": "int32", + "description": "Count of private connections in the workspace", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "serviceProvisionedResourceGroup": { + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources in this workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "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": { + "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" + ] + } } - } }, "WorkspacePropertiesUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", - "type": "object", - "properties": { - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string" - }, - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "enableDataIsolation": { - "type": "boolean" - }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties" - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" - }, - "imageBuildCompute": { - "description": "The compute name for image build", - "type": "string" - }, - "managedNetwork": {}, - "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" + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "managedNetwork": {}, + "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" + } } - } }, "WorkspaceUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", - "type": "object", - "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, + "description": "The parameters for updating a machine learning workspace.", + "type": "object", "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" - } - } - } + "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": { +}, +"parameters": { "WorkspaceKindParameter": { - "in": "query", - "name": "kind", - "description": "Kind of workspace.", - "type": "string", - "x-ms-parameter-location": "method" + "in": "query", + "name": "kind", + "description": "Kind of workspace.", + "type": "string", + "x-ms-parameter-location": "method" }, "WorkspaceNameParameter": { - "in": "path", - "name": "workspaceName", - "description": "Azure Machine Learning Workspace Name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "in": "path", + "name": "workspaceName", + "description": "Azure Machine Learning Workspace Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, "WorkspaceForceToPurgeParameter": { - "in": "query", - "name": "forceToPurge", - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "in": "query", + "name": "forceToPurge", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" }, "TargetParameter": { - "in": "query", - "name": "target", - "type": "string", - "x-ms-parameter-location": "method" + "in": "query", + "name": "target", + "type": "string", + "x-ms-parameter-location": "method" }, "CategoryParameter": { - "in": "query", - "name": "category", - "type": "string", - "x-ms-parameter-location": "method" + "in": "query", + "name": "category", + "type": "string", + "x-ms-parameter-location": "method" }, "ConnectionName": { - "in": "path", - "name": "connectionName", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "in": "path", + "name": "connectionName", + "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", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "in": "path", + "name": "ruleName", + "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" + "in": "path", + "name": "privateEndpointConnectionName", + "description": "NRP Private Endpoint Connection Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } - }, - "securityDefinitions": { +}, +"securityDefinitions": { "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } } - } +} } From 35721f0d382bb91cb1efd0ca6146643b8f7f58e6 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Wed, 7 Jun 2023 00:14:18 -0700 Subject: [PATCH 03/19] revert custom-words --- custom-words.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 41a4f5a38ea4..e460d7f7ad01 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1659,7 +1659,6 @@ preloading prem premieraddonoffers premieraddons -preparenotebook Preprovisioned Preprovisioning prerestore @@ -1839,7 +1838,6 @@ restrant restype resumable resync -resynckeys resynchronization Resynchronize retaineddata From a1075db5a511407a07f2043c65d2fcb1c739dd11 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Wed, 7 Jun 2023 00:19:21 -0700 Subject: [PATCH 04/19] run prettier --- .../2023-06-01-preview/workspaceRP.json | 6336 ++++++++--------- 1 file changed, 3168 insertions(+), 3168 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index c7a2a0498ab8..f124dbcd1381 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 @@ -24,3505 +24,3505 @@ ], "paths": { "/providers/Microsoft.MachineLearningServices/operations": { - "get": { - "tags": [ - "Operation" - ], - "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" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/AmlOperationListResult" - } - }, - "default": { - "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 - } + "get": { + "tags": [ + "Operation" + ], + "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" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/AmlOperationListResult" + } + }, + "default": { + "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}/providers/Microsoft.MachineLearningServices/workspaces": { - "get": { - "tags": [ - "Workspaces" - ], - "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/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WorkspaceKindParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "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" - } + "get": { + "tags": [ + "Workspaces" + ], + "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "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" } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { - "get": { - "tags": [ - "Workspaces" - ], - "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/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WorkspaceKindParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "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" - } + "get": { + "tags": [ + "Workspaces" + ], + "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "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" - ], - "summary": "Deletes a machine learning workspace.", - "operationId": "Workspaces_Delete", - "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": "query", - "name": "forceToPurge", - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "default": { - "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 - }, - "get": { - "tags": [ - "Workspaces" - ], - "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/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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Workspace": { - "$ref": "./examples/Workspace/get.json" - } - } - }, - "patch": { - "tags": [ - "Workspaces" - ], - "summary": "Updates a machine learning workspace with the specified parameters.", - "operationId": "Workspaces_Update", - "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", - "schema": { - "$ref": "#/definitions/WorkspaceUpdateParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update Workspace": { - "$ref": "./examples/Workspace/update.json" - } - }, - "x-ms-long-running-operation": true - }, - "put": { - "tags": [ - "Workspaces" - ], - "summary": "Creates or updates a workspace with the specified parameters.", - "operationId": "Workspaces_CreateOrUpdate", - "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", - "required": true, - "schema": { - "$ref": "#/definitions/Workspace" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "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": { - "Create Workspace": { - "$ref": "./examples/Workspace/create.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "delete": { + "tags": [ + "Workspaces" + ], + "summary": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "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": "query", + "name": "forceToPurge", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "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 + }, + "get": { + "tags": [ + "Workspaces" + ], + "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/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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "summary": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "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", + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "summary": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "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", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "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": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { - "get": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_List", - "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": "#/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/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" - } - }, - "default": { - "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" - } + "get": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_List", + "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": "#/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/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "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}/connections/{connectionName}": { - "delete": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Delete", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "DeleteWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/delete.json" - } - } - }, - "get": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Get", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/get.json" - } - } - }, - "patch": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Update", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "UpdateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/update.json" - } - } - }, - "put": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Create", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" - } - } + "delete": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Delete", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Get", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } + } + }, + "patch": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Update", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" + } + } + }, + "put": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Create", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { - "post": { - "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_ListSecrets", - "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": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/listSecrets.json" - } - } + "post": { + "tags": [ + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_ListSecrets", + "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": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Diagnose workspace setup issue.", - "operationId": "Workspaces_Diagnose", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/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": "The parameter of diagnosing workspace health", - "schema": { - "$ref": "#/definitions/DiagnoseWorkspaceParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Diagnose Workspace": { - "$ref": "./examples/Workspace/diagnose.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/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": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/DiagnoseResponseResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { - "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" - }, - { - "$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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ListWorkspaceKeysResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listKeys.json" - } - } + "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" + }, + { + "$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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "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}/listNotebookAccessToken": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Get Azure Machine Learning Workspace notebook access token", - "operationId": "Workspaces_ListNotebookAccessToken", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/NotebookAccessTokenResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listNotebookAccessToken.json" - } - } + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } + }, + "default": { + "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}/listNotebookKeys": { - "post": { - "tags": [ - "ProxyOperations" - ], - "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/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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ListNotebookKeysResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Notebook/listKeys.json" - } - } + "post": { + "tags": [ + "ProxyOperations" + ], + "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/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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListNotebookKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", - "operationId": "Workspaces_ListStorageAccountKeys", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/ListStorageAccountKeysResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.json" - } - } + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", + "operationId": "Workspaces_ListStorageAccountKeys", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListStorageAccountKeysResult" + } + }, + "default": { + "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}/outboundNetworkDependenciesEndpoints": { - "get": { - "tags": [ - "OutboundNetworkDependenciesEndpoints" - ], - "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "outboundNetworkDependenciesEndpoints", - "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", - "schema": { - "$ref": "#/definitions/ExternalFQDNResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ListOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ExternalFQDN/get.json" - } - } + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "outboundNetworkDependenciesEndpoints", + "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", + "schema": { + "$ref": "#/definitions/ExternalFQDNResponse" + } + }, + "default": { + "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}/outboundRules": { - "get": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_List", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "get": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_List", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { - "get": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_Get", - "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": "#/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" - } - } - }, - "x-ms-examples": { - "Get ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/getRule.json" - } - } - }, - "put": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", - "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": "#/parameters/RuleName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "required": true, - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CreateOrUpdate ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/createOrUpdateRule.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "get": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Get", + "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": "#/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" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "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": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.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}/prepareNotebook": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Prepare Azure Machine Learning Workspace's notebook resource", - "operationId": "Workspaces_PrepareNotebook", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/NotebookResourceInfo" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Prepare Notebook": { - "$ref": "./examples/Notebook/prepare.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", + "operationId": "Workspaces_PrepareNotebook", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { - "get": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to get all PE connections.", - "operationId": "PrivateEndpointConnections_List", - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnectionListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "StorageAccountListPrivateEndpointConnections": { - "$ref": "./examples/PrivateEndpointConnection/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - } + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get all PE connections.", + "operationId": "PrivateEndpointConnections_List", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "delete": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to delete a PE connection.", - "operationId": "PrivateEndpointConnections_Delete", - "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": "#/parameters/PrivateEndpointConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/delete.json" - } - } - }, - "get": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to get a PE connection.", - "operationId": "PrivateEndpointConnections_Get", - "produces": [ - "application/json" - ], - "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/PrivateEndpointConnectionName" - }, - { - "$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/PrivateEndpointConnection" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspaceGetPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/get.json" - } - } - }, - "put": { - "tags": [ - "WorkspacePrivateEndpointConnections" - ], - "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", - "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "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/PrivateEndpointConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "PrivateEndpointConnection object", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" - } - } + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to delete a PE connection.", + "operationId": "PrivateEndpointConnections_Delete", + "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": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get a PE connection.", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "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/PrivateEndpointConnectionName" + }, + { + "$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/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "PrivateEndpointConnection object", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$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}/privateLinkResources": { - "get": { - "tags": [ - "WorkspacePrivateLinkResources" - ], - "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", - "operationId": "PrivateLinkResources_List", - "produces": [ - "application/json" - ], - "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": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/PrivateLinkResourceListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "WorkspaceListPrivateLinkResources": { - "$ref": "./examples/PrivateLinkResource/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - } + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", + "operationId": "PrivateLinkResources_List", + "produces": [ + "application/json" + ], + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": { - "post": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkProvisions_Post", - "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", - "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" + "post": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkProvisions_Post", + "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", + "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" } + } }, "/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" + "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": { + }, + "definitions": { "AccessKeyAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionAccessKey" - } - }, - "x-ms-discriminator-value": "AccessKey" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" }, "AmlOperation": { - "description": "Azure Machine Learning team account REST API operation", - "type": "object", - "properties": { - "display": { - "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" - } + "description": "Azure Machine Learning team account REST API operation", + "type": "object", + "properties": { + "display": { + "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" } + } }, "AmlOperationListResult": { - "type": "object", - "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" - ] - } - } + "type": "object", + "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" + ] + } + } }, "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", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionApiKey" - } - }, - "x-ms-discriminator-value": "ApiKey" + "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", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" }, "ComputeRuntimeDto": { - "type": "object", - "properties": { - "sparkRuntimeVersion": { - "type": "string" - } + "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 - } + "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 - } + "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" - } + "type": "object", + "properties": { + "collectionsThroughput": { + "format": "int32", + "type": "integer" } + } }, "Credentials": { - "type": "object" + "type": "object" }, "CustomKeys": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "keys": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } } + } }, "CustomKeysWorkspaceConnectionProperties": { - "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/CustomKeys" - } - }, - "x-ms-discriminator-value": "CustomKeys" + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" }, "DiagnoseRequestProperties": { - "type": "object", - "properties": { - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", - "type": "object", - "additionalProperties": {} - }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", - "type": "object", - "additionalProperties": {} - }, - "dnsResolution": { - "description": "Setting for diagnosing dns resolution", - "type": "object", - "additionalProperties": {} - }, - "keyVault": { - "description": "Setting for diagnosing dependent key vault", - "type": "object", - "additionalProperties": {} - }, - "nsg": { - "description": "Setting for diagnosing network security group", - "type": "object", - "additionalProperties": {} - }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", - "type": "object", - "additionalProperties": {} - }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", - "type": "object", - "additionalProperties": {} - }, - "storageAccount": { - "description": "Setting for diagnosing dependent storage account", - "type": "object", - "additionalProperties": {} - }, - "udr": { - "description": "Setting for diagnosing user defined routing", - "type": "object", - "additionalProperties": {} - } + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": {} + }, + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": {} + }, + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": {} + }, + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": {} + }, + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": {} + }, + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": {} + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} + }, + "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" - ] - } - } - } - } + "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", - "properties": { - "code": { - "description": "Code for workspace setup error", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "level": { - "description": "Level of workspace setup error", - "$ref": "#/definitions/DiagnoseResultLevel", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "message": { - "description": "Message of workspace setup error", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } + "type": "object", + "properties": { + "code": { + "description": "Code for workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "level": { + "description": "Level of workspace setup error", + "$ref": "#/definitions/DiagnoseResultLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "message": { + "description": "Message of workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } + } }, "DiagnoseResultLevel": { - "enum": [ - "Warning", - "Error", - "Information" - ], - "type": "string", - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } }, "DiagnoseWorkspaceParameters": { - "description": "Parameters to diagnose a workspace", - "type": "object", - "properties": { - "value": { - "$ref": "#/definitions/DiagnoseRequestProperties" - } + "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" - } - } + "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" - }, - "identity": { - "description": "Identity to be used with the keyVault", - "$ref": "#/definitions/IdentityForCmk" - }, - "keyVaultProperties": { - "description": "KeyVault details to do the encryption", - "$ref": "#/definitions/KeyVaultProperties" - }, - "searchAccountResourceId": { - "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", - "type": "string" - }, - "status": { - "$ref": "#/definitions/EncryptionStatus" - }, - "storageAccountResourceId": { - "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", - "type": "string" - } + "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" + }, + "identity": { + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" + }, + "keyVaultProperties": { + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" + }, + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "status": { + "$ref": "#/definitions/EncryptionStatus" + }, + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" } + } }, "EncryptionStatus": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "EncryptionStatus", - "modelAsString": true - } + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } }, "EncryptionUpdateProperties": { - "required": [ - "keyVaultProperties" - ], - "type": "object", - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" - } + "required": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" } + } }, "ExternalFQDNResponse": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FQDNEndpointsPropertyBag" - }, - "x-ms-identifiers": [ - "/properties/category" - ] - } - } + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointsPropertyBag" + }, + "x-ms-identifiers": [ + "/properties/category" + ] + } + } }, "FQDNEndpoint": { - "type": "object", - "properties": { - "domainName": { - "type": "string" - }, - "endpointDetails": { - "type": "array", - "items": { - "$ref": "#/definitions/FQDNEndpointDetail" - }, - "x-ms-identifiers": [ - "port" - ] - } + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "endpointDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointDetail" + }, + "x-ms-identifiers": [ + "port" + ] } + } }, "FQDNEndpointDetail": { - "type": "object", - "properties": { - "port": { - "format": "int32", - "type": "integer" - } + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" } + } }, "FQDNEndpoints": { - "type": "object", - "properties": { - "category": { - "type": "string" - }, - "endpoints": { - "type": "array", - "items": { - "$ref": "#/definitions/FQDNEndpoint" - }, - "x-ms-identifiers": [ - "domainName" - ] - } + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + }, + "x-ms-identifiers": [ + "domainName" + ] } + } }, "FQDNEndpointsPropertyBag": { - "type": "object", + "type": "object", + "properties": { "properties": { - "properties": { - "$ref": "#/definitions/FQDNEndpoints" - } + "$ref": "#/definitions/FQDNEndpoints" } + } }, "FeatureStoreSettings": { - "type": "object", - "properties": { - "computeRuntime": { - "$ref": "#/definitions/ComputeRuntimeDto" - }, - "offlineStoreConnectionName": { - "type": "string" - }, - "onlineStoreConnectionName": { - "type": "string" - } + "type": "object", + "properties": { + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" + }, + "offlineStoreConnectionName": { + "type": "string" + }, + "onlineStoreConnectionName": { + "type": "string" } + } }, "FqdnOutboundRule": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], - "properties": { - "destination": { - "type": "string" - } - }, - "x-ms-discriminator-value": "FQDN" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" }, "IValue": { - "type": "object" + "type": "object" }, "IdentityForCmk": { - "type": "object", - "properties": { - "userAssignedIdentity": { - "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", - "type": "string" - } + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", + "type": "string" } + } }, "KeyVaultProperties": { - "required": [ - "keyIdentifier", - "keyVaultArmId" - ], - "type": "object", - "properties": { - "identityClientId": { - "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", - "type": "string" - }, - "keyIdentifier": { - "description": "KeyVault key identifier to encrypt the data", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, - "keyVaultArmId": { - "description": "KeyVault Arm Id that contains the data encryption key", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - } + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object", + "properties": { + "identityClientId": { + "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", + "type": "string" + }, + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" } + } }, "ListNotebookKeysResult": { - "type": "object", - "properties": { - "primaryAccessKey": { - "description": "The primary access key of the Notebook", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "secondaryAccessKey": { - "description": "The secondary access key of the Notebook", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - } + "type": "object", + "properties": { + "primaryAccessKey": { + "description": "The primary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "secondaryAccessKey": { + "description": "The secondary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } + } }, "ListStorageAccountKeysResult": { - "type": "object", - "properties": { - "userStorageKey": { - "description": "The access key of the storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - } - } + "type": "object", + "properties": { + "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 - }, - "containerRegistryCredentials": { - "$ref": "#/definitions/RegistryListCredentialsResult" - }, - "notebookAccessKeys": { - "$ref": "#/definitions/ListNotebookKeysResult" - }, - "userStorageArmId": { - "description": "The arm Id key of the workspace storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "userStorageKey": { - "description": "The access key of the workspace storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - } + "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 + }, + "containerRegistryCredentials": { + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/ListNotebookKeysResult" + }, + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "userStorageKey": { + "description": "The access key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } + } }, "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" - } - }, - "x-ms-discriminator-value": "ManagedIdentity" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedNetworkProvisionOptions": { - "type": "object", - "properties": { - "includeSpark": { - "type": "boolean" - } + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" } + } }, "ManagedNetworkProvisionStatus": { - "type": "object", - "properties": { - "sparkReady": { - "type": "boolean" - }, - "status": { - "$ref": "#/definitions/ManagedNetworkStatus" - } + "type": "object", + "properties": { + "sparkReady": { + "type": "boolean" + }, + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" } + } }, "ManagedNetworkStatus": { - "enum": [ - "Inactive", - "Active" - ], - "type": "string", - "x-ms-enum": { - "name": "ManagedNetworkStatus", - "modelAsString": true - } + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } }, "NoneAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "x-ms-discriminator-value": "None" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" }, "NotebookAccessTokenResult": { - "type": "object", - "properties": { - "accessToken": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "expiresIn": { - "format": "int32", - "type": "integer", - "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-mutability": [ - "read" - ] - }, - "tokenType": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "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-mutability": [ + "read" + ] + }, + "tokenType": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } + } }, "NotebookPreparationError": { - "type": "object", - "properties": { - "errorMessage": { - "type": "string" - }, - "statusCode": { - "format": "int32", - "type": "integer" - } + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" } + } }, "NotebookResourceInfo": { - "type": "object", - "properties": { - "fqdn": { - "type": "string" - }, - "isPrivateLinkEnabled": { - "type": "boolean" - }, - "notebookPreparationError": { - "description": "The error that occurs when preparing notebook.", - "$ref": "#/definitions/NotebookPreparationError" - }, - "resourceId": { - "description": "the data plane resourceId that used to initialize notebook component", - "type": "string" - } + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "isPrivateLinkEnabled": { + "type": "boolean" + }, + "notebookPreparationError": { + "description": "The error that occurs when preparing notebook.", + "$ref": "#/definitions/NotebookPreparationError" + }, + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" } + } }, "OperationDisplay": { - "description": "Display name of operation", - "type": "object", - "properties": { - "description": { - "description": "Gets or sets the description for the operation.", - "type": "string" - }, - "operation": { - "description": "Gets or sets the operation that users can perform.", - "type": "string" - }, - "provider": { - "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", - "type": "string" - }, - "resource": { - "description": "Gets or sets the resource on which the operation is performed.", - "type": "string" - } + "description": "Display name of operation", + "type": "object", + "properties": { + "description": { + "description": "Gets or sets the description for the operation.", + "type": "string" + }, + "operation": { + "description": "Gets or sets the operation that users can perform.", + "type": "string" + }, + "provider": { + "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "Gets or sets the resource on which the operation is performed.", + "type": "string" } + } }, "OutboundRule": { - "required": [ - "type" - ], - "type": "object", - "properties": { - "category": { - "$ref": "#/definitions/RuleCategory" - }, - "status": { - "$ref": "#/definitions/RuleStatus" - }, - "type": { - "$ref": "#/definitions/RuleType" - } + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory" }, - "discriminator": "type" + "status": { + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "$ref": "#/definitions/RuleType" + } + }, + "discriminator": "type" }, "OutboundRuleBasicResource": { - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { "properties": { - "properties": { - "$ref": "#/definitions/OutboundRule" - } + "$ref": "#/definitions/OutboundRule" } + } }, "OutboundRuleListResult": { - "type": "object", - "properties": { - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - }, - "value": { - "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", - "type": "array", - "items": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - } + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } } + } }, "PATAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" - } - }, - "x-ms-discriminator-value": "PAT" + "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, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "value": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - } + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "value": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } + } }, "PrivateEndpointConnection": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "location": { - "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": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } + "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": { + "type": "object", + "additionalProperties": { + "type": "string" + } } + } }, "PrivateEndpointConnectionListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - } - } + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } } + } }, "PrivateEndpointConnectionProperties": { - "description": "Private endpoint connection properties.", - "type": "object", - "properties": { - "privateEndpoint": { - "$ref": "#/definitions/WorkspacePrivateEndpointResource" - }, - "privateLinkServiceConnectionState": { - "description": "The connection state.", - "$ref": "#/definitions/PrivateLinkServiceConnectionState" - }, - "provisioningState": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" - } + "description": "Private endpoint connection properties.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/WorkspacePrivateEndpointResource" + }, + "privateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } + } }, "PrivateEndpointDestination": { - "type": "object", - "properties": { - "serviceResourceId": { - "type": "string" - }, - "sparkEnabled": { - "type": "boolean" - }, - "sparkStatus": { - "$ref": "#/definitions/RuleStatus" - }, - "subresourceTarget": { - "type": "string" - } + "type": "object", + "properties": { + "serviceResourceId": { + "type": "string" + }, + "sparkEnabled": { + "type": "boolean" + }, + "sparkStatus": { + "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" } + } }, "PrivateEndpointOutboundRule": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], - "properties": { - "destination": { - "$ref": "#/definitions/PrivateEndpointDestination" - } - }, - "x-ms-discriminator-value": "PrivateEndpoint" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/PrivateEndpointDestination" + } + }, + "x-ms-discriminator-value": "PrivateEndpoint" }, "PrivateEndpointServiceConnectionStatus": { - "description": "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)", - "enum": [ - "Approved", - "Pending", - "Rejected", - "Disconnected", - "Timeout" - ], - "type": "string", - "x-ms-enum": { - "name": "EndpointServiceConnectionStatus", - "modelAsString": true - } + "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 + } }, "PrivateLinkResource": { - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "location": { - "description": "Same as workspace location.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "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" - } - } + "$ref": "#/definitions/PrivateLinkResourceProperties", + "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" + } } + } }, "PrivateLinkResourceListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } - } + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } } + } }, "PrivateLinkResourceProperties": { - "type": "object", - "properties": { - "groupId": { - "description": "The private link resource group id.", - "type": "string" - }, - "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" - } - } + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "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" + } } + } }, "PrivateLinkServiceConnectionState": { - "type": "object", - "properties": { - "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" - } + "type": "object", + "properties": { + "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" } + } }, "ProvisioningState": { - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } }, "PublicNetworkAccessType": { - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccessType", - "modelAsString": true - } + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true + } }, "RegistryListCredentialsResult": { - "type": "object", - "properties": { - "location": { - "description": "The location of the workspace ACR", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "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" - ] - } + "type": "object", + "properties": { + "location": { + "description": "The location of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "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" + ] } + } }, "RuleAction": { - "enum": [ - "Allow", - "Deny" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleAction", - "modelAsString": true - } + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } }, "RuleCategory": { - "enum": [ - "Required", - "Recommended", - "UserDefined" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleCategory", - "modelAsString": true - } + "enum": [ + "Required", + "Recommended", + "UserDefined" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } }, "RuleStatus": { - "enum": [ - "Inactive", - "Active" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleStatus", - "modelAsString": true - } + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } }, "RuleType": { - "enum": [ - "FQDN", - "PrivateEndpoint", - "ServiceTag" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleType", - "modelAsString": true - } + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } }, "SASAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" - } - }, - "x-ms-discriminator-value": "SAS" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "SAS" }, "ServiceManagedResourcesSettings": { - "type": "object", - "properties": { - "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings" - } + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings" } + } }, "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" - } - }, - "x-ms-discriminator-value": "ServicePrincipal" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" }, "ServiceTagDestination": { - "type": "object", - "properties": { - "action": { - "$ref": "#/definitions/RuleAction" - }, - "addressPrefixes": { - "description": "Optional, if provided, the ServiceTag property will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "portRanges": { - "type": "string" - }, - "protocol": { - "type": "string" - }, - "serviceTag": { - "type": "string" - } + "type": "object", + "properties": { + "action": { + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "serviceTag": { + "type": "string" } + } }, "ServiceTagOutboundRule": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OutboundRule" - } - ], - "properties": { - "destination": { - "$ref": "#/definitions/ServiceTagDestination" - } - }, - "x-ms-discriminator-value": "ServiceTag" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/ServiceTagDestination" + } + }, + "x-ms-discriminator-value": "ServiceTag" }, "SharedPrivateLinkResource": { - "type": "object", + "type": "object", + "properties": { + "name": { + "description": "Unique name of the private link", + "type": "string" + }, "properties": { - "name": { - "description": "Unique name of the private link", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/SharedPrivateLinkResourceProperty", - "x-ms-client-flatten": true - } + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true } + } }, "SharedPrivateLinkResourceProperty": { - "type": "object", - "properties": { - "groupId": { - "description": "group id of the private link", - "type": "string" - }, - "privateLinkResourceId": { - "description": "the resource id that private link links to", - "type": "string" - }, - "requestMessage": { - "description": "Request message", - "type": "string" - }, - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" - } + "type": "object", + "properties": { + "groupId": { + "description": "group id of the private link", + "type": "string" + }, + "privateLinkResourceId": { + "description": "the resource id that private link links to", + "type": "string" + }, + "requestMessage": { + "description": "Request message", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } + } }, "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" - } - }, - "x-ms-discriminator-value": "UsernamePassword" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + } + }, + "x-ms-discriminator-value": "UsernamePassword" }, "Workspace": { - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "type": "string" + }, + "location": { + "type": "string" + }, "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "type": "string" - }, - "location": { - "type": "string" - }, - "properties": { - "description": "Additional attributes of the entity.", - "$ref": "#/definitions/WorkspaceProperties", - "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" - } - } + "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" + } } + } }, "WorkspaceConnectionAccessKey": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "accessKeyId": { - "type": "string" - }, - "secretAccessKey": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" } + } }, "WorkspaceConnectionApiKey": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "key": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "key": { + "type": "string" } + } }, "WorkspaceConnectionManagedIdentity": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "clientId": { - "type": "string" - }, - "resourceId": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" } + } }, "WorkspaceConnectionPersonalAccessToken": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "pat": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "pat": { + "type": "string" } + } }, "WorkspaceConnectionPropertiesV2": { - "required": [ - "authType" - ], - "type": "object", - "properties": { - "authType": { - "description": "Authentication type of the connection target", - "$ref": "#/definitions/ConnectionAuthType" - }, - "category": { - "description": "Category of the connection", - "$ref": "#/definitions/ConnectionCategory" - }, - "expiryTime": { - "format": "date-time", - "type": "string" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/IValue" - } - }, - "target": { - "type": "string" - } + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" + }, + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "expiryTime": { + "format": "date-time", + "type": "string" }, - "discriminator": "authType" + "metadata": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/IValue" + } + }, + "target": { + "type": "string" + } + }, + "discriminator": "authType" }, "WorkspaceConnectionPropertiesV2BasicResource": { - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { "properties": { - "properties": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } + } }, "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { - "type": "object", - "properties": { - "nextLink": { - "type": "string" - }, - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - } + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } } + } }, "WorkspaceConnectionServicePrincipal": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "clientId": { - "type": "string" - }, - "clientSecret": { - "type": "string" - }, - "tenantId": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + }, + "tenantId": { + "type": "string" } + } }, "WorkspaceConnectionSharedAccessSignature": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "sas": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" } + ], + "properties": { + "sas": { + "type": "string" + } + } }, "WorkspaceConnectionUpdateParameter": { - "type": "object", + "type": "object", + "properties": { "properties": { - "properties": { - "description": "The properties that the machine learning workspace connection will be updated with.", - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } + "description": "The properties that the machine learning workspace connection will be updated with.", + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } + } }, "WorkspaceConnectionUsernamePassword": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], - "properties": { - "password": { - "type": "string" - }, - "username": { - "type": "string" - } + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ], + "properties": { + "password": { + "type": "string" + }, + "username": { + "type": "string" } + } }, "WorkspaceHubConfig": { - "type": "object", - "properties": { - "additionalWorkspaceStorageAccounts": { - "type": "array", - "items": { - "type": "string" - } - }, - "defaultWorkspaceResourceGroup": { - "type": "string" - } + "type": "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": { - "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" - } - } + "description": "The result of a request to list machine learning workspaces.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } } + } }, "WorkspacePrivateEndpointResource": { - "type": "object", - "properties": { - "id": { - "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "subnetArmId": { - "description": "The subnetId that the private endpoint is connected to.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - } + "type": "object", + "properties": { + "id": { + "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } + } }, "WorkspaceProperties": { - "description": "The properties of a machine learning workspace.", - "type": "object", - "properties": { - "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": {}, - "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" - }, - "privateEndpointConnections": { - "description": "The list of private endpoint connections in the workspace.", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-identifiers": [ - "name" - ] - }, - "privateLinkCount": { - "format": "int32", - "description": "Count of private connections in the workspace", - "type": "integer", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "provisioningState": { - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", - "$ref": "#/definitions/ProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "publicNetworkAccess": { - "description": "Whether requests from Public Network are allowed.", - "$ref": "#/definitions/PublicNetworkAccessType" - }, - "serviceManagedResourcesSettings": { - "description": "The service managed resource settings.", - "$ref": "#/definitions/ServiceManagedResourcesSettings" - }, - "serviceProvisionedResourceGroup": { - "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "sharedPrivateLinkResources": { - "description": "The list of shared private link resources in this workspace.", - "type": "array", - "items": { - "$ref": "#/definitions/SharedPrivateLinkResource" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "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": { - "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" - ] - } + "description": "The properties of a machine learning workspace.", + "type": "object", + "properties": { + "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": {}, + "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" + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections in the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-identifiers": [ + "name" + ] + }, + "privateLinkCount": { + "format": "int32", + "description": "Count of private connections in the workspace", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "serviceProvisionedResourceGroup": { + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources in this workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "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": { + "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" + ] } + } }, "WorkspacePropertiesUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", - "type": "object", - "properties": { - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string" - }, - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "enableDataIsolation": { - "type": "boolean" - }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties" - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" - }, - "imageBuildCompute": { - "description": "The compute name for image build", - "type": "string" - }, - "managedNetwork": {}, - "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" - } + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "managedNetwork": {}, + "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" } + } }, "WorkspaceUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", - "type": "object", + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "properties": { - "description": "The properties that the machine learning workspace will be updated with.", - "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", - "x-ms-client-flatten": true - }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" - }, - "tags": { - "description": "The resource tags for the machine learning workspace.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } + "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": { + }, + "parameters": { "WorkspaceKindParameter": { - "in": "query", - "name": "kind", - "description": "Kind of workspace.", - "type": "string", - "x-ms-parameter-location": "method" + "in": "query", + "name": "kind", + "description": "Kind of workspace.", + "type": "string", + "x-ms-parameter-location": "method" }, "WorkspaceNameParameter": { - "in": "path", - "name": "workspaceName", - "description": "Azure Machine Learning Workspace Name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "in": "path", + "name": "workspaceName", + "description": "Azure Machine Learning Workspace Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, "WorkspaceForceToPurgeParameter": { - "in": "query", - "name": "forceToPurge", - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "in": "query", + "name": "forceToPurge", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" }, "TargetParameter": { - "in": "query", - "name": "target", - "type": "string", - "x-ms-parameter-location": "method" + "in": "query", + "name": "target", + "type": "string", + "x-ms-parameter-location": "method" }, "CategoryParameter": { - "in": "query", - "name": "category", - "type": "string", - "x-ms-parameter-location": "method" + "in": "query", + "name": "category", + "type": "string", + "x-ms-parameter-location": "method" }, "ConnectionName": { - "in": "path", - "name": "connectionName", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "in": "path", + "name": "connectionName", + "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", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "in": "path", + "name": "ruleName", + "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" + "in": "path", + "name": "privateEndpointConnectionName", + "description": "NRP Private Endpoint Connection Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } -}, -"securityDefinitions": { + }, + "securityDefinitions": { "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } } -} + } } From b75c10eb9fa1d12d00774292de60ae6d941c2c24 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Wed, 7 Jun 2023 00:30:32 -0700 Subject: [PATCH 05/19] Update securityDefinitions --- .../preview/2023-06-01-preview/workspaceRP.json | 1 + 1 file changed, 1 insertion(+) 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 f124dbcd1381..fdcd4cc04ba9 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 @@ -3520,6 +3520,7 @@ "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" } From 08e974077ff4d3b0017b0de936feb7a3c5656e03 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Wed, 7 Jun 2023 21:21:52 -0700 Subject: [PATCH 06/19] Revert operation id --- .../preview/2023-06-01-preview/workspaceRP.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index fdcd4cc04ba9..d592c9dc9b8c 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 @@ -949,7 +949,7 @@ "OutboundNetworkDependenciesEndpoints" ], "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "outboundNetworkDependenciesEndpoints", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", "produces": [ "application/json" ], @@ -3465,7 +3465,7 @@ "WorkspaceNameParameter": { "in": "path", "name": "workspaceName", - "description": "Azure Machine Learning Workspace Name", + "description": "Name of Azure Machine Learning workspace.", "required": true, "type": "string", "x-ms-parameter-location": "method", From d07a2afaa817d59a3003fe1f3ffc96c51a0c527e Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 07:59:11 -0700 Subject: [PATCH 07/19] Update description and summary. --- .../2023-06-01-preview/workspaceRP.json | 57 +++++++++++++++++-- 1 file changed, 51 insertions(+), 6 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index d592c9dc9b8c..ada0b20ce4df 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 @@ -179,11 +179,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "forceToPurge", - "type": "boolean", - "default": false, - "x-ms-parameter-location": "method" + "$ref": "#/parameters/WorkspaceForceToPurgeParameter" } ], "responses": { @@ -281,6 +277,8 @@ { "in": "body", "name": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, "schema": { "$ref": "#/definitions/WorkspaceUpdateParameters" } @@ -338,6 +336,7 @@ { "in": "body", "name": "body", + "description": "The parameters for creating or updating a machine learning workspace.", "required": true, "schema": { "$ref": "#/definitions/Workspace" @@ -390,6 +389,7 @@ "tags": [ "WorkspaceConnectionV2Resource" ], + "summary": "Lists all the available machine learning workspaces connections under the specified workspace.", "operationId": "WorkspaceConnections_List", "produces": [ "application/json" @@ -443,6 +443,7 @@ "tags": [ "WorkspaceConnectionV2Resource" ], + "summary": "Delete machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Delete", "produces": [ "application/json" @@ -488,6 +489,7 @@ "tags": [ "WorkspaceConnectionV2Resource" ], + "summary": "Lists machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Get", "produces": [ "application/json" @@ -534,6 +536,7 @@ "WorkspaceConnectionV2Resource" ], "operationId": "WorkspaceConnections_Update", + "summary": "Update machine learning workspaces connections under the specified workspace.", "consumes": [ "application/json" ], @@ -559,6 +562,7 @@ { "in": "body", "name": "body", + "description": "Parameters for workspace connection update.", "schema": { "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" } @@ -588,6 +592,7 @@ "tags": [ "WorkspaceConnectionV2Resource" ], + "summary": "Create or update machine learning workspaces connections under the specified workspace.", "operationId": "WorkspaceConnections_Create", "consumes": [ "application/json" @@ -614,6 +619,7 @@ { "in": "body", "name": "body", + "description": "The object for creating or updating a new workspace connection", "schema": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } @@ -646,6 +652,7 @@ "WorkspaceConnectionV2Resource" ], "operationId": "WorkspaceConnections_ListSecrets", + "summary": "List all the secrets of a machine learning workspaces connections.", "produces": [ "application/json" ], @@ -993,6 +1000,7 @@ "tags": [ "ManagedNetwork" ], + "summary": "Lists the managed network outbound rules for a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_List", "produces": [ "application/json" @@ -1041,6 +1049,7 @@ "ManagedNetwork" ], "operationId": "ManagedNetworkSettingsRule_Get", + "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", "produces": [ "application/json" ], @@ -1086,6 +1095,7 @@ "ManagedNetwork" ], "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", "consumes": [ "application/json" ], @@ -1112,6 +1122,7 @@ "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" } @@ -1476,7 +1487,8 @@ "tags": [ "ManagedNetwork" ], - "operationId": "ManagedNetworkProvisions_Post", + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "summary": "Provisions the managed network of a machine learning workspace.", "consumes": [ "application/json" ], @@ -1499,6 +1511,7 @@ { "in": "body", "name": "body", + "description": "Managed Network Provisioning Options for a machine learning workspace.", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionOptions" } @@ -1647,6 +1660,7 @@ }, "AmlOperationListResult": { "type": "object", + "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.", @@ -1738,10 +1752,12 @@ } }, "Credentials": { + "description": "Base credential object", "type": "object" }, "CustomKeys": { "type": "object", + "description": "Custom Keys credential object", "allOf": [ { "$ref": "#/definitions/Credentials" @@ -1914,6 +1930,7 @@ }, "DiagnoseResult": { "type": "object", + "description": "Result of Diagnose", "properties": { "code": { "description": "Code for workspace setup error", @@ -1948,6 +1965,7 @@ "Information" ], "type": "string", + "description": "Level of workspace setup error", "x-ms-enum": { "name": "DiagnoseResultLevel", "modelAsString": true @@ -2008,6 +2026,7 @@ } }, "EncryptionStatus": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", "enum": [ "Enabled", "Disabled" @@ -2088,7 +2107,9 @@ }, "FQDNEndpointsPropertyBag": { "type": "object", + "description": "Property bag for FQDN endpoints result", "properties": { + "properties": { "$ref": "#/definitions/FQDNEndpoints" } @@ -2110,6 +2131,7 @@ }, "FqdnOutboundRule": { "type": "object", + "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2123,10 +2145,12 @@ "x-ms-discriminator-value": "FQDN" }, "IValue": { + "description": "Value object used for meta data.", "type": "object" }, "IdentityForCmk": { "type": "object", + "description": "Identity object used for encryption.", "properties": { "userAssignedIdentity": { "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", @@ -2140,6 +2164,7 @@ "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", @@ -2248,6 +2273,7 @@ "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedNetworkProvisionOptions": { + "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", "type": "object", "properties": { "includeSpark": { @@ -2256,6 +2282,7 @@ } }, "ManagedNetworkProvisionStatus": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", "type": "object", "properties": { "sparkReady": { @@ -2267,6 +2294,7 @@ } }, "ManagedNetworkStatus": { + "description": "Status for the managed network of a machine learning workspace.", "enum": [ "Inactive", "Active" @@ -2404,6 +2432,7 @@ } }, "OutboundRule": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", "required": [ "type" ], @@ -2422,6 +2451,7 @@ "discriminator": "type" }, "OutboundRuleBasicResource": { + "description": "Outbound Rule Basic Resource for the managed network of a machine learning workspace.", "required": [ "properties" ], @@ -2438,6 +2468,7 @@ } }, "OutboundRuleListResult": { + "description": "List of outbound rules for the managed network of a machine learning workspace.", "type": "object", "properties": { "nextLink": { @@ -2490,6 +2521,7 @@ }, "PrivateEndpointConnection": { "type": "object", + "description": "The Private Endpoint Connection resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" @@ -2522,9 +2554,11 @@ }, "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" } @@ -2549,6 +2583,7 @@ }, "PrivateEndpointDestination": { "type": "object", + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", "properties": { "serviceResourceId": { "type": "string" @@ -2565,6 +2600,7 @@ } }, "PrivateEndpointOutboundRule": { + "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", "type": "object", "allOf": [ { @@ -2595,6 +2631,7 @@ }, "PrivateLinkResource": { "type": "object", + "description": "A private link resource", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" @@ -2625,6 +2662,7 @@ } }, "PrivateLinkResourceListResult": { + "description": "A list of private link resources", "type": "object", "properties": { "value": { @@ -2637,6 +2675,7 @@ }, "PrivateLinkResourceProperties": { "type": "object", + "description": "Properties of a private link resource.", "properties": { "groupId": { "description": "The private link resource group id.", @@ -2660,6 +2699,7 @@ }, "PrivateLinkServiceConnectionState": { "type": "object", + "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "description": "Some RP chose \"None\". Other RPs use this for region expansion.", @@ -3474,6 +3514,7 @@ "WorkspaceForceToPurgeParameter": { "in": "query", "name": "forceToPurge", + "description": "Flag to indicate delete is a purge request.", "type": "boolean", "default": false, "x-ms-parameter-location": "method" @@ -3481,18 +3522,21 @@ "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", @@ -3501,6 +3545,7 @@ "RuleName": { "in": "path", "name": "ruleName", + "description": "Name of the workspace managed network outbound rule", "required": true, "type": "string", "x-ms-parameter-location": "method", From 8c464c237fbd4c72076040951dbd107345d038eb Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 08:38:59 -0700 Subject: [PATCH 08/19] fix prettier issue and add description --- .../preview/2023-06-01-preview/workspaceRP.json | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) 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 ada0b20ce4df..e79a744a5e42 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 @@ -2109,7 +2109,6 @@ "type": "object", "description": "Property bag for FQDN endpoints result", "properties": { - "properties": { "$ref": "#/definitions/FQDNEndpoints" } @@ -2715,6 +2714,7 @@ } }, "ProvisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", "enum": [ "Unknown", "Updating", @@ -2731,6 +2731,7 @@ } }, "PublicNetworkAccessType": { + "description": "The public network access flag.", "enum": [ "Enabled", "Disabled" @@ -2772,6 +2773,7 @@ } }, "RuleAction": { + "description": "The action enum for networking rule.", "enum": [ "Allow", "Deny" @@ -2783,6 +2785,7 @@ } }, "RuleCategory": { + "description": "Category of a managed network Outbound Rule of a machine learning workspace.", "enum": [ "Required", "Recommended", @@ -2795,6 +2798,7 @@ } }, "RuleStatus": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", "enum": [ "Inactive", "Active" @@ -2806,6 +2810,7 @@ } }, "RuleType": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", "enum": [ "FQDN", "PrivateEndpoint", @@ -2855,6 +2860,7 @@ }, "ServiceTagDestination": { "type": "object", + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", "properties": { "action": { "$ref": "#/definitions/RuleAction" @@ -2880,6 +2886,7 @@ }, "ServiceTagOutboundRule": { "type": "object", + "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2907,6 +2914,7 @@ }, "SharedPrivateLinkResourceProperty": { "type": "object", + "description": "Properties of a shared private link resource.", "properties": { "groupId": { "description": "group id of the private link", @@ -2944,6 +2952,7 @@ "properties" ], "type": "object", + "description": "An object that represents a machine learning workspace.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" @@ -2999,6 +3008,7 @@ "$ref": "#/definitions/Credentials" } ], + "description": "Api key object for workspace connection credential.", "properties": { "key": { "type": "string" @@ -3128,6 +3138,7 @@ }, "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.", @@ -3153,6 +3164,7 @@ }, "WorkspaceHubConfig": { "type": "object", + "description": "WorkspaceHub's configuration object.", "properties": { "additionalWorkspaceStorageAccounts": { "type": "array", @@ -3184,6 +3196,7 @@ }, "WorkspacePrivateEndpointResource": { "type": "object", + "description": "The Private Endpoint resource.", "properties": { "id": { "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", From 9b83d8e80e5e508d00d4ce29a564e433d60e4256 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 09:26:53 -0700 Subject: [PATCH 09/19] remove redundent object definition --- .../2023-06-01-preview/workspaceRP.json | 53 +------------------ 1 file changed, 1 insertion(+), 52 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index e79a744a5e42..b3bb571e9935 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 @@ -1751,18 +1751,9 @@ } } }, - "Credentials": { - "description": "Base credential object", - "type": "object" - }, "CustomKeys": { "type": "object", "description": "Custom Keys credential object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "keys": { "type": "object", @@ -2143,10 +2134,6 @@ }, "x-ms-discriminator-value": "FQDN" }, - "IValue": { - "description": "Value object used for meta data.", - "type": "object" - }, "IdentityForCmk": { "type": "object", "description": "Identity object used for encryption.", @@ -2987,11 +2974,6 @@ }, "WorkspaceConnectionAccessKey": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "accessKeyId": { "type": "string" @@ -3003,11 +2985,6 @@ }, "WorkspaceConnectionApiKey": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "description": "Api key object for workspace connection credential.", "properties": { "key": { @@ -3017,11 +2994,6 @@ }, "WorkspaceConnectionManagedIdentity": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "clientId": { "type": "string" @@ -3033,11 +3005,6 @@ }, "WorkspaceConnectionPersonalAccessToken": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "pat": { "type": "string" @@ -3063,10 +3030,7 @@ "type": "string" }, "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/IValue" - } + "type": "object" }, "target": { "type": "string" @@ -3106,11 +3070,6 @@ }, "WorkspaceConnectionServicePrincipal": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "clientId": { "type": "string" @@ -3125,11 +3084,6 @@ }, "WorkspaceConnectionSharedAccessSignature": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "sas": { "type": "string" @@ -3148,11 +3102,6 @@ }, "WorkspaceConnectionUsernamePassword": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Credentials" - } - ], "properties": { "password": { "type": "string" From 32af5bca5a51f784f53a2745f813d3a676f5007a Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 14:05:21 -0700 Subject: [PATCH 10/19] fixing swagger issue revert PaginationParameter --- .../2023-06-01-preview/workspaceRP.json | 75 ++++++++++++++++++- 1 file changed, 72 insertions(+), 3 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index b3bb571e9935..c7b35d5bf195 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 @@ -79,6 +79,9 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "$ref": "#/parameters/PaginationParameter" + }, { "$ref": "#/parameters/WorkspaceKindParameter" } @@ -127,6 +130,9 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "$ref": "#/parameters/PaginationParameter" + }, { "$ref": "#/parameters/WorkspaceKindParameter" } @@ -2144,6 +2150,19 @@ } } }, + "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", @@ -2279,6 +2298,29 @@ } } }, + "ManagedNetworkSettings": { + "description": "Managed Network settings for a machine learning workspace.", + "type": "object", + "properties": { + "isolationMode": { + "$ref": "#/definitions/IsolationMode" + }, + "networkId": { + "type": "string", + "readOnly": true + }, + "outboundRules": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/OutboundRule" + }, + "x-nullable": true + }, + "status": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + } + }, "ManagedNetworkStatus": { "description": "Status for the managed network of a machine learning workspace.", "enum": [ @@ -2563,10 +2605,25 @@ "$ref": "#/definitions/PrivateLinkServiceConnectionState" }, "provisioningState": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" } } }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, "PrivateEndpointDestination": { "type": "object", "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", @@ -3242,7 +3299,9 @@ "type": "string" } }, - "managedNetwork": {}, + "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", @@ -3406,7 +3465,9 @@ "description": "The compute name for image build", "type": "string" }, - "managedNetwork": {}, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, "primaryUserAssignedIdentity": { "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" @@ -3473,6 +3534,14 @@ "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", From 8feb7d84319124ff3a447daffef894da18ef0077 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 14:12:59 -0700 Subject: [PATCH 11/19] Revert back to old file with only reorder for better compare --- .../2023-06-01-preview/workspaceRP.json | 2304 +++++++---------- 1 file changed, 964 insertions(+), 1340 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index c7b35d5bf195..e9af6316eddb 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json @@ -28,16 +28,18 @@ "tags": [ "Operation" ], - "summary": "Lists all of the available Azure Machine Learning Workspaces REST API operations", + "description": "Lists all of the available Azure Machine Learning Services REST API operations.", "operationId": "Operations_List", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/Workspace/operationsList.json" + } + }, "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", @@ -46,17 +48,12 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "OperationsList": { - "$ref": "./examples/Workspace/operationsList.json" - } - }, "x-ms-pageable": { "nextLinkName": null } @@ -67,17 +64,19 @@ "tags": [ "Workspaces" ], - "summary": "Lists all the available machine learning workspaces under the specified subscription.", + "description": "Lists all the available machine learning workspaces under the specified subscription.", "operationId": "Workspaces_ListBySubscription", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/Workspace/listBySubscription.json" + } + }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/PaginationParameter" @@ -94,17 +93,12 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "Get Workspaces by subscription": { - "$ref": "./examples/Workspace/listBySubscription.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -115,20 +109,22 @@ "tags": [ "Workspaces" ], - "summary": "Lists all the available machine learning workspaces under the specified resource group.", + "description": "Lists all the available machine learning workspaces under the specified resource group.", "operationId": "Workspaces_ListByResourceGroup", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/Workspace/listByResourceGroup.json" + } + }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/PaginationParameter" @@ -145,17 +141,12 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "Get Workspaces by Resource Group": { - "$ref": "./examples/Workspace/listByResourceGroup.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -166,12 +157,18 @@ "tags": [ "Workspaces" ], - "summary": "Deletes a machine learning workspace.", + "description": "Deletes a machine learning workspace.", "operationId": "Workspaces_Delete", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/Workspace/delete.json" + } + }, + "x-ms-long-running-operation": true, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -181,47 +178,43 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/WorkspaceForceToPurgeParameter" } ], "responses": { "200": { - "description": "Success" + "description": "The request was successful; the request was well-formed and received properly." }, "202": { - "description": "Accepted" + "description": "The request was accepted; the request was well-formed and received properly." }, "204": { - "description": "No Content" + "description": "The machine learning workspace does not exist in the subscription." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Delete Workspace": { - "$ref": "./examples/Workspace/delete.json" - } - }, - "x-ms-long-running-operation": true + } }, "get": { "tags": [ "Workspaces" ], - "summary": "Gets the properties of the specified machine learning workspace.", + "description": "Gets the properties of the specified machine learning workspace.", "operationId": "Workspaces_Get", - "produces": [ - "application/json" - ], + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -230,9 +223,6 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -243,31 +233,29 @@ } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Get Workspace": { - "$ref": "./examples/Workspace/get.json" - } } }, "patch": { "tags": [ "Workspaces" ], - "summary": "Updates a machine learning workspace with the specified parameters.", + "description": "Updates a machine learning workspace with the specified parameters.", "operationId": "Workspaces_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -278,11 +266,8 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { + "name": "parameters", "in": "body", - "name": "body", "description": "The parameters for updating a machine learning workspace.", "required": true, "schema": { @@ -298,35 +283,32 @@ } }, "202": { - "description": "Accepted" + "description": "The request was successful; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Update Workspace": { - "$ref": "./examples/Workspace/update.json" - } - }, - "x-ms-long-running-operation": true + } }, "put": { "tags": [ "Workspaces" ], - "summary": "Creates or updates a workspace with the specified parameters.", + "description": "Creates or updates a workspace with the specified parameters.", "operationId": "Workspaces_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -337,11 +319,8 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { + "name": "parameters", "in": "body", - "name": "body", "description": "The parameters for creating or updating a machine learning workspace.", "required": true, "schema": { @@ -357,49 +336,23 @@ } }, "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } + "description": "The request was successful; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Create Workspace": { - "$ref": "./examples/Workspace/create.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { "get": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], - "summary": "Lists all the available machine learning workspaces connections under the specified workspace.", "operationId": "WorkspaceConnections_List", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -408,7 +361,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/TargetParameter" @@ -447,13 +400,9 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { "delete": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], - "summary": "Delete machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Delete", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -462,7 +411,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -472,17 +421,17 @@ } ], "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "Success" } }, "x-ms-examples": { @@ -493,13 +442,9 @@ }, "get": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], - "summary": "Lists machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Get", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -508,7 +453,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -537,18 +482,11 @@ } } }, - "patch": { + "put": { "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_Update", - "summary": "Update machine learning workspaces connections under the specified workspace.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "V2WorkspaceConnectionResource" ], + "operationId": "WorkspaceConnections_Create", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -557,7 +495,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -566,11 +504,12 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { + "name": "parameters", "in": "body", - "name": "body", - "description": "Parameters for workspace connection update.", + "description": "The object for creating or updating a new workspace connection", + "required": true, "schema": { - "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } } ], @@ -589,17 +528,19 @@ } }, "x-ms-examples": { - "UpdateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/update.json" + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { "tags": [ - "WorkspaceConnectionV2Resource" + "Workspaces" ], - "summary": "Create or update machine learning workspaces connections under the specified workspace.", - "operationId": "WorkspaceConnections_Create", + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", "consumes": [ "application/json" ], @@ -616,26 +557,39 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, - { - "$ref": "#/parameters/ConnectionName" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", - "name": "body", - "description": "The object for creating or updating a new workspace connection", + "name": "parameters", + "description": "The parameter of diagnosing workspace health", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/DiagnoseWorkspaceParameters" } } ], "responses": { + "202": { + "description": "Success", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/DiagnoseResponseResult" } }, "default": { @@ -646,74 +600,32 @@ } }, "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { "post": { "tags": [ - "WorkspaceConnectionV2Resource" - ], - "operationId": "WorkspaceConnections_ListSecrets", - "summary": "List all the secrets of a machine learning workspaces connections.", - "produces": [ - "application/json" + "Workspaces" ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ConnectionName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", "x-ms-examples": { - "GetWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/listSecrets.json" + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { - "post": { - "tags": [ - "ProxyOperations" - ], - "summary": "Diagnose workspace setup issue.", - "operationId": "Workspaces_Diagnose", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -722,71 +634,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The parameter of diagnosing workspace health", - "schema": { - "$ref": "#/definitions/DiagnoseWorkspaceParameters" - } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "$ref": "#/definitions/ListWorkspaceKeysResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Diagnose Workspace": { - "$ref": "./examples/Workspace/diagnose.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { "post": { "tags": [ - "ProxyOperations" - ], - "summary": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.", - "operationId": "Workspaces_ListKeys", - "produces": [ - "application/json" + "Workspaces" ], + "description": "return notebook access token and refresh token", + "operationId": "Workspaces_ListNotebookAccessToken", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listNotebookAccessToken.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -795,43 +676,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListWorkspaceKeysResult" + "$ref": "#/definitions/NotebookAccessTokenResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listKeys.json" - } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { "post": { "tags": [ "ProxyOperations" ], - "summary": "Get Azure Machine Learning Workspace notebook access token", - "operationId": "Workspaces_ListNotebookAccessToken", - "produces": [ - "application/json" - ], + "operationId": "Workspaces_ListNotebookKeys", + "description": "List keys of a notebook.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -840,43 +718,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/NotebookAccessTokenResult" + "$ref": "#/definitions/ListNotebookKeysResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listNotebookAccessToken.json" - } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { "post": { "tags": [ "ProxyOperations" ], - "summary": "Lists keys of Azure Machine Learning Workspaces notebook.", - "operationId": "Workspaces_ListNotebookKeys", - "produces": [ - "application/json" - ], + "operationId": "Workspaces_ListStorageAccountKeys", + "description": "List storage account keys of a workspace.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -885,39 +760,31 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListNotebookKeysResult" + "$ref": "#/definitions/ListStorageAccountKeysResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Notebook/listKeys.json" - } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { "tags": [ - "ProxyOperations" + "OutboundNetworkDependenciesEndpoints" ], - "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", - "operationId": "Workspaces_ListStorageAccountKeys", + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", "produces": [ "application/json" ], @@ -937,9 +804,9 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { - "$ref": "#/definitions/ListStorageAccountKeysResult" + "$ref": "#/definitions/ExternalFQDNResponse" } }, "default": { @@ -950,19 +817,19 @@ } }, "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.json" + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { "get": { "tags": [ - "OutboundNetworkDependenciesEndpoints" + "ManagedNetwork" ], - "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_List", "produces": [ "application/json" ], @@ -982,9 +849,9 @@ ], "responses": { "200": { - "description": "Success", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ExternalFQDNResponse" + "$ref": "#/definitions/OutboundRuleListResult" } }, "default": { @@ -994,23 +861,23 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ListOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ExternalFQDN/get.json" + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { "tags": [ "ManagedNetwork" ], - "summary": "Lists the managed network outbound rules for a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_List", - "produces": [ - "application/json" - ], + "description": "Deletes an outbound rule from the managed network of a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_Delete", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1021,17 +888,29 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "#/parameters/RuleName" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleListResult" + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } } }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, "default": { "description": "Error", "schema": { @@ -1040,25 +919,21 @@ } }, "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + }, "get": { "tags": [ "ManagedNetwork" ], + "description": "Gets an outbound rule from the managed network of a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_Get", - "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1100,14 +975,8 @@ "tags": [ "ManagedNetwork" ], + "description": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", - "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1125,38 +994,31 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { + "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", "in": "body", - "name": "body", + "name": "parameters", "required": true, - "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", "schema": { "$ref": "#/definitions/OutboundRuleBasicResource" } } ], "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/OutboundRuleBasicResource" - } - }, "202": { "description": "Accepted", "headers": { "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } }, + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, "default": { "description": "Error", "schema": { @@ -1180,12 +1042,21 @@ "tags": [ "ProxyOperations" ], - "summary": "Prepare Azure Machine Learning Workspace's notebook resource", "operationId": "Workspaces_PrepareNotebook", - "produces": [ - "application/json" - ], + "description": "Prepare a notebook.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1194,66 +1065,40 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { "$ref": "#/definitions/NotebookResourceInfo" } }, "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } + "description": "The request was successful; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Prepare Notebook": { - "$ref": "./examples/Notebook/prepare.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { "get": { "tags": [ - "WorkspacePrivateEndpointConnections" + "PrivateEndpointConnections" ], - "summary": "Called by end-users to get all PE connections.", "operationId": "PrivateEndpointConnections_List", - "produces": [ - "application/json" - ], + "description": "List all the private endpoint connections associated with the workspace.", + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, @@ -1262,27 +1107,25 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "OK -- Successfully retrieved private endpoint connections.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-examples": { - "StorageAccountListPrivateEndpointConnections": { - "$ref": "./examples/PrivateEndpointConnection/list.json" - } - }, "x-ms-pageable": { "nextLinkName": null } @@ -1293,11 +1136,13 @@ "tags": [ "WorkspacePrivateEndpointConnections" ], - "summary": "Called by end-users to delete a PE connection.", "operationId": "PrivateEndpointConnections_Delete", - "produces": [ - "application/json" - ], + "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceDeletePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1317,33 +1162,30 @@ ], "responses": { "200": { - "description": "Success" + "description": "OK -- Delete the private endpoint connection successfully." }, "204": { - "description": "No Content" + "description": "No Content -- The private endpoint connection does not exist." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/delete.json" - } } }, "get": { "tags": [ "WorkspacePrivateEndpointConnections" ], - "summary": "Called by end-users to get a PE connection.", "operationId": "PrivateEndpointConnections_Get", - "produces": [ - "application/json" - ], + "description": "Gets the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1363,36 +1205,30 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "OK -- Get the private endpoint connection properties successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspaceGetPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/get.json" - } } }, "put": { "tags": [ "WorkspacePrivateEndpointConnections" ], - "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Update the state of specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1410,33 +1246,28 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { + "name": "properties", "in": "body", - "name": "body", - "description": "PrivateEndpointConnection object", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" - } + }, + "description": "The private endpoint connection properties." } ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "OK -- Update the private endpoint connection properties successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" - } } } }, @@ -1445,11 +1276,13 @@ "tags": [ "WorkspacePrivateLinkResources" ], - "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", "operationId": "PrivateLinkResources_List", - "produces": [ - "application/json" - ], + "description": "Gets the private link resources that need to be created for a workspace.", + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1466,25 +1299,17 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Successfully retrieved private link resources.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "WorkspaceListPrivateLinkResources": { - "$ref": "./examples/PrivateLinkResource/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, @@ -1493,15 +1318,21 @@ "tags": [ "ManagedNetwork" ], + "description": "Provisions the managed network of a machine learning workspace.", "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", - "summary": "Provisions the managed network of a machine learning workspace.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provision.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1512,12 +1343,9 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", "description": "Managed Network Provisioning Options for a machine learning workspace.", + "in": "body", + "name": "parameters", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionOptions" } @@ -1525,7 +1353,7 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success.", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionStatus" } @@ -1536,13 +1364,6 @@ "Location": { "description": "URI to poll for asynchronous operation result.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } }, @@ -1552,29 +1373,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Provision ManagedNetwork": { - "$ref": "./examples/ManagedNetwork/provision.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { "post": { "tags": [ - "ProxyOperations" + "Workspaces" ], - "summary": "Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry", + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", "operationId": "Workspaces_ResyncKeys", - "produces": [ - "application/json" - ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/Workspace/resyncKeys.json" + } + }, "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1583,46 +1401,21 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Success" + "description": "The request was successful; the request was well-formed and received properly." }, "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } + "description": "The request was accepted; the request was well-formed and received properly." }, "default": { - "description": "Error", + "description": "Error response describing why the operation failed", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Resync Workspace Keys": { - "$ref": "./examples/Workspace/resyncKeys.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } } @@ -1640,27 +1433,42 @@ "$ref": "#/definitions/WorkspaceConnectionAccessKey" } }, + "additionalProperties": false, "x-ms-discriminator-value": "AccessKey" }, "AmlOperation": { - "description": "Azure Machine Learning team account REST API operation", + "description": "Azure Machine Learning REST API operation", "type": "object", "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, "display": { - "description": "Gets or sets display name of operation", - "$ref": "#/definitions/OperationDisplay" + "description": "Display name of operation", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } }, "isDataAction": { "description": "Indicates whether the operation applies to data-plane", "type": "boolean" - }, - "name": { - "description": "Gets or sets operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "origin": { - "description": "The intended executor of the operation: user/system", - "type": "string" } } }, @@ -1669,42 +1477,26 @@ "description": "An array of operations supported by the resource provider.", "properties": { "value": { - "description": "Gets or sets list of AML team account operations supported by the\r\nAML team account resource provider.", "type": "array", "items": { "$ref": "#/definitions/AmlOperation" }, "x-ms-identifiers": [ "name" - ] + ], + "description": "List of AML operations supported by the AML resource provider." } } }, - "ApiKeyAuthWorkspaceConnectionProperties": { - "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "ComputeRuntimeDto": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], "properties": { - "credentials": { - "$ref": "#/definitions/WorkspaceConnectionApiKey" - } - }, - "x-ms-discriminator-value": "ApiKey" - }, - "ComputeRuntimeDto": { - "type": "object", - "properties": { - "sparkRuntimeVersion": { - "type": "string" + "sparkRuntimeVersion": { + "type": "string" } } }, "ConnectionAuthType": { - "description": "Authentication type of the connection target", "enum": [ "PAT", "ManagedIdentity", @@ -1712,37 +1504,32 @@ "None", "SAS", "ServicePrincipal", - "AccessKey", - "ApiKey", - "CustomKeys" + "AccessKey" ], "type": "string", + "description": "Authentication type of the connection target", "x-ms-enum": { "name": "ConnectionAuthType", "modelAsString": true } }, "ConnectionCategory": { - "description": "Category of the connection", "enum": [ "PythonFeed", "ContainerRegistry", "Git", + "FeatureStore", "S3", "Snowflake", "AzureSqlDb", "AzureSynapseAnalytics", "AzureMySqlDb", "AzurePostgresDb", - "ADLSGen2", - "Redis", - "ApiKey", - "AzureOpenAI", - "CognitiveSearch", - "CognitiveService", - "CustomKeys" + "AzureDataLakeGen2", + "Redis" ], "type": "string", + "description": "Category of the connection", "x-ms-enum": { "name": "ConnectionCategory", "modelAsString": true @@ -1752,85 +1539,77 @@ "type": "object", "properties": { "collectionsThroughput": { + "type": "integer", "format": "int32", - "type": "integer" + "description": "The throughput of the collections in cosmosdb database" } } }, - "CustomKeys": { + "DiagnoseRequestProperties": { "type": "object", - "description": "Custom Keys credential object", "properties": { - "keys": { + "udr": { + "description": "Setting for diagnosing user defined routing", "type": "object", "additionalProperties": { - "type": "string" + "type": "object" } - } - } - }, - "CustomKeysWorkspaceConnectionProperties": { - "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - ], - "properties": { - "credentials": { - "$ref": "#/definitions/CustomKeys" - } - }, - "x-ms-discriminator-value": "CustomKeys" - }, - "DiagnoseRequestProperties": { - "type": "object", - "properties": { - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", + }, + "nsg": { + "description": "Setting for diagnosing network security group", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "containerRegistry": { - "description": "Setting for diagnosing dependent container registry", + "resourceLock": { + "description": "Setting for diagnosing resource lock", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, "dnsResolution": { "description": "Setting for diagnosing dns resolution", "type": "object", - "additionalProperties": {} - }, - "keyVault": { - "description": "Setting for diagnosing dependent key vault", - "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "nsg": { - "description": "Setting for diagnosing network security group", + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "others": { - "description": "Setting for diagnosing unclassified category of problems", + "keyVault": { + "description": "Setting for diagnosing dependent key vault", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "storageAccount": { - "description": "Setting for diagnosing dependent storage account", + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } }, - "udr": { - "description": "Setting for diagnosing user defined routing", + "others": { + "description": "Setting for diagnosing unclassified category of problems", "type": "object", - "additionalProperties": {} + "additionalProperties": { + "type": "object" + } } } }, @@ -1932,118 +1711,112 @@ "code": { "description": "Code for workspace setup error", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true }, "level": { "description": "Level of workspace setup error", - "$ref": "#/definitions/DiagnoseResultLevel", + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } }, "message": { "description": "Message of workspace setup error", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true } } }, - "DiagnoseResultLevel": { - "enum": [ - "Warning", - "Error", - "Information" - ], - "type": "string", - "description": "Level of workspace setup error", - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } - }, "DiagnoseWorkspaceParameters": { - "description": "Parameters to diagnose a workspace", "type": "object", + "description": "Parameters to diagnose a workspace", "properties": { "value": { + "description": "Value of Parameters", "$ref": "#/definitions/DiagnoseRequestProperties" } } }, - "EncryptionKeyVaultUpdateProperties": { + "EncryptionKeyVaultProperties": { + "properties": { + "keyVaultArmId": { + "description": "The ArmId of the keyVault where the customer owned encryption key is present.", + "type": "string" + }, + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identityClientId": { + "description": "For future use - The client id of the identity which will be used to access key vault.", + "type": "string" + } + }, "required": [ - "keyIdentifier" + "keyIdentifier", + "keyVaultArmId" ], - "type": "object", + "type": "object" + }, + "EncryptionKeyVaultUpdateProperties": { "properties": { "keyIdentifier": { - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", + "description": "Key Vault uri to access the encryption key.", "type": "string" } - } - }, - "EncryptionProperty": { + }, "required": [ - "keyVaultProperties", - "status" + "keyIdentifier" ], - "type": "object", + "type": "object" + }, + "EncryptionProperty": { "properties": { - "cosmosDbResourceId": { - "description": "The byok cosmosdb account that customer brings to store customer's data\r\nwith encryption", - "type": "string" + "status": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } }, "identity": { - "description": "Identity to be used with the keyVault", - "$ref": "#/definitions/IdentityForCmk" + "$ref": "#/definitions/IdentityForCmk", + "description": "The identity that will be used to access the key vault for encryption at rest." }, "keyVaultProperties": { - "description": "KeyVault details to do the encryption", - "$ref": "#/definitions/KeyVaultProperties" - }, - "searchAccountResourceId": { - "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", - "type": "string" - }, - "status": { - "$ref": "#/definitions/EncryptionStatus" - }, - "storageAccountResourceId": { - "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", - "type": "string" + "$ref": "#/definitions/EncryptionKeyVaultProperties", + "description": "Customer Key vault properties." } - } - }, - "EncryptionStatus": { - "description": "Indicates whether or not the encryption is enabled for the workspace.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "EncryptionStatus", - "modelAsString": true - } - }, - "EncryptionUpdateProperties": { + }, "required": [ + "status", "keyVaultProperties" ], - "type": "object", + "type": "object" + }, + "EncryptionUpdateProperties": { "properties": { "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties", + "description": "Customer Key vault properties." } - } + }, + "required": [ + "keyVaultProperties" + ], + "type": "object" }, "ExternalFQDNResponse": { "type": "object", @@ -2051,7 +1824,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/FQDNEndpointsPropertyBag" + "$ref": "#/definitions/FQDNEndpoints" }, "x-ms-identifiers": [ "/properties/category" @@ -2086,6 +1859,14 @@ } }, "FQDNEndpoints": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpointsProperties" + } + } + }, + "FQDNEndpointsProperties": { "type": "object", "properties": { "category": { @@ -2102,15 +1883,6 @@ } } }, - "FQDNEndpointsPropertyBag": { - "type": "object", - "description": "Property bag for FQDN endpoints result", - "properties": { - "properties": { - "$ref": "#/definitions/FQDNEndpoints" - } - } - }, "FeatureStoreSettings": { "type": "object", "properties": { @@ -2126,8 +1898,8 @@ } }, "FqdnOutboundRule": { - "type": "object", "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2141,11 +1913,11 @@ "x-ms-discriminator-value": "FQDN" }, "IdentityForCmk": { + "description": "Identity that will be used to access key vault for encryption at rest", "type": "object", - "description": "Identity object used for encryption.", "properties": { "userAssignedIdentity": { - "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", + "description": "The ArmId of the user assigned identity that will be used to access the customer managed key vault", "type": "string" } } @@ -2163,51 +1935,17 @@ "modelAsString": true } }, - "KeyVaultProperties": { - "required": [ - "keyIdentifier", - "keyVaultArmId" - ], - "type": "object", - "description": "Customer Key vault properties.", - "properties": { - "identityClientId": { - "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", - "type": "string" - }, - "keyIdentifier": { - "description": "KeyVault key identifier to encrypt the data", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - }, - "keyVaultArmId": { - "description": "KeyVault Arm Id that contains the data encryption key", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string" - } - } - }, "ListNotebookKeysResult": { "type": "object", "properties": { "primaryAccessKey": { - "description": "The primary access key of the Notebook", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true }, "secondaryAccessKey": { - "description": "The secondary access key of the Notebook", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true } } @@ -2216,12 +1954,8 @@ "type": "object", "properties": { "userStorageKey": { - "description": "The access key of the storage", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true } } @@ -2229,37 +1963,27 @@ "ListWorkspaceKeysResult": { "type": "object", "properties": { - "appInsightsInstrumentationKey": { - "description": "The access key of the workspace app insights", + "userStorageKey": { + "readOnly": true, "type": "string", + "x-ms-secret": true + }, + "userStorageResourceId": { "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string", "x-ms-secret": true }, "containerRegistryCredentials": { + "readOnly": true, "$ref": "#/definitions/RegistryListCredentialsResult" }, "notebookAccessKeys": { - "$ref": "#/definitions/ListNotebookKeysResult" - }, - "userStorageArmId": { - "description": "The arm Id key of the workspace storage", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "userStorageKey": { - "description": "The access key of the workspace storage", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "$ref": "#/definitions/ListNotebookKeysResult" } } }, @@ -2275,6 +1999,7 @@ "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" } }, + "additionalProperties": false, "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedNetworkProvisionOptions": { @@ -2290,11 +2015,11 @@ "description": "Status of the Provisioning for the managed network of a machine learning workspace.", "type": "object", "properties": { - "sparkReady": { - "type": "boolean" - }, "status": { "$ref": "#/definitions/ManagedNetworkStatus" + }, + "sparkReady": { + "type": "boolean" } } }, @@ -2340,69 +2065,46 @@ "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } ], + "additionalProperties": false, "x-ms-discriminator-value": "None" }, "NotebookAccessTokenResult": { "type": "object", "properties": { - "accessToken": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true - }, - "expiresIn": { - "format": "int32", - "type": "integer", + "notebookResourceId": { "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, "hostName": { - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "notebookResourceId": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, "publicDns": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, - "refreshToken": { - "type": "string", + "accessToken": { "readOnly": true, - "x-ms-mutability": [ - "read" - ], + "type": "string", "x-ms-secret": true }, - "scope": { - "type": "string", + "tokenType": { "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" }, - "tokenType": { + "expiresIn": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "refreshToken": { + "readOnly": true, "type": "string", + "x-ms-secret": true + }, + "scope": { "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" } } }, @@ -2424,38 +2126,14 @@ "fqdn": { "type": "string" }, - "isPrivateLinkEnabled": { - "type": "boolean" + "resourceId": { + "type": "string", + "description": "the data plane resourceId that used to initialize notebook component" }, "notebookPreparationError": { + "$ref": "#/definitions/NotebookPreparationError", "description": "The error that occurs when preparing notebook.", - "$ref": "#/definitions/NotebookPreparationError" - }, - "resourceId": { - "description": "the data plane resourceId that used to initialize notebook component", - "type": "string" - } - } - }, - "OperationDisplay": { - "description": "Display name of operation", - "type": "object", - "properties": { - "description": { - "description": "Gets or sets the description for the operation.", - "type": "string" - }, - "operation": { - "description": "Gets or sets the operation that users can perform.", - "type": "string" - }, - "provider": { - "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", - "type": "string" - }, - "resource": { - "description": "Gets or sets the resource on which the operation is performed.", - "type": "string" + "x-nullable": true } } }, @@ -2466,14 +2144,14 @@ ], "type": "object", "properties": { - "category": { - "$ref": "#/definitions/RuleCategory" + "type": { + "$ref": "#/definitions/RuleType" }, "status": { "$ref": "#/definitions/RuleStatus" }, - "type": { - "$ref": "#/definitions/RuleType" + "category": { + "$ref": "#/definitions/RuleCategory" } }, "discriminator": "type" @@ -2493,22 +2171,23 @@ "properties": { "$ref": "#/definitions/OutboundRule" } - } + }, + "additionalProperties": false }, "OutboundRuleListResult": { "description": "List of outbound rules for the managed network of a machine learning workspace.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { "$ref": "#/definitions/OutboundRuleBasicResource" } + }, + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" } } }, @@ -2524,65 +2203,70 @@ "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" } }, + "additionalProperties": false, "x-ms-discriminator-value": "PAT" }, "Password": { "type": "object", "properties": { "name": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "type": "string" }, "value": { - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-ms-secret": true + "type": "string" } } }, - "PrivateEndpointConnection": { + "PrivateEndpoint": { "type": "object", - "description": "The Private Endpoint Connection resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" } - ], + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." }, "location": { - "description": "Same as workspace location.", + "description": "Specifies the location of the resource.", "type": "string" }, - "properties": { - "description": "Private endpoint connection properties.", - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "x-ms-client-flatten": true - }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" - }, "tags": { + "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." } - } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." }, "PrivateEndpointConnectionListResult": { "type": "object", - "description": "List of private endpoint connection associated with the specified workspace", "properties": { "value": { "type": "array", @@ -2591,23 +2275,29 @@ "$ref": "#/definitions/PrivateEndpointConnection" } } - } + }, + "description": "List of private endpoint connection associated with the specified workspace" }, "PrivateEndpointConnectionProperties": { - "description": "Private endpoint connection properties.", "type": "object", "properties": { "privateEndpoint": { - "$ref": "#/definitions/WorkspacePrivateEndpointResource" + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { - "description": "The connection state.", - "$ref": "#/definitions/PrivateLinkServiceConnectionState" + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { - "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." } - } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." }, "PrivateEndpointConnectionProvisioningState": { "type": "string", @@ -2625,20 +2315,20 @@ } }, "PrivateEndpointDestination": { - "type": "object", "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "properties": { "serviceResourceId": { "type": "string" }, + "subresourceTarget": { + "type": "string" + }, "sparkEnabled": { "type": "boolean" }, "sparkStatus": { "$ref": "#/definitions/RuleStatus" - }, - "subresourceTarget": { - "type": "string" } } }, @@ -2658,144 +2348,122 @@ "x-ms-discriminator-value": "PrivateEndpoint" }, "PrivateEndpointServiceConnectionStatus": { - "description": "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)", + "type": "string", + "description": "The private endpoint connection status.", "enum": [ - "Approved", "Pending", + "Approved", "Rejected", "Disconnected", "Timeout" ], - "type": "string", "x-ms-enum": { - "name": "EndpointServiceConnectionStatus", + "name": "PrivateEndpointServiceConnectionStatus", "modelAsString": true } }, "PrivateLinkResource": { "type": "object", - "description": "A private link resource", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } - ], "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "location": { - "description": "Same as workspace location.", - "type": "string" - }, "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", "x-ms-client-flatten": true }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" }, "tags": { + "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." } - } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" }, "PrivateLinkResourceListResult": { - "description": "A list of private link resources", "type": "object", "properties": { "value": { "type": "array", + "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } } - } + }, + "description": "A list of private link resources" }, "PrivateLinkResourceProperties": { "type": "object", - "description": "Properties of a private link resource.", "properties": { "groupId": { "description": "The private link resource group id.", - "type": "string" + "type": "string", + "readOnly": true }, "requiredMembers": { "description": "The private link resource required member names.", "type": "array", "items": { "type": "string" - } + }, + "readOnly": true }, "requiredZoneNames": { - "description": "The private link resource Private link DNS zone name.", "type": "array", "items": { "type": "string" - } + }, + "description": "The private link resource Private link DNS zone name." } - } + }, + "description": "Properties of a private link resource." }, "PrivateLinkServiceConnectionState": { "type": "object", - "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { - "actionsRequired": { - "description": "Some RP chose \"None\". Other RPs use this for region expansion.", - "type": "string" + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." }, "description": { - "description": "User-defined message that, per NRP doc, may be used for approval-related message.", - "type": "string" + "type": "string", + "description": "The reason for approval/rejection of the connection." }, - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." } - } - }, - "ProvisioningState": { - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "PublicNetworkAccessType": { - "description": "The public network access flag.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccessType", - "modelAsString": true - } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." }, "RegistryListCredentialsResult": { "type": "object", "properties": { "location": { - "description": "The location of the workspace ACR", - "type": "string", "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" }, "passwords": { "type": "array", @@ -2805,29 +2473,9 @@ "x-ms-identifiers": [ "name" ] - }, - "username": { - "description": "The username of the workspace ACR", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] } } }, - "RuleAction": { - "description": "The action enum for networking rule.", - "enum": [ - "Allow", - "Deny" - ], - "type": "string", - "x-ms-enum": { - "name": "RuleAction", - "modelAsString": true - } - }, "RuleCategory": { "description": "Category of a managed network Outbound Rule of a machine learning workspace.", "enum": [ @@ -2842,7 +2490,7 @@ } }, "RuleStatus": { - "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "description": "Status of a managed network Outbound Rule of a machine learning workspace.", "enum": [ "Inactive", "Active" @@ -2878,13 +2526,15 @@ "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" } }, + "additionalProperties": false, "x-ms-discriminator-value": "SAS" }, "ServiceManagedResourcesSettings": { "type": "object", "properties": { "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings" + "$ref": "#/definitions/CosmosDbSettings", + "description": "The settings for the service managed cosmosdb account." } } }, @@ -2900,37 +2550,27 @@ "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" } }, + "additionalProperties": false, "x-ms-discriminator-value": "ServicePrincipal" }, "ServiceTagDestination": { - "type": "object", "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "properties": { - "action": { - "$ref": "#/definitions/RuleAction" - }, - "addressPrefixes": { - "description": "Optional, if provided, the ServiceTag property will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "portRanges": { + "serviceTag": { "type": "string" }, "protocol": { "type": "string" }, - "serviceTag": { + "portRanges": { "type": "string" } } }, "ServiceTagOutboundRule": { - "type": "object", "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2947,35 +2587,37 @@ "type": "object", "properties": { "name": { - "description": "Unique name of the private link", + "description": "Unique name of the private link.", "type": "string" }, "properties": { "$ref": "#/definitions/SharedPrivateLinkResourceProperty", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "description": "Resource properties." } } }, "SharedPrivateLinkResourceProperty": { "type": "object", - "description": "Properties of a shared private link resource.", "properties": { - "groupId": { - "description": "group id of the private link", + "privateLinkResourceId": { + "description": "The resource id that private link links to.", "type": "string" }, - "privateLinkResourceId": { - "description": "the resource id that private link links to", + "groupId": { + "description": "The private link resource group id.", "type": "string" }, "requestMessage": { - "description": "Request message", + "description": "Request message.", "type": "string" }, "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } - } + }, + "description": "Properties of a shared private link resource." }, "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { "type": "object", @@ -2989,12 +2631,10 @@ "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" } }, + "additionalProperties": false, "x-ms-discriminator-value": "UsernamePassword" }, "Workspace": { - "required": [ - "properties" - ], "type": "object", "description": "An object that represents a machine learning workspace.", "allOf": [ @@ -3003,29 +2643,32 @@ } ], "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "kind": { - "type": "string" - }, - "location": { - "type": "string" - }, "properties": { - "description": "Additional attributes of the entity.", "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", "x-ms-client-flatten": true }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" }, "tags": { + "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + }, + "kind": { + "type": "string" } } }, @@ -3036,29 +2679,23 @@ "type": "string" }, "secretAccessKey": { - "type": "string" - } - } - }, - "WorkspaceConnectionApiKey": { - "type": "object", - "description": "Api key object for workspace connection credential.", - "properties": { - "key": { - "type": "string" + "type": "string", + "x-ms-secret": true } - } + }, + "additionalProperties": false }, "WorkspaceConnectionManagedIdentity": { "type": "object", "properties": { - "clientId": { + "resourceId": { "type": "string" }, - "resourceId": { + "clientId": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionPersonalAccessToken": { "type": "object", @@ -3066,7 +2703,8 @@ "pat": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionPropertiesV2": { "required": [ @@ -3075,24 +2713,34 @@ "type": "object", "properties": { "authType": { - "description": "Authentication type of the connection target", "$ref": "#/definitions/ConnectionAuthType" }, - "category": { - "description": "Category of the connection", - "$ref": "#/definitions/ConnectionCategory" - }, "expiryTime": { - "format": "date-time", "type": "string" }, - "metadata": { - "type": "object" + "category": { + "$ref": "#/definitions/ConnectionCategory" }, "target": { "type": "string" + }, + "value": { + "description": "Value details of the workspace connection.", + "type": "string" + }, + "valueFormat": { + "description": "format for the workspace connection value", + "type": "string", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "ValueFormat", + "modelAsString": true + } } }, + "additionalProperties": false, "discriminator": "authType" }, "WorkspaceConnectionPropertiesV2BasicResource": { @@ -3109,21 +2757,24 @@ "properties": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { "type": "object", "properties": { - "nextLink": { - "type": "string" - }, "value": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } + }, + "nextLink": { + "readOnly": true, + "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionServicePrincipal": { "type": "object", @@ -3132,12 +2783,14 @@ "type": "string" }, "clientSecret": { - "type": "string" + "type": "string", + "x-ms-secret": true }, "tenantId": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceConnectionSharedAccessSignature": { "type": "object", @@ -3145,374 +2798,343 @@ "sas": { "type": "string" } - } - }, - "WorkspaceConnectionUpdateParameter": { - "type": "object", - "description": "The properties that the machine learning workspace connection will be updated with.", - "properties": { - "properties": { - "description": "The properties that the machine learning workspace connection will be updated with.", - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" - } - } + }, + "additionalProperties": false }, "WorkspaceConnectionUsernamePassword": { "type": "object", "properties": { - "password": { - "type": "string" - }, "username": { "type": "string" - } - } - }, - "WorkspaceHubConfig": { - "type": "object", - "description": "WorkspaceHub's configuration object.", - "properties": { - "additionalWorkspaceStorageAccounts": { - "type": "array", - "items": { - "type": "string" - } }, - "defaultWorkspaceResourceGroup": { + "password": { "type": "string" } - } + }, + "additionalProperties": false }, "WorkspaceListResult": { - "description": "The result of a request to list machine learning workspaces.", "type": "object", + "description": "The result of a request to list machine learning workspaces.", "properties": { - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" - }, "value": { "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { "$ref": "#/definitions/Workspace" } - } - } - }, - "WorkspacePrivateEndpointResource": { - "type": "object", - "description": "The Private Endpoint resource.", - "properties": { - "id": { - "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] }, - "subnetArmId": { - "description": "The subnetId that the private endpoint is connected to.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" } } }, "WorkspaceProperties": { - "description": "The properties of a machine learning workspace.", "type": "object", + "description": "The properties of a machine learning workspace.", "properties": { - "allowPublicAccessWhenBehindVnet": { - "description": "The flag to indicate whether to allow public access when behind VNet.", - "type": "boolean" + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", + "description": { + "description": "The description of this workspace.", "type": "string" }, - "associatedWorkspaces": { - "type": "array", - "items": { - "type": "string" - } + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" }, - "containerRegistries": { - "type": "array", - "items": { - "type": "string" - } + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" }, "containerRegistry": { "description": "ARM id of the container registry associated with this workspace.", - "type": "string" + "type": "string", + "x-nullable": true }, - "description": { - "description": "The description of this workspace.", + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", "type": "string" }, "discoveryUrl": { "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", "type": "string" }, - "enableDataIsolation": { - "type": "boolean" + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "SoftDeleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." }, "encryption": { - "$ref": "#/definitions/EncryptionProperty" - }, - "existingWorkspaces": { - "type": "array", - "items": { - "type": "string" - } - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of Azure ML workspace." }, "hbiWorkspace": { + "type": "boolean", "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", - "type": "boolean" + "default": false }, - "hubResourceId": { - "type": "string" + "serviceProvisionedResourceGroup": { + "type": "string", + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "readOnly": true + }, + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true }, "imageBuildCompute": { "description": "The compute name for image build", "type": "string" }, - "keyVault": { - "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" - }, - "keyVaults": { - "type": "array", - "items": { - "type": "string" - } - }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false }, - "mlFlowTrackingUri": { - "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "publicNetworkAccess": { "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "notebookInfo": { - "description": "The notebook info of Azure ML workspace.", - "$ref": "#/definitions/NotebookResourceInfo", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "primaryUserAssignedIdentity": { - "description": "The user assigned identity resource id that represents the workspace identity.", - "type": "string" + "description": "Whether requests from Public Network are allowed.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } }, "privateEndpointConnections": { - "description": "The list of private endpoint connections in the workspace.", + "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, - "readOnly": true, - "x-ms-mutability": [ - "read" - ], "x-ms-identifiers": [ "name" - ] - }, - "privateLinkCount": { - "format": "int32", - "description": "Count of private connections in the workspace", - "type": "integer", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "provisioningState": { - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", - "$ref": "#/definitions/ProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "publicNetworkAccess": { - "description": "Whether requests from Public Network are allowed.", - "$ref": "#/definitions/PublicNetworkAccessType" - }, - "serviceManagedResourcesSettings": { - "description": "The service managed resource settings.", - "$ref": "#/definitions/ServiceManagedResourcesSettings" - }, - "serviceProvisionedResourceGroup": { - "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + ], + "description": "The list of private endpoint connections in the workspace." }, "sharedPrivateLinkResources": { - "description": "The list of shared private link resources in this workspace.", "type": "array", "items": { "$ref": "#/definitions/SharedPrivateLinkResource" }, "x-ms-identifiers": [ "name" - ] + ], + "description": "The list of shared private link resources in this workspace." }, - "softDeleteRetentionInDays": { - "format": "int32", - "description": "Retention time in days after workspace get soft deleted.", - "type": "integer" + "notebookInfo": { + "readOnly": true, + "$ref": "#/definitions/NotebookResourceInfo", + "description": "The notebook info of Azure ML workspace." }, - "storageAccount": { - "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" }, - "storageAccounts": { - "type": "array", - "items": { - "type": "string" - } + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true }, "storageHnsEnabled": { "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", "type": "boolean", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "systemDatastoresAuthMode": { - "description": "The auth mode used for accessing the system datastores of the workspace.", - "type": "string" + "readOnly": true }, - "tenantId": { - "description": "The tenant id associated with this workspace.", + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true }, "v1LegacyMode": { "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "default": false, "type": "boolean" }, - "workspaceHubConfig": { - "$ref": "#/definitions/WorkspaceHubConfig" + "softDeletedAt": { + "description": "The timestamp when the workspace was soft deleted", + "type": "string", + "readOnly": true }, - "workspaceId": { - "description": "The immutable id associated with this workspace.", + "scheduledPurgeDate": { + "description": "The timestamp when the soft deleted workspace is going to be purged", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "readOnly": true + }, + "systemDatastoresAuthMode": { + "description": "The auth mode used for accessing the system datastores of the workspace", + "type": "string" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "description": "Retention time in days after workspace get soft deleted." + }, + "enableDataIsolation": { + "description": "A flag to determine if workspace has data isolation enabled. The flag can only be set at the creation phase, it can't be updated.", + "default": false, + "type": "boolean" + }, + "storageAccounts": { + "description": ": A list of storage accounts used by Hub.", + "type": "array", + "items": { + "type": "string" + } + }, + "keyVaults": { + "description": "A list of key vaults used by Hub.", + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "description": "A list of container registries used by Hub.", + "type": "array", + "items": { + "type": "string" + } + }, + "existingWorkspaces": { + "description": "A list of existing workspaces used by Hub to perform convert.", + "type": "array", + "items": { + "type": "string" + } + }, + "hubResourceId": { + "description": "Resource Id of Hub used for lean workspace.", + "type": "string" + }, + "associatedWorkspaces": { + "description": "A list of lean workspaces associated with Hub.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" } } }, "WorkspacePropertiesUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", "type": "object", + "description": "The parameters for updating the properties of a machine learning workspace.", "properties": { - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string" - }, "description": { "description": "The description of this workspace.", "type": "string" }, - "enableDataIsolation": { - "type": "boolean" - }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties" - }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" - }, "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", + "description": "The friendly name for this workspace.", "type": "string" }, "imageBuildCompute": { "description": "The compute name for image build", "type": "string" }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." }, "primaryUserAssignedIdentity": { "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" }, "publicNetworkAccess": { + "type": "string", "description": "Whether requests from Public Network are allowed.", - "$ref": "#/definitions/PublicNetworkAccessType" + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } }, - "serviceManagedResourcesSettings": { - "description": "The service managed resource settings.", - "$ref": "#/definitions/ServiceManagedResourcesSettings" + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" }, - "softDeleteRetentionInDays": { - "format": "int32", - "description": "Retention time in days after workspace get soft deleted.", - "type": "integer" + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" }, - "v1LegacyMode": { - "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", - "type": "boolean" + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties", + "description": "The encryption settings of the workspace." + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" } } }, "WorkspaceUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", "type": "object", + "description": "The parameters for updating a machine learning workspace.", "properties": { - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" - }, - "properties": { - "description": "The properties that the machine learning workspace will be updated with.", - "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", - "x-ms-client-flatten": true - }, - "sku": { - "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" - }, "tags": { "description": "The resource tags for the machine learning workspace.", "type": "object", "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true } } } @@ -3521,18 +3143,19 @@ "WorkspaceKindParameter": { "in": "query", "name": "kind", - "description": "Kind of workspace.", "type": "string", + "description": "Kind of workspace.", + "required": false, "x-ms-parameter-location": "method" }, "WorkspaceNameParameter": { - "in": "path", "name": "workspaceName", "description": "Name of Azure Machine Learning workspace.", - "required": true, + "in": "path", "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" }, "PaginationParameter": { "in": "query", @@ -3545,57 +3168,58 @@ "WorkspaceForceToPurgeParameter": { "in": "query", "name": "forceToPurge", - "description": "Flag to indicate delete is a purge request.", "type": "boolean", - "default": false, + "description": "Flag to indicate delete is a purge request.", + "required": false, "x-ms-parameter-location": "method" }, "TargetParameter": { "in": "query", "name": "target", - "description": "Target of the workspace connection.", "type": "string", + "description": "Target of the workspace connection.", + "required": false, "x-ms-parameter-location": "method" }, "CategoryParameter": { "in": "query", "name": "category", - "description": "Category of the workspace connection.", "type": "string", + "description": "Category of the workspace connection.", + "required": false, "x-ms-parameter-location": "method" }, "ConnectionName": { - "in": "path", "name": "connectionName", - "description": "Friendly name of the workspace connection", + "in": "path", "required": true, "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "description": "Friendly name of the workspace connection", + "x-ms-parameter-location": "method" }, "RuleName": { - "in": "path", "name": "ruleName", - "description": "Name of the workspace managed network outbound rule", + "in": "path", "required": true, "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "description": "Name of the workspace managed network outbound rule", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" }, "PrivateEndpointConnectionName": { - "in": "path", "name": "privateEndpointConnectionName", - "description": "NRP Private Endpoint Connection Name", + "in": "path", "required": true, "type": "string", + "description": "The name of the private endpoint connection associated with the workspace", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", - "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" From 029efe4af92e0d703ee6ea47ef8db82cae1085b2 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 14:13:48 -0700 Subject: [PATCH 12/19] Revert "Revert back to old file with only reorder for better compare" This reverts commit 8feb7d84319124ff3a447daffef894da18ef0077. --- .../2023-06-01-preview/workspaceRP.json | 2316 ++++++++++------- 1 file changed, 1346 insertions(+), 970 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index e9af6316eddb..c7b35d5bf195 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json @@ -28,18 +28,16 @@ "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.", @@ -48,12 +46,17 @@ } }, "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 } @@ -64,19 +67,17 @@ "tags": [ "Workspaces" ], - "description": "Lists all the available machine learning workspaces under the specified subscription.", + "summary": "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" - } - }, + "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": "#/parameters/PaginationParameter" @@ -93,12 +94,17 @@ } }, "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" } @@ -109,23 +115,21 @@ "tags": [ "Workspaces" ], - "description": "Lists all the available machine learning workspaces under the specified resource group.", + "summary": "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" - } - }, + "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/ResourceGroupNameParameter" }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/PaginationParameter" }, @@ -141,12 +145,17 @@ } }, "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" } @@ -157,18 +166,12 @@ "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" }, @@ -178,43 +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 }, "get": { "tags": [ "Workspaces" ], - "description": "Gets the properties of the specified machine learning workspace.", + "summary": "Gets the properties of the specified machine learning workspace.", "operationId": "Workspaces_Get", - "x-ms-examples": { - "Get Workspace": { - "$ref": "./examples/Workspace/get.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" }, @@ -223,6 +230,9 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -233,29 +243,31 @@ } }, "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" + } } }, "patch": { "tags": [ "Workspaces" ], - "description": "Updates a machine learning workspace with the specified parameters.", + "summary": "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" - } - }, + "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" }, @@ -266,8 +278,11 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "name": "parameters", + "$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": { @@ -283,32 +298,35 @@ } }, "202": { - "description": "The request was successful; the request was well-formed and received properly." + "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-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "x-ms-long-running-operation": true }, "put": { "tags": [ "Workspaces" ], - "description": "Creates or updates a workspace with the specified parameters.", + "summary": "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" - } - }, + "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" }, @@ -319,8 +337,11 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "name": "parameters", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "body", "description": "The parameters for creating or updating a machine learning workspace.", "required": true, "schema": { @@ -336,23 +357,49 @@ } }, "202": { - "description": "The request was successful; the request was well-formed and received properly." + "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" } } + }, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { "get": { "tags": [ - "V2WorkspaceConnectionResource" + "WorkspaceConnectionV2Resource" ], + "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" @@ -361,7 +408,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/TargetParameter" @@ -400,9 +447,13 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { "delete": { "tags": [ - "V2WorkspaceConnectionResource" + "WorkspaceConnectionV2Resource" ], + "summary": "Delete machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Delete", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -411,7 +462,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -421,17 +472,17 @@ } ], "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, "default": { "description": "Error", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } - }, - "200": { - "description": "Success" - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -442,9 +493,13 @@ }, "get": { "tags": [ - "V2WorkspaceConnectionResource" + "WorkspaceConnectionV2Resource" ], + "summary": "Lists machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Get", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -453,7 +508,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -482,11 +537,18 @@ } } }, - "put": { + "patch": { "tags": [ - "V2WorkspaceConnectionResource" + "WorkspaceConnectionV2Resource" + ], + "operationId": "WorkspaceConnections_Update", + "summary": "Update machine learning workspaces connections under the specified workspace.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], - "operationId": "WorkspaceConnections_Create", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -495,7 +557,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "$ref": "#/parameters/WorkspaceNameParameter" }, { "$ref": "#/parameters/ConnectionName" @@ -504,12 +566,11 @@ "$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, + "name": "body", + "description": "Parameters for workspace connection update.", "schema": { - "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" } } ], @@ -528,19 +589,17 @@ } }, "x-ms-examples": { - "CreateWorkspaceConnection": { - "$ref": "./examples/WorkspaceConnection/create.json" + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { - "post": { + }, + "put": { "tags": [ - "Workspaces" + "WorkspaceConnectionV2Resource" ], - "summary": "Diagnose workspace setup issue.", - "operationId": "Workspaces_Diagnose", + "summary": "Create or update machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_Create", "consumes": [ "application/json" ], @@ -557,39 +616,26 @@ { "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "#/parameters/ConnectionName" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", - "name": "parameters", - "description": "The parameter of diagnosing workspace health", + "name": "body", + "description": "The object for creating or updating a new workspace connection", "schema": { - "$ref": "#/definitions/DiagnoseWorkspaceParameters" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } } ], "responses": { - "202": { - "description": "Success", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "200": { - "description": "Success", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/DiagnoseResponseResult" + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } }, "default": { @@ -600,32 +646,23 @@ } }, "x-ms-examples": { - "Diagnose Workspace": { - "$ref": "./examples/Workspace/diagnose.json" + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { "post": { "tags": [ - "Workspaces" + "WorkspaceConnectionV2Resource" ], - "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" - }, + "operationId": "WorkspaceConnections_ListSecrets", + "summary": "List all the secrets of a machine learning workspaces connections.", + "produces": [ + "application/json" + ], + "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -634,40 +671,49 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListWorkspaceKeysResult" + "$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" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { "post": { "tags": [ - "Workspaces" + "ProxyOperations" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "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" }, @@ -676,40 +722,71 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/NotebookAccessTokenResult" + "$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" } } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { "post": { "tags": [ "ProxyOperations" ], - "operationId": "Workspaces_ListNotebookKeys", - "description": "List keys of a notebook.", - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Notebook/listKeys.json" - } - }, + "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/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -718,40 +795,88 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListNotebookKeysResult" + "$ref": "#/definitions/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}/listStorageAccountKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { "post": { "tags": [ "ProxyOperations" ], - "operationId": "Workspaces_ListStorageAccountKeys", - "description": "List storage account keys of a workspace.", - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/Workspace/listStorageAccountKeys.json" - } - }, + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "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": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } }, + "default": { + "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}/listNotebookKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "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/SubscriptionIdParameter" }, @@ -760,31 +885,39 @@ }, { "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ListStorageAccountKeysResult" + "$ref": "#/definitions/ListNotebookKeysResult" } }, "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" + } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "post": { "tags": [ - "OutboundNetworkDependenciesEndpoints" + "ProxyOperations" ], - "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", - "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", + "operationId": "Workspaces_ListStorageAccountKeys", "produces": [ "application/json" ], @@ -804,9 +937,9 @@ ], "responses": { "200": { - "description": "Success", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { - "$ref": "#/definitions/ExternalFQDNResponse" + "$ref": "#/definitions/ListStorageAccountKeysResult" } }, "default": { @@ -817,19 +950,19 @@ } }, "x-ms-examples": { - "ListOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ExternalFQDN/get.json" + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { "get": { "tags": [ - "ManagedNetwork" + "OutboundNetworkDependenciesEndpoints" ], - "description": "Lists the managed network outbound rules for a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_List", + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", "produces": [ "application/json" ], @@ -849,9 +982,9 @@ ], "responses": { "200": { - "description": "The request was successful; the request was well-formed and received properly.", + "description": "Success", "schema": { - "$ref": "#/definitions/OutboundRuleListResult" + "$ref": "#/definitions/ExternalFQDNResponse" } }, "default": { @@ -861,23 +994,23 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "List ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/listRule.json" + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "get": { "tags": [ "ManagedNetwork" ], - "description": "Deletes an outbound rule from the managed network of a machine learning workspace.", - "operationId": "ManagedNetworkSettingsRule_Delete", + "summary": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_List", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -888,28 +1021,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/OutboundRuleListResult" + } }, "default": { "description": "Error", @@ -919,21 +1040,25 @@ } }, "x-ms-examples": { - "Delete ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/deleteRule.json" + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { "get": { "tags": [ "ManagedNetwork" ], - "description": "Gets an outbound rule from the managed network of a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_Get", + "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -975,8 +1100,14 @@ "tags": [ "ManagedNetwork" ], - "description": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -994,31 +1125,38 @@ "$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", + "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": { - "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" } }, + "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": { @@ -1042,21 +1180,12 @@ "tags": [ "ProxyOperations" ], + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", "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" - } - }, + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1065,40 +1194,66 @@ }, { "$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" } }, "202": { - "description": "The request was successful; the request was well-formed and received properly." + "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" } } + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { "get": { "tags": [ - "PrivateEndpointConnections" + "WorkspacePrivateEndpointConnections" ], + "summary": "Called by end-users to get all PE connections.", "operationId": "PrivateEndpointConnections_List", - "description": "List all the private endpoint connections associated with the workspace.", - "x-ms-examples": { - "StorageAccountListPrivateEndpointConnections": { - "$ref": "./examples/PrivateEndpointConnection/list.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" }, @@ -1107,25 +1262,27 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "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" } }, "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": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, "x-ms-pageable": { "nextLinkName": null } @@ -1136,13 +1293,11 @@ "tags": [ "WorkspacePrivateEndpointConnections" ], + "summary": "Called by end-users to delete a PE connection.", "operationId": "PrivateEndpointConnections_Delete", - "description": "Deletes the specified private endpoint connection associated with the workspace.", - "x-ms-examples": { - "WorkspaceDeletePrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/delete.json" - } - }, + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1162,30 +1317,33 @@ ], "responses": { "200": { - "description": "OK -- Delete the private endpoint connection successfully." + "description": "Success" }, "204": { - "description": "No Content -- The private endpoint connection does not exist." + "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": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } } }, "get": { "tags": [ "WorkspacePrivateEndpointConnections" ], + "summary": "Called by end-users to get a PE connection.", "operationId": "PrivateEndpointConnections_Get", - "description": "Gets the specified private endpoint connection associated with the workspace.", - "x-ms-examples": { - "WorkspaceGetPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/get.json" - } - }, + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1205,30 +1363,36 @@ ], "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" } }, "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": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } } }, "put": { "tags": [ "WorkspacePrivateEndpointConnections" ], + "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", "operationId": "PrivateEndpointConnections_CreateOrUpdate", - "description": "Update the state of specified private endpoint connection associated with the workspace.", - "x-ms-examples": { - "WorkspacePutPrivateEndpointConnection": { - "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" - } - }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1246,28 +1410,33 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "name": "properties", "in": "body", + "name": "body", + "description": "PrivateEndpointConnection object", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" - }, - "description": "The private endpoint connection properties." + } } ], "responses": { "200": { - "description": "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" } }, "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": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } } } }, @@ -1276,13 +1445,11 @@ "tags": [ "WorkspacePrivateLinkResources" ], + "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", "operationId": "PrivateLinkResources_List", - "description": "Gets the private link resources that need to be created for a workspace.", - "x-ms-examples": { - "WorkspaceListPrivateLinkResources": { - "$ref": "./examples/PrivateLinkResource/list.json" - } - }, + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" @@ -1299,17 +1466,25 @@ ], "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" } }, "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": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null } } }, @@ -1318,21 +1493,15 @@ "tags": [ "ManagedNetwork" ], - "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" - } - }, + "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/ApiVersionParameter" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1343,9 +1512,12 @@ "$ref": "#/parameters/WorkspaceNameParameter" }, { - "description": "Managed Network Provisioning Options for a machine learning workspace.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { "in": "body", - "name": "parameters", + "name": "body", + "description": "Managed Network Provisioning Options for a machine learning workspace.", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionOptions" } @@ -1353,7 +1525,7 @@ ], "responses": { "200": { - "description": "Success.", + "description": "The request was successful; the request was well-formed and received properly.", "schema": { "$ref": "#/definitions/ManagedNetworkProvisionStatus" } @@ -1364,6 +1536,13 @@ "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 } } }, @@ -1373,26 +1552,29 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provision.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { "post": { "tags": [ - "Workspaces" + "ProxyOperations" ], - "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "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", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Resync Workspace Keys": { - "$ref": "./examples/Workspace/resyncKeys.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" }, @@ -1401,21 +1583,46 @@ }, { "$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" }, "202": { - "description": "The request was accepted; the request was well-formed and received properly." + "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" } } + }, + "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" } } } @@ -1433,42 +1640,27 @@ "$ref": "#/definitions/WorkspaceConnectionAccessKey" } }, - "additionalProperties": false, "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" } } }, @@ -1477,26 +1669,42 @@ "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." + ] } } }, - "ComputeRuntimeDto": { + "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", - "properties": { - "sparkRuntimeVersion": { + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "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", @@ -1504,32 +1712,37 @@ "None", "SAS", "ServicePrincipal", - "AccessKey" + "AccessKey", + "ApiKey", + "CustomKeys" ], "type": "string", - "description": "Authentication type of the connection target", "x-ms-enum": { "name": "ConnectionAuthType", "modelAsString": true } }, "ConnectionCategory": { + "description": "Category of the connection", "enum": [ "PythonFeed", "ContainerRegistry", "Git", - "FeatureStore", "S3", "Snowflake", "AzureSqlDb", "AzureSynapseAnalytics", "AzureMySqlDb", "AzurePostgresDb", - "AzureDataLakeGen2", - "Redis" + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "CognitiveSearch", + "CognitiveService", + "CustomKeys" ], "type": "string", - "description": "Category of the connection", "x-ms-enum": { "name": "ConnectionCategory", "modelAsString": true @@ -1539,77 +1752,85 @@ "type": "object", "properties": { "collectionsThroughput": { - "type": "integer", "format": "int32", - "description": "The throughput of the collections in cosmosdb database" + "type": "integer" } } }, - "DiagnoseRequestProperties": { + "CustomKeys": { "type": "object", + "description": "Custom Keys credential object", "properties": { - "udr": { - "description": "Setting for diagnosing user defined routing", + "keys": { "type": "object", "additionalProperties": { - "type": "object" + "type": "string" } - }, - "nsg": { - "description": "Setting for diagnosing network security group", + } + } + }, + "CustomKeysWorkspaceConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", "type": "object", - "additionalProperties": { - "type": "object" - } + "additionalProperties": {} }, - "resourceLock": { - "description": "Setting for diagnosing resource lock", + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", "type": "object", - "additionalProperties": { - "type": "object" - } + "additionalProperties": {} }, "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" - } + "additionalProperties": {} }, "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" - } + "additionalProperties": {} }, - "applicationInsights": { - "description": "Setting for diagnosing dependent application insights", + "nsg": { + "description": "Setting for diagnosing network security group", "type": "object", - "additionalProperties": { - "type": "object" - } + "additionalProperties": {} }, "others": { "description": "Setting for diagnosing unclassified category of problems", "type": "object", - "additionalProperties": { - "type": "object" - } + "additionalProperties": {} + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} + }, + "udr": { + "description": "Setting for diagnosing user defined routing", + "type": "object", + "additionalProperties": {} } } }, @@ -1711,112 +1932,118 @@ "code": { "description": "Code for workspace setup error", "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, "level": { "description": "Level of workspace setup error", - "enum": [ - "Warning", - "Error", - "Information" - ], - "type": "string", + "$ref": "#/definitions/DiagnoseResultLevel", "readOnly": true, - "x-ms-enum": { - "name": "DiagnoseResultLevel", - "modelAsString": true - } + "x-ms-mutability": [ + "read" + ] }, "message": { "description": "Message of workspace setup error", "type": "string", - "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": { - "type": "object", "description": "Parameters to diagnose a workspace", + "type": "object", "properties": { "value": { - "description": "Value of Parameters", "$ref": "#/definitions/DiagnoseRequestProperties" } } }, - "EncryptionKeyVaultProperties": { - "properties": { - "keyVaultArmId": { - "description": "The ArmId of the keyVault where the customer owned encryption key is present.", - "type": "string" - }, - "keyIdentifier": { - "description": "Key vault uri to access the encryption key.", - "type": "string" - }, - "identityClientId": { - "description": "For future use - The client id of the identity which will be used to access key vault.", - "type": "string" - } - }, + "EncryptionKeyVaultUpdateProperties": { "required": [ - "keyIdentifier", - "keyVaultArmId" + "keyIdentifier" ], - "type": "object" - }, - "EncryptionKeyVaultUpdateProperties": { + "type": "object", "properties": { "keyIdentifier": { - "description": "Key Vault uri to access the encryption key.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", "type": "string" } - }, - "required": [ - "keyIdentifier" - ], - "type": "object" + } }, "EncryptionProperty": { + "required": [ + "keyVaultProperties", + "status" + ], + "type": "object", "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 - } + "cosmosDbResourceId": { + "description": "The byok cosmosdb account that customer brings to store customer's data\r\nwith encryption", + "type": "string" }, "identity": { - "$ref": "#/definitions/IdentityForCmk", - "description": "The identity that will be used to access the key vault for encryption at rest." + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" }, "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultProperties", - "description": "Customer Key vault properties." + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" + }, + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "status": { + "$ref": "#/definitions/EncryptionStatus" + }, + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" } - }, - "required": [ - "status", - "keyVaultProperties" + } + }, + "EncryptionStatus": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" ], - "type": "object" + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } }, "EncryptionUpdateProperties": { - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties", - "description": "Customer Key vault properties." - } - }, "required": [ "keyVaultProperties" ], - "type": "object" + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } + } }, "ExternalFQDNResponse": { "type": "object", @@ -1824,7 +2051,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/FQDNEndpoints" + "$ref": "#/definitions/FQDNEndpointsPropertyBag" }, "x-ms-identifiers": [ "/properties/category" @@ -1859,14 +2086,6 @@ } }, "FQDNEndpoints": { - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/FQDNEndpointsProperties" - } - } - }, - "FQDNEndpointsProperties": { "type": "object", "properties": { "category": { @@ -1883,6 +2102,15 @@ } } }, + "FQDNEndpointsPropertyBag": { + "type": "object", + "description": "Property bag for FQDN endpoints result", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpoints" + } + } + }, "FeatureStoreSettings": { "type": "object", "properties": { @@ -1898,8 +2126,8 @@ } }, "FqdnOutboundRule": { - "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", "type": "object", + "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -1913,11 +2141,11 @@ "x-ms-discriminator-value": "FQDN" }, "IdentityForCmk": { - "description": "Identity that will be used to access key vault for encryption at rest", "type": "object", + "description": "Identity object used for encryption.", "properties": { "userAssignedIdentity": { - "description": "The ArmId of the user assigned identity that will be used to access the customer managed key vault", + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", "type": "string" } } @@ -1935,17 +2163,51 @@ "modelAsString": true } }, + "KeyVaultProperties": { + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object", + "description": "Customer Key vault properties.", + "properties": { + "identityClientId": { + "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", + "type": "string" + }, + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, "ListNotebookKeysResult": { "type": "object", "properties": { "primaryAccessKey": { - "readOnly": true, + "description": "The primary access key of the Notebook", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-secret": true }, "secondaryAccessKey": { - "readOnly": true, + "description": "The secondary access key of the Notebook", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-secret": true } } @@ -1954,8 +2216,12 @@ "type": "object", "properties": { "userStorageKey": { - "readOnly": true, + "description": "The access key of the storage", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-secret": true } } @@ -1963,27 +2229,37 @@ "ListWorkspaceKeysResult": { "type": "object", "properties": { - "userStorageKey": { - "readOnly": true, - "type": "string", - "x-ms-secret": true - }, - "userStorageResourceId": { - "readOnly": true, - "type": "string" - }, "appInsightsInstrumentationKey": { - "readOnly": true, + "description": "The access key of the workspace app insights", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-secret": true }, "containerRegistryCredentials": { - "readOnly": true, "$ref": "#/definitions/RegistryListCredentialsResult" }, "notebookAccessKeys": { - "readOnly": true, "$ref": "#/definitions/ListNotebookKeysResult" + }, + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "userStorageKey": { + "description": "The access key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true } } }, @@ -1999,7 +2275,6 @@ "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" } }, - "additionalProperties": false, "x-ms-discriminator-value": "ManagedIdentity" }, "ManagedNetworkProvisionOptions": { @@ -2015,11 +2290,11 @@ "description": "Status of the Provisioning for the managed network of a machine learning workspace.", "type": "object", "properties": { - "status": { - "$ref": "#/definitions/ManagedNetworkStatus" - }, "sparkReady": { "type": "boolean" + }, + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" } } }, @@ -2065,46 +2340,69 @@ "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } ], - "additionalProperties": false, "x-ms-discriminator-value": "None" }, "NotebookAccessTokenResult": { "type": "object", "properties": { - "notebookResourceId": { + "accessToken": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true }, - "hostName": { + "expiresIn": { + "format": "int32", + "type": "integer", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, - "publicDns": { + "hostName": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, - "accessToken": { - "readOnly": true, + "notebookResourceId": { "type": "string", - "x-ms-secret": true - }, - "tokenType": { "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, - "expiresIn": { + "publicDns": { + "type": "string", "readOnly": true, - "type": "integer", - "format": "int32" + "x-ms-mutability": [ + "read" + ] }, "refreshToken": { - "readOnly": true, "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-ms-secret": true }, "scope": { + "type": "string", "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] + }, + "tokenType": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } } }, @@ -2126,14 +2424,38 @@ "fqdn": { "type": "string" }, - "resourceId": { - "type": "string", - "description": "the data plane resourceId that used to initialize notebook component" + "isPrivateLinkEnabled": { + "type": "boolean" }, "notebookPreparationError": { - "$ref": "#/definitions/NotebookPreparationError", "description": "The error that occurs when preparing notebook.", - "x-nullable": true + "$ref": "#/definitions/NotebookPreparationError" + }, + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "Display name of operation", + "type": "object", + "properties": { + "description": { + "description": "Gets or sets the description for the operation.", + "type": "string" + }, + "operation": { + "description": "Gets or sets the operation that users can perform.", + "type": "string" + }, + "provider": { + "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "Gets or sets the resource on which the operation is performed.", + "type": "string" } } }, @@ -2144,14 +2466,14 @@ ], "type": "object", "properties": { - "type": { - "$ref": "#/definitions/RuleType" + "category": { + "$ref": "#/definitions/RuleCategory" }, "status": { "$ref": "#/definitions/RuleStatus" }, - "category": { - "$ref": "#/definitions/RuleCategory" + "type": { + "$ref": "#/definitions/RuleType" } }, "discriminator": "type" @@ -2171,23 +2493,22 @@ "properties": { "$ref": "#/definitions/OutboundRule" } - }, - "additionalProperties": false + } }, "OutboundRuleListResult": { "description": "List of outbound rules for the managed network of a machine learning workspace.", "type": "object", "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, "value": { "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { "$ref": "#/definitions/OutboundRuleBasicResource" } - }, - "nextLink": { - "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", - "type": "string" } } }, @@ -2203,70 +2524,65 @@ "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" } }, - "additionalProperties": false, "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 } } }, - "PrivateEndpoint": { - "type": "object", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The ARM identifier for Private Endpoint" - } - }, - "description": "The Private Endpoint resource." - }, "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" } - ], - "description": "The Private Endpoint Connection resource." + } }, "PrivateEndpointConnectionListResult": { "type": "object", + "description": "List of private endpoint connection associated with the specified workspace", "properties": { "value": { "type": "array", @@ -2275,29 +2591,23 @@ "$ref": "#/definitions/PrivateEndpointConnection" } } - }, - "description": "List of private endpoint connection associated with the specified workspace" + } }, "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties.", "type": "object", "properties": { "privateEndpoint": { - "$ref": "#/definitions/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." + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" } - }, - "required": [ - "privateLinkServiceConnectionState" - ], - "description": "Properties of the PrivateEndpointConnectProperties." + } }, "PrivateEndpointConnectionProvisioningState": { "type": "string", @@ -2315,20 +2625,20 @@ } }, "PrivateEndpointDestination": { - "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", "type": "object", + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", "properties": { "serviceResourceId": { "type": "string" }, - "subresourceTarget": { - "type": "string" - }, "sparkEnabled": { "type": "boolean" }, "sparkStatus": { "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" } } }, @@ -2348,122 +2658,144 @@ "x-ms-discriminator-value": "PrivateEndpoint" }, "PrivateEndpointServiceConnectionStatus": { - "type": "string", - "description": "The private endpoint connection status.", + "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": [ - "Pending", "Approved", + "Pending", "Rejected", "Disconnected", "Timeout" ], + "type": "string", "x-ms-enum": { - "name": "PrivateEndpointServiceConnectionStatus", + "name": "EndpointServiceConnectionStatus", "modelAsString": true } }, "PrivateLinkResource": { "type": "object", + "description": "A private link resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], "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." + "$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": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, "tags": { - "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } - }, - "sku": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", - "description": "The sku of the workspace." - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } - ], - "description": "A private link resource" + } }, "PrivateLinkResourceListResult": { + "description": "A list of private link resources", "type": "object", "properties": { "value": { "type": "array", - "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } } - }, - "description": "A list of private link resources" + } }, "PrivateLinkResourceProperties": { "type": "object", + "description": "Properties of a private link resource.", "properties": { "groupId": { "description": "The private link resource group id.", - "type": "string", - "readOnly": true + "type": "string" }, "requiredMembers": { "description": "The private link resource required member names.", "type": "array", "items": { "type": "string" - }, - "readOnly": true + } }, "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", "type": "array", "items": { "type": "string" - }, - "description": "The private link resource Private link DNS zone name." + } } - }, - "description": "Properties of a private link resource." + } }, "PrivateLinkServiceConnectionState": { "type": "object", + "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { - "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string" }, "description": { - "type": "string", - "description": "The reason for approval/rejection of the connection." + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string" }, - "actionsRequired": { - "type": "string", - "description": "A message indicating if changes on the service provider require any updates on the consumer." + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } - }, - "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "ProvisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "PublicNetworkAccessType": { + "description": "The public network access flag.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true + } }, "RegistryListCredentialsResult": { "type": "object", "properties": { "location": { + "description": "The location of the workspace ACR", + "type": "string", "readOnly": true, - "type": "string" - }, - "username": { - "readOnly": true, - "type": "string" + "x-ms-mutability": [ + "read" + ] }, "passwords": { "type": "array", @@ -2473,9 +2805,29 @@ "x-ms-identifiers": [ "name" ] + }, + "username": { + "description": "The username of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } } }, + "RuleAction": { + "description": "The action enum for networking rule.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } + }, "RuleCategory": { "description": "Category of a managed network Outbound Rule of a machine learning workspace.", "enum": [ @@ -2490,7 +2842,7 @@ } }, "RuleStatus": { - "description": "Status of a managed network Outbound Rule of a machine learning workspace.", + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", "enum": [ "Inactive", "Active" @@ -2526,15 +2878,13 @@ "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" } }, - "additionalProperties": false, "x-ms-discriminator-value": "SAS" }, "ServiceManagedResourcesSettings": { "type": "object", "properties": { "cosmosDb": { - "$ref": "#/definitions/CosmosDbSettings", - "description": "The settings for the service managed cosmosdb account." + "$ref": "#/definitions/CosmosDbSettings" } } }, @@ -2550,27 +2900,37 @@ "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" } }, - "additionalProperties": false, "x-ms-discriminator-value": "ServicePrincipal" }, "ServiceTagDestination": { - "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", "type": "object", + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", "properties": { - "serviceTag": { + "action": { + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { "type": "string" }, "protocol": { "type": "string" }, - "portRanges": { + "serviceTag": { "type": "string" } } }, "ServiceTagOutboundRule": { - "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", "type": "object", + "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", "allOf": [ { "$ref": "#/definitions/OutboundRule" @@ -2587,37 +2947,35 @@ "type": "object", "properties": { "name": { - "description": "Unique name of the private link.", + "description": "Unique name of the private link", "type": "string" }, "properties": { "$ref": "#/definitions/SharedPrivateLinkResourceProperty", - "x-ms-client-flatten": true, - "description": "Resource properties." + "x-ms-client-flatten": true } } }, "SharedPrivateLinkResourceProperty": { "type": "object", + "description": "Properties of a shared private link resource.", "properties": { - "privateLinkResourceId": { - "description": "The resource id that private link links to.", + "groupId": { + "description": "group id of the private link", "type": "string" }, - "groupId": { - "description": "The private link resource group id.", + "privateLinkResourceId": { + "description": "the resource id that private link links to", "type": "string" }, "requestMessage": { - "description": "Request message.", + "description": "Request message", "type": "string" }, "status": { - "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" } - }, - "description": "Properties of a shared private link resource." + } }, "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { "type": "object", @@ -2631,10 +2989,12 @@ "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" } }, - "additionalProperties": false, "x-ms-discriminator-value": "UsernamePassword" }, "Workspace": { + "required": [ + "properties" + ], "type": "object", "description": "An object that represents a machine learning workspace.", "allOf": [ @@ -2643,32 +3003,29 @@ } ], "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." + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "type": "string" }, "location": { - "description": "Specifies the location of the resource.", "type": "string" }, + "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": { - "description": "Contains resource tags defined as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } - }, - "sku": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", - "description": "The sku of the workspace." - }, - "kind": { - "type": "string" } } }, @@ -2679,32 +3036,37 @@ "type": "string" }, "secretAccessKey": { - "type": "string", - "x-ms-secret": true + "type": "string" } - }, - "additionalProperties": false + } }, - "WorkspaceConnectionManagedIdentity": { + "WorkspaceConnectionApiKey": { "type": "object", + "description": "Api key object for workspace connection credential.", "properties": { - "resourceId": { - "type": "string" - }, - "clientId": { + "key": { "type": "string" } - }, - "additionalProperties": false + } }, - "WorkspaceConnectionPersonalAccessToken": { + "WorkspaceConnectionManagedIdentity": { "type": "object", "properties": { - "pat": { + "clientId": { + "type": "string" + }, + "resourceId": { "type": "string" } - }, - "additionalProperties": false + } + }, + "WorkspaceConnectionPersonalAccessToken": { + "type": "object", + "properties": { + "pat": { + "type": "string" + } + } }, "WorkspaceConnectionPropertiesV2": { "required": [ @@ -2713,34 +3075,24 @@ "type": "object", "properties": { "authType": { + "description": "Authentication type of the connection target", "$ref": "#/definitions/ConnectionAuthType" }, - "expiryTime": { - "type": "string" - }, "category": { + "description": "Category of the connection", "$ref": "#/definitions/ConnectionCategory" }, - "target": { + "expiryTime": { + "format": "date-time", "type": "string" }, - "value": { - "description": "Value details of the workspace connection.", - "type": "string" + "metadata": { + "type": "object" }, - "valueFormat": { - "description": "format for the workspace connection value", - "type": "string", - "enum": [ - "JSON" - ], - "x-ms-enum": { - "name": "ValueFormat", - "modelAsString": true - } + "target": { + "type": "string" } }, - "additionalProperties": false, "discriminator": "authType" }, "WorkspaceConnectionPropertiesV2BasicResource": { @@ -2757,24 +3109,21 @@ "properties": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" } - }, - "additionalProperties": false + } }, "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { "type": "object", "properties": { + "nextLink": { + "type": "string" + }, "value": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" } - }, - "nextLink": { - "readOnly": true, - "type": "string" } - }, - "additionalProperties": false + } }, "WorkspaceConnectionServicePrincipal": { "type": "object", @@ -2783,14 +3132,12 @@ "type": "string" }, "clientSecret": { - "type": "string", - "x-ms-secret": true + "type": "string" }, "tenantId": { "type": "string" } - }, - "additionalProperties": false + } }, "WorkspaceConnectionSharedAccessSignature": { "type": "object", @@ -2798,343 +3145,374 @@ "sas": { "type": "string" } - }, - "additionalProperties": false + } + }, + "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" + } }, - "password": { + "defaultWorkspaceResourceGroup": { "type": "string" } - }, - "additionalProperties": false + } }, "WorkspaceListResult": { - "type": "object", "description": "The result of a request to list machine learning workspaces.", + "type": "object", "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, "value": { "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { "$ref": "#/definitions/Workspace" } - }, - "nextLink": { - "description": "The URI that can be used to request the next list of machine learning workspaces.", - "type": "string" } } }, - "WorkspaceProperties": { + "WorkspacePrivateEndpointResource": { "type": "object", - "description": "The properties of a machine learning workspace.", + "description": "The Private Endpoint resource.", "properties": { - "workspaceId": { - "description": "The immutable id associated with this workspace.", + "id": { + "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", "type": "string", - "readOnly": true - }, - "description": { - "description": "The description of this workspace.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for this workspace. This name in mutable", - "type": "string" + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "keyVault": { - "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "WorkspaceProperties": { + "description": "The properties of a machine learning workspace.", + "type": "object", + "properties": { + "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", - "x-nullable": true + "type": "string" }, - "storageAccount": { - "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "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" }, - "provisioningState": { - "type": "string", - "enum": [ - "Unknown", - "Updating", - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Canceled", - "SoftDeleted" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - }, - "readOnly": true, - "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + "enableDataIsolation": { + "type": "boolean" }, "encryption": { - "$ref": "#/definitions/EncryptionProperty", - "description": "The encryption settings of Azure ML workspace." + "$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": { - "type": "boolean", "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", - "default": false - }, - "serviceProvisionedResourceGroup": { - "type": "string", - "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", - "readOnly": true + "type": "boolean" }, - "privateLinkCount": { - "type": "integer", - "format": "int32", - "description": "Count of private connections in the workspace", - "readOnly": true + "hubResourceId": { + "type": "string" }, "imageBuildCompute": { "description": "The compute name for image build", "type": "string" }, - "allowPublicAccessWhenBehindVnet": { - "type": "boolean", - "description": "The flag to indicate whether to allow public access when behind VNet.", - "default": false - }, - "publicNetworkAccess": { - "type": "string", - "description": "Whether requests from Public Network are allowed.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "PublicNetworkAccess" - } + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" }, - "privateEndpointConnections": { - "readOnly": true, + "keyVaults": { "type": "array", "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The list of private endpoint connections in the workspace." + "type": "string" + } }, - "sharedPrivateLinkResources": { - "type": "array", - "items": { - "$ref": "#/definitions/SharedPrivateLinkResource" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "The list of shared private link resources in this workspace." + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" }, - "notebookInfo": { + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "type": "string", "readOnly": true, - "$ref": "#/definitions/NotebookResourceInfo", - "description": "The notebook info of Azure ML workspace." + "x-ms-mutability": [ + "read" + ] }, - "serviceManagedResourcesSettings": { - "$ref": "#/definitions/ServiceManagedResourcesSettings", - "description": "The service managed resource settings." + "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" }, - "tenantId": { - "description": "The tenant id associated with this workspace.", - "type": "string", - "readOnly": true + "privateEndpointConnections": { + "description": "The list of private endpoint connections in the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-identifiers": [ + "name" + ] }, - "storageHnsEnabled": { - "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", - "type": "boolean", - "readOnly": true + "privateLinkCount": { + "format": "int32", + "description": "Count of private connections in the workspace", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "mlFlowTrackingUri": { - "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", - "type": "string", - "readOnly": true + "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" + ] }, - "v1LegacyMode": { - "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", - "default": false, - "type": "boolean" + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" }, - "softDeletedAt": { - "description": "The timestamp when the workspace was soft deleted", - "type": "string", - "readOnly": true + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" }, - "scheduledPurgeDate": { - "description": "The timestamp when the soft deleted workspace is going to be purged", + "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 - }, - "systemDatastoresAuthMode": { - "description": "The auth mode used for accessing the system datastores of the workspace", - "type": "string" + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources in this workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [ + "name" + ] }, "softDeleteRetentionInDays": { - "type": "integer", "format": "int32", - "description": "Retention time in days after workspace get soft deleted." + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" }, - "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" + "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": { - "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" - } + "storageHnsEnabled": { + "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "containerRegistries": { - "description": "A list of container registries used by Hub.", - "type": "array", - "items": { - "type": "string" - } + "systemDatastoresAuthMode": { + "description": "The auth mode used for accessing the system datastores of the workspace.", + "type": "string" }, - "existingWorkspaces": { - "description": "A list of existing workspaces used by Hub to perform convert.", - "type": "array", - "items": { - "type": "string" - } + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] }, - "hubResourceId": { - "description": "Resource Id of Hub used for lean workspace.", - "type": "string" + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" }, - "associatedWorkspaces": { - "description": "A list of lean workspaces associated with Hub.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true + "workspaceHubConfig": { + "$ref": "#/definitions/WorkspaceHubConfig" }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] } } }, "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", "type": "object", - "description": "The parameters for updating the properties of a machine learning workspace.", "properties": { + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, "description": { "description": "The description of this workspace.", "type": "string" }, + "enableDataIsolation": { + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, "friendlyName": { - "description": "The friendly name for this workspace.", + "description": "The friendly name for this workspace. This name in mutable", "type": "string" }, "imageBuildCompute": { "description": "The compute name for image build", "type": "string" }, - "serviceManagedResourcesSettings": { - "$ref": "#/definitions/ServiceManagedResourcesSettings", - "description": "The service managed resource settings." + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" }, "primaryUserAssignedIdentity": { "description": "The user assigned identity resource id that represents the workspace identity.", "type": "string" }, "publicNetworkAccess": { - "type": "string", "description": "Whether requests from Public Network are allowed.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "PublicNetworkAccess" - } + "$ref": "#/definitions/PublicNetworkAccessType" }, - "applicationInsights": { - "description": "ARM id of the application insights associated with this workspace.", - "type": "string" - }, - "containerRegistry": { - "description": "ARM id of the container registry associated with this workspace.", - "type": "string" - }, - "encryption": { - "$ref": "#/definitions/EncryptionUpdateProperties", - "description": "The encryption settings of the workspace." + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" }, - "featureStoreSettings": { - "description": "Settings for feature store type workspace.", - "$ref": "#/definitions/FeatureStoreSettings" + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" }, - "managedNetwork": { - "$ref": "#/definitions/ManagedNetworkSettings" + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" } } }, "WorkspaceUpdateParameters": { - "type": "object", "description": "The parameters for updating a machine learning workspace.", + "type": "object", "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "The properties that the machine learning workspace will be updated with.", + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, "tags": { "description": "The resource tags for the machine learning workspace.", "type": "object", "additionalProperties": { "type": "string" } - }, - "sku": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", - "description": "The sku of the workspace." - }, - "identity": { - "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", - "description": "The identity of the resource." - }, - "properties": { - "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", - "description": "The properties that the machine learning workspace will be updated with.", - "x-ms-client-flatten": true } } } @@ -3143,19 +3521,18 @@ "WorkspaceKindParameter": { "in": "query", "name": "kind", - "type": "string", "description": "Kind of workspace.", - "required": false, + "type": "string", "x-ms-parameter-location": "method" }, "WorkspaceNameParameter": { + "in": "path", "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" + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, "PaginationParameter": { "in": "query", @@ -3168,58 +3545,57 @@ "WorkspaceForceToPurgeParameter": { "in": "query", "name": "forceToPurge", - "type": "boolean", "description": "Flag to indicate delete is a purge request.", - "required": false, + "type": "boolean", + "default": false, "x-ms-parameter-location": "method" }, "TargetParameter": { "in": "query", "name": "target", - "type": "string", "description": "Target of the workspace connection.", - "required": false, + "type": "string", "x-ms-parameter-location": "method" }, "CategoryParameter": { "in": "query", "name": "category", - "type": "string", "description": "Category of the workspace connection.", - "required": false, + "type": "string", "x-ms-parameter-location": "method" }, "ConnectionName": { - "name": "connectionName", "in": "path", + "name": "connectionName", + "description": "Friendly name of the workspace connection", "required": true, "type": "string", - "description": "Friendly name of the workspace connection", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, "RuleName": { - "name": "ruleName", "in": "path", + "name": "ruleName", + "description": "Name of the workspace managed network outbound rule", "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" + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, "PrivateEndpointConnectionName": { - "name": "privateEndpointConnectionName", "in": "path", + "name": "privateEndpointConnectionName", + "description": "NRP Private Endpoint Connection Name", "required": true, "type": "string", - "description": "The name of the private endpoint connection associated with the workspace", "x-ms-parameter-location": "method" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" From 1fad5a0285ba1cbdb39d3187d450902bb25d3ea8 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Thu, 8 Jun 2023 14:22:12 -0700 Subject: [PATCH 13/19] Revert connection v2 tag issue --- .../preview/2023-06-01-preview/workspaceRP.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index c7b35d5bf195..649083658661 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 @@ -393,7 +393,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { "get": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], "summary": "Lists all the available machine learning workspaces connections under the specified workspace.", "operationId": "WorkspaceConnections_List", @@ -447,7 +447,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { "delete": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], "summary": "Delete machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Delete", @@ -493,7 +493,7 @@ }, "get": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], "summary": "Lists machine learning workspaces connections by name.", "operationId": "WorkspaceConnections_Get", @@ -539,7 +539,7 @@ }, "patch": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], "operationId": "WorkspaceConnections_Update", "summary": "Update machine learning workspaces connections under the specified workspace.", @@ -596,7 +596,7 @@ }, "put": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], "summary": "Create or update machine learning workspaces connections under the specified workspace.", "operationId": "WorkspaceConnections_Create", @@ -655,7 +655,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { "post": { "tags": [ - "WorkspaceConnectionV2Resource" + "V2WorkspaceConnectionResource" ], "operationId": "WorkspaceConnections_ListSecrets", "summary": "List all the secrets of a machine learning workspaces connections.", From 1b66d934fd01e7eb9edc5aa905eb65d15c2c1619 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Fri, 9 Jun 2023 09:31:06 -0700 Subject: [PATCH 14/19] Add back delete op for network rule --- .../2023-06-01-preview/workspaceRP.json | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) 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 649083658661..f06d7a3a4194 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 @@ -653,6 +653,52 @@ } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "delete": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Delete", + "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": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" + } + }, + "x-ms-long-running-operation": true + }, "post": { "tags": [ "V2WorkspaceConnectionResource" From 5929dcf5fd7adda4b3d0e367e04f1eb7c2618434 Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Mon, 12 Jun 2023 08:11:46 -0700 Subject: [PATCH 15/19] Add back example for the removed API --- .../examples/ManagedNetwork/deleteRule.json | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json new file mode 100644 index 000000000000..16ebacc9a5f9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "some_string", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": {}, + "204": {} + } +} From b84e77e1f593499a9ca1db7be80ef94edbd77fff Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Mon, 12 Jun 2023 08:31:23 -0700 Subject: [PATCH 16/19] Suppress header check caused by old design --- .../resource-manager/readme.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index cedec56e2175..e7dd5a45fc18 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -377,3 +377,14 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) + + +### Suppress rules that due to service design + +``` yaml +suppressions: + - code: LroLocationHeader + from: workspaceRP.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}"].delete + reason: legacy design +``` \ No newline at end of file From de55401f261bcdc38f46337e9e0bf5a23fe608bc Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Mon, 12 Jun 2023 08:45:21 -0700 Subject: [PATCH 17/19] fix delete rule in path --- .../2023-06-01-preview/workspaceRP.json | 92 +++++++++---------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json index f06d7a3a4194..ee25fa50ba3b 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 @@ -653,52 +653,6 @@ } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { - "delete": { - "tags": [ - "ManagedNetwork" - ], - "operationId": "ManagedNetworkSettingsRule_Delete", - "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": "#/parameters/RuleName" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete ManagedNetworkSettingsRule": { - "$ref": "./examples/ManagedNetwork/deleteRule.json" - } - }, - "x-ms-long-running-operation": true - }, "post": { "tags": [ "V2WorkspaceConnectionResource" @@ -1096,6 +1050,52 @@ } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Delete", + "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": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" + } + }, + "x-ms-long-running-operation": true + }, "get": { "tags": [ "ManagedNetwork" From dea1aae605caec154653c04349cda6c09a3d85be Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Mon, 12 Jun 2023 11:59:44 -0700 Subject: [PATCH 18/19] Update example error --- .../2023-06-01-preview/examples/ManagedNetwork/deleteRule.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json index 16ebacc9a5f9..73cdbd6d0d8b 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json @@ -4,7 +4,7 @@ "resourceGroupName": "test-rg", "workspaceName": "aml-workspace-name", "ruleName": "some_string", - "api-version": "2023-04-01-preview" + "api-version": "2023-06-01-preview" }, "responses": { "202": { @@ -12,7 +12,6 @@ "Location": "example_location" } }, - "200": {}, "204": {} } } From a566c9278dfffad674cf7ab9a0329006f0d7ca1b Mon Sep 17 00:00:00 2001 From: ZhidaLiu <86350902+ZhidaLiu@users.noreply.github.com> Date: Tue, 13 Jun 2023 10:05:58 -0700 Subject: [PATCH 19/19] Update delete rule api and remove suppression --- .../examples/ManagedNetwork/deleteRule.json | 1 + .../preview/2023-06-01-preview/workspaceRP.json | 12 +++++++++++- .../resource-manager/readme.md | 13 +------------ 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json index 73cdbd6d0d8b..0584ddea1faa 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json @@ -12,6 +12,7 @@ "Location": "example_location" } }, + "200": {}, "204": {} } } 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 ee25fa50ba3b..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 @@ -1055,6 +1055,7 @@ "ManagedNetwork" ], "operationId": "ManagedNetworkSettingsRule_Delete", + "summary": "Deletes an outbound rule from the managed network of a machine learning workspace.", "produces": [ "application/json" ], @@ -1077,11 +1078,20 @@ ], "responses": { "202": { - "description": "Accepted" + "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": { diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index e7dd5a45fc18..7aa94dc3eef6 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -376,15 +376,4 @@ See configuration in [readme.go.md](./readme.go.md) ## Java -See configuration in [readme.java.md](./readme.java.md) - - -### Suppress rules that due to service design - -``` yaml -suppressions: - - code: LroLocationHeader - from: workspaceRP.json - where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}"].delete - reason: legacy design -``` \ No newline at end of file +See configuration in [readme.java.md](./readme.java.md) \ No newline at end of file