swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Workspaces API schemes: - https tags: - name: Workspaces paths: /workspaces/{workspaceName}/apis: get: operationId: microsoftAzureApisList description: List a collection of APIs. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedApi' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Apis_List: $ref: ./examples/Apis_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Workspaces Workspacename Apis tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}: get: operationId: microsoftAzureApisGet description: Get an API. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Api' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Apis_Get: $ref: ./examples/Apis_Get.json summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/deployments: get: operationId: microsoftAzureApideploymentsListdeployments description: List a collection of API deployments. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedApiDeployment' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiDeployments_ListDeployments: $ref: ./examples/ApiDeployments_ListDeployments.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Deployments tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}: get: operationId: microsoftAzureApideploymentsGetdeployment description: Get an API deployment. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - name: deploymentName in: path description: Deployment identifier. required: true type: string maxLength: 50 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ApiDeployment' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiDeployments_GetDeployment: $ref: ./examples/ApiDeployments_GetDeployment.json summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Deployments Deploymentname tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/versions: get: operationId: microsoftAzureApiversionsListversions description: List a collection of API versions. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedApiVersion' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiVersions_ListVersions: $ref: ./examples/ApiVersions_ListVersions.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}: get: operationId: microsoftAzureApiversionsGetversion description: Get an API version. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - name: versionName in: path description: Version identifier. required: true type: string maxLength: 50 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ApiVersion' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiVersions_GetVersion: $ref: ./examples/ApiVersions_GetVersion.json summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions: get: operationId: microsoftAzureApidefinitionsListdefinitions description: List a collection of API definitions. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - name: versionName in: path description: Version identifier. required: true type: string maxLength: 50 - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedApiDefinition' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiDefinitions_ListDefinitions: $ref: ./examples/ApiDefinitions_ListDefinitions.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname Definitions tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}: get: operationId: microsoftAzureApidefinitionsGetdefinition description: Get an API definition. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - name: versionName in: path description: Version identifier. required: true type: string maxLength: 50 - name: definitionName in: path description: Definition identifier. required: true type: string maxLength: 50 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ApiDefinition' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiDefinitions_GetDefinition: $ref: ./examples/ApiDefinitions_GetDefinition.json summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname Definitions Definitionname tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}:exportSpecification: post: operationId: microsoftAzureApidefinitionsExportspecification description: Export an API specification asynchronously. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - name: versionName in: path description: Version identifier. required: true type: string maxLength: 50 - name: definitionName in: path description: API definition identifier. required: true type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. schema: type: object description: Provides status details for long running operations. properties: id: type: string description: The unique ID of the operation. status: $ref: '#/definitions/Azure.Core.Foundations.OperationState' description: The status of the operation error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: Error object that describes the error when status is "Failed". result: $ref: '#/definitions/ApiSpecExportResult' description: The result of the operation. required: - id - status headers: Operation-Location: type: string format: uri description: The location for monitoring the operation state. default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiDefinitions_ExportSpecification: $ref: ./examples/ApiDefinitions_ExportSpecification.json x-ms-long-running-operation: true summary: Microsoft Azure Post Workspaces Workspacename Apis Apiname Versions Versionname Definitions Definitionname:exportspecification tags: - Workspaces /workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/operations/{operationId}: get: operationId: microsoftAzureApidefinitionsGetexportspecificationoperationstatus description: Gets status of a an API specification export operation. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: apiName in: path description: Api identifier. required: true type: string maxLength: 50 - name: versionName in: path description: Version identifier. required: true type: string maxLength: 50 - name: definitionName in: path description: API definition identifier. required: true type: string - name: operationId in: path description: The unique ID of the operation. required: true type: string responses: '200': description: The request has succeeded. schema: type: object description: Provides status details for long running operations. properties: id: type: string description: The unique ID of the operation. status: $ref: '#/definitions/Azure.Core.Foundations.OperationState' description: The status of the operation error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: Error object that describes the error when status is "Failed". result: $ref: '#/definitions/ApiSpecExportResult' description: The result of the operation. required: - id - status default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: ApiDefinitions_GetExportSpecificationOperationStatus: $ref: ./examples/ApiDefinitions_GetExportSpecificationOperationStatus.json summary: Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname Definitions Definitionname Operations Operationid tags: - Workspaces /workspaces/{workspaceName}/environments: get: operationId: microsoftAzureEnvironmentsList description: List a collection of environments. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedEnvironment' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Environments_List: $ref: ./examples/Environments_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Workspaces Workspacename Environments tags: - Workspaces /workspaces/{workspaceName}/environments/{environmentName}: get: operationId: microsoftAzureEnvironmentsGet description: Get an environment. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: workspaceName in: path description: Workspace identifier. required: true type: string maxLength: 50 - name: environmentName in: path description: Environment identifier. required: true type: string maxLength: 50 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Environment' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Environments_Get: $ref: ./examples/Environments_Get.json summary: Microsoft Azure Get Workspaces Workspacename Environments Environmentname tags: - Workspaces /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}: 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: OK schema: $ref: '#/definitions/WorkspaceResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Workspaces operationId: microsoftAzureWorkspacesGet summary: Microsoft Azure Retrieve A Workspace By Workspacename x-ms-examples: Workspaces: $ref: ./examples/Workspaces_Get.json description: Needs a more full description created. /workspaces/{workspaceId}/query: get: operationId: microsoftAzureQueryGet summary: Microsoft Azure Execute An Analytics Query description: Executes an Analytics query for data x-ms-examples: simple-query: $ref: examples/oms-get-example.json cross-workspace: $ref: examples/oms-get-cross-workspace-example.json parameters: - $ref: '#/parameters/workspaceId' - $ref: '#/parameters/queryParam' - $ref: '#/parameters/timespanParam' responses: '200': description: OK. The API call succeeded and the Analytics query result is in the response payload schema: $ref: '#/definitions/queryResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Workspaces post: operationId: microsoftAzureQueryExecute summary: Microsoft Azure Execute An Analytics Query description: Executes an Analytics query for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query. x-ms-examples: simple-query: $ref: examples/oms-post-example.json cross-workspace: $ref: examples/oms-post-cross-workspace-example.json parameters: - $ref: '#/parameters/workspaceId' - $ref: '#/parameters/queryBody' - $ref: '#/parameters/PreferHeaderParameter' responses: '200': description: OK. The API call succeeded and the Analytics query result is in the response payload schema: $ref: '#/definitions/queryResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Workspaces /workspaces/{workspaceId}/metadata: get: operationId: microsoftAzureMetadataGet summary: Microsoft Azure Gets Metadata Information description: Retrieve the metadata information for the workspace, including its schema, functions, workspace info, categories etc. x-ms-examples: metadataGet: $ref: examples/metadata-get.json parameters: - $ref: '#/parameters/workspaceId' responses: '200': description: OK. The API call succeeded and the metadata result is in the response payload schema: $ref: '#/definitions/metadataResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Workspaces post: operationId: microsoftAzureMetadataPost summary: Microsoft Azure Gets Metadata Information description: Retrieve the metadata information for the workspace, including its schema, functions, workspace info, categories etc. x-ms-examples: metadataPost: $ref: examples/metadata-post.json parameters: - $ref: '#/parameters/workspaceId' responses: '200': description: OK. The API call succeeded and the metadata result is in the response payload schema: $ref: '#/definitions/metadataResults' default: description: An error response object. schema: $ref: '#/definitions/errorResponse' tags: - Workspaces /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces: get: tags: - Workspaces summary: Microsoft Azure Lists All The Available Machine Learning Workspaces Under The Specified Subscription operationId: microsoftAzureWorkspacesListbysubscription 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' - $ref: '#/parameters/PaginationParameter' - in: query name: aiCapabilities type: string 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 description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces: get: tags: - Workspaces summary: Microsoft Azure Lists All The Available Machine Learning Workspaces Under The Specified Resource Group operationId: microsoftAzureWorkspacesListbyresourcegroup 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' - $ref: '#/parameters/PaginationParameter' - in: query name: aiCapabilities type: string 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 description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName} : delete: tags: - Workspaces summary: Microsoft Azure Deletes A Machine Learning Workspace operationId: microsoftAzureWorkspacesDelete 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_2' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/WorkspaceForceToPurgeParameter' 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 '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 x-ms-long-running-operation-options: final-state-via: location description: Needs a more full description created. get: tags: - Workspaces summary: Microsoft Azure Gets The Properties Of The Specified Machine Learning Workspace operationId: microsoftAzureWorkspacesGet 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_2' - $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 description: Needs a more full description created. patch: tags: - Workspaces summary: Microsoft Azure Updates A Machine Learning Workspace With The Specified Parameters operationId: microsoftAzureWorkspacesUpdate 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_2' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - in: body name: body description: The parameters for updating a machine learning workspace. required: true schema: $ref: '#/definitions/WorkspaceUpdateParameters' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/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 description: Needs a more full description created. put: tags: - Workspaces summary: Microsoft Azure Creates Or Updates A Workspace With The Specified Parameters operationId: microsoftAzureWorkspacesCreateorupdate 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_2' - $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: $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 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 description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features : get: tags: - Workspaces description: Lists all enabled features for a workspace operationId: microsoftAzureWorkspacefeaturesList x-ms-examples: List Workspace features: $ref: ./examples/WorkspaceFeature/list.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: machineLearningServices.json#/parameters/WorkspaceNameParameter responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/ListAmlUserFeatureResult' default: description: Error response describing why the operation failed schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningservices Workspaces Workspacename Features ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName} : get: tags: - Workspaces operationId: microsoftAzureWorkspacesGet description: Gets the workspace. x-ms-examples: Get a workspace: $ref: ./examples/WorkspaceGet.json Get a workspace with custom parameters: $ref: ./examples/WorkspaceGetParameters.json Get a workspace with Customer-Managed Key (CMK) encryption for Managed Disks: $ref: ./examples/WorkspaceManagedDiskEncryptionGet.json Get a workspace with Enhanced Security & Compliance Add-On: $ref: ./examples/WorkspaceEnhancedSecurityComplianceGet.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns the workspace. schema: $ref: '#/definitions/Workspace_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename delete: tags: - Workspaces operationId: microsoftAzureWorkspacesDelete description: Deletes the workspace. x-ms-examples: Delete a workspace: $ref: ./examples/WorkspaceDelete.json Delete a workspace with retainUcData parameter: $ref: ./examples/WorkspaceDeleteRetainUcData.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - name: retainUcData in: query required: false type: boolean description: Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace. responses: '200': description: OK. The request has succeeded. '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename put: tags: - Workspaces operationId: microsoftAzureWorkspacesCreateorupdate description: Creates a new workspace. x-ms-examples: Create or update workspace: $ref: ./examples/WorkspaceCreate.json Create or update workspace with custom parameters: $ref: ./examples/WorkspaceCreateWithParameters.json Create a workspace which is ready for Customer-Managed Key (CMK) encryption: $ref: ./examples/PrepareEncryption.json Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption: $ref: ./examples/EnableEncryption.json Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace: $ref: ./examples/DisableEncryption.json Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks: $ref: ./examples/WorkspaceManagedDiskEncryptionCreate.json Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks: $ref: ./examples/WorkspaceManagedDiskEncryptionUpdate.json Create or update a workspace with Enhanced Security & Compliance Add-On: $ref: ./examples/WorkspaceEnhancedSecurityComplianceCreateOrUpdate.json parameters: - name: parameters in: body required: true schema: $ref: '#/definitions/Workspace_2' description: Parameters supplied to the create or update a workspace. - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Created - Returns information about the workspace, including provisioning status. schema: $ref: '#/definitions/Workspace_2' '201': description: Created - Returns information about the workspace, including provisioning status. schema: $ref: '#/definitions/Workspace_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename patch: tags: - Workspaces operationId: microsoftAzureWorkspacesUpdate description: Updates a workspace. parameters: - name: parameters in: body required: true schema: $ref: '#/definitions/WorkspaceUpdate' description: The update to the workspace. - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Successfully updated the workspace. schema: $ref: '#/definitions/Workspace_2' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true x-ms-examples: Update a workspace's tags.: $ref: ./examples/WorkspaceUpdate.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces: get: tags: - Workspaces operationId: microsoftAzureWorkspacesListbyresourcegroup description: Gets all the workspaces within a resource group. x-ms-examples: Lists workspaces: $ref: ./examples/WorkspacesListByResourceGroup.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of workspaces. schema: $ref: '#/definitions/WorkspaceListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces /subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces: get: tags: - Workspaces operationId: microsoftAzureWorkspacesListbysubscription description: Gets all the workspaces within a subscription. x-ms-examples: Lists workspaces: $ref: ./examples/WorkspacesListBySubscription.json parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns an array of workspaces. schema: $ref: '#/definitions/WorkspaceListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databricks Workspaces /subscriptions/{subscriptionId}/providers/Microsoft.IoTFirmwareDefense/workspaces: get: tags: - Workspaces operationId: microsoftAzureWorkspacesListbysubscription description: Lists all of the firmware analysis workspaces in the specified subscription. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/WorkspaceList' default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workspaces_ListBySubscription_MaximumSet_Gen: $ref: ./examples/Workspaces_ListBySubscription_MaximumSet_Gen.json Workspaces_ListBySubscription_MinimumSet_Gen: $ref: ./examples/Workspaces_ListBySubscription_MinimumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Iotfirmwaredefense Workspaces /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces: get: tags: - Workspaces operationId: microsoftAzureWorkspacesListbyresourcegroup description: Lists all of the firmware analysis workspaces in the specified resource group. 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 responses: '200': description: OK schema: $ref: '#/definitions/WorkspaceList' default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workspaces_ListByResourceGroup_MaximumSet_Gen: $ref: ./examples/Workspaces_ListByResourceGroup_MaximumSet_Gen.json Workspaces_ListByResourceGroup_MinimumSet_Gen: $ref: ./examples/Workspaces_ListByResourceGroup_MinimumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName} : put: tags: - Workspaces operationId: microsoftAzureWorkspacesCreate description: The operation to create or update a firmware analysis workspace. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ./common.json#/parameters/WorkspaceNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/WorkspaceCreateBodyParameter' responses: '200': description: OK schema: $ref: '#/definitions/Workspace_3' '201': description: Created schema: $ref: '#/definitions/Workspace_3' default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces_Create_MaximumSet_Gen: $ref: ./examples/Workspaces_Create_MaximumSet_Gen.json Workspaces_Create_MinimumSet_Gen: $ref: ./examples/Workspaces_Create_MinimumSet_Gen.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename patch: tags: - Workspaces operationId: microsoftAzureWorkspacesUpdate description: The operation to update a firmware analysis workspaces. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ./common.json#/parameters/WorkspaceNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/WorkspaceUpdateBodyParameter' responses: '200': description: OK schema: $ref: '#/definitions/Workspace_3' '201': description: Created schema: $ref: '#/definitions/Workspace_3' default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces_Update_MaximumSet_Gen: $ref: ./examples/Workspaces_Update_MaximumSet_Gen.json Workspaces_Update_MinimumSet_Gen: $ref: ./examples/Workspaces_Update_MinimumSet_Gen.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename delete: tags: - Workspaces operationId: microsoftAzureWorkspacesDelete description: The operation to delete a firmware analysis workspace. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ./common.json#/parameters/WorkspaceNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '204': description: No Content default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces_Delete_MaximumSet_Gen: $ref: ./examples/Workspaces_Delete_MaximumSet_Gen.json Workspaces_Delete_MinimumSet_Gen: $ref: ./examples/Workspaces_Delete_MinimumSet_Gen.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename get: tags: - Workspaces operationId: microsoftAzureWorkspacesGet description: Get firmware analysis workspace. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ./common.json#/parameters/WorkspaceNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/Workspace_3' '304': description: Not Modified default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces_Get_MaximumSet_Gen: $ref: ./examples/Workspaces_Get_MaximumSet_Gen.json Workspaces_Get_MinimumSet_Gen: $ref: ./examples/Workspaces_Get_MinimumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/generateUploadUrl : post: tags: - Workspaces operationId: microsoftAzureWorkspacesGenerateuploadurl description: The operation to get a url for file upload. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ./common.json#/parameters/WorkspaceNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GenerateUploadUrlBodyParameter' responses: '200': description: OK schema: $ref: ./common.json#/definitions/UrlToken default: description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces_GenerateUploadUrl_MaximumSet_Gen: $ref: ./examples/Workspaces_GenerateUploadUrl_MaximumSet_Gen.json Workspaces_GenerateUploadUrl_MinimumSet_Gen: $ref: ./examples/Workspaces_GenerateUploadUrl_MinimumSet_Gen.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename Generateuploadurl ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName} : get: tags: - Workspaces description: Gets the properties of the specified machine learning workspace. operationId: microsoftAzureWorkspacesGet parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/WorkspaceNameParameter_3' x-ms-examples: WorkspaceGet: $ref: ./examples/GetWorkspace.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Workspace_5' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename put: tags: - Workspaces description: Creates or updates a workspace with the specified parameters. operationId: microsoftAzureWorkspacesCreateorupdate parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/WorkspaceNameParameter_3' - name: parameters in: body description: The parameters for creating or updating a machine learning workspace. required: true schema: $ref: '#/definitions/Workspace_5' x-ms-examples: WorkspaceCreate: $ref: ./examples/CreateWorkspace.json responses: '200': description: The request was successful; the resource already exists and was updated. schema: $ref: '#/definitions/Workspace_5' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename delete: tags: - Workspaces description: Deletes a machine learning workspace. operationId: microsoftAzureWorkspacesDelete parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/WorkspaceNameParameter_3' x-ms-examples: WorkspaceDelete: $ref: ./examples/DeleteWorkspace.json responses: '200': description: The request was successful; the request was well-formed and received properly. '204': description: The machine learning workspace does not exist in the subscription. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename patch: tags: - Workspaces description: Updates a machine learning workspace with the specified parameters. operationId: microsoftAzureWorkspacesUpdate parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/WorkspaceNameParameter_3' - name: parameters in: body description: The parameters for updating a machine learning workspace. required: true schema: $ref: '#/definitions/WorkspaceUpdateParameters_2' x-ms-examples: WorkspaceUpdate: $ref: ./examples/UpdateWorkspace.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Workspace_5' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/resyncStorageKeys : post: tags: - Workspaces description: Resync storage keys associated with this workspace. operationId: microsoftAzureWorkspacesResyncstoragekeys parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/WorkspaceNameParameter_3' - $ref: '#/parameters/ResourceGroupParameter' x-ms-examples: ResyncStorageKeys: $ref: ./examples/ResyncStorageKeys.json responses: '200': description: The request was successful; the request was well-formed and received properly. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename Resyncstoragekeys ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/listWorkspaceKeys : post: tags: - Workspaces description: List the authorization keys associated with this workspace. operationId: microsoftAzureWorkspacesListworkspacekeys parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/WorkspaceNameParameter_3' - $ref: '#/parameters/ResourceGroupParameter' x-ms-examples: ListWorkspaceKeys: $ref: ./examples/ListWorkspaceKeys.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/WorkspaceKeysResponse' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename Listworkspacekeys /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces: get: tags: - Workspaces description: Lists all the available machine learning workspaces under the specified resource group. operationId: microsoftAzureWorkspacesListbyresourcegroup parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' x-ms-examples: WorkspaceListResourceGroup: $ref: ./examples/ListWorkspaceResourceGroup.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/WorkspaceListResult_3' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/workspaces: get: tags: - Workspaces description: Lists all the available machine learning workspaces under the specified subscription. operationId: microsoftAzureWorkspacesList parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' x-ms-examples: WorkspaceGetBySubscription: $ref: ./examples/ListWorkspaces.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/WorkspaceListResult_3' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_3' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Machinelearning Workspaces /workspaces/{workspaceId}/threatintelligenceindicators:upload: post: x-ms-examples: Upload Threat Intelligence indicators: $ref: ./examples/threatintelligence/UploadThreatIntelligence.json summary: Microsoft Azure Upload The Indicators To The Workspace description: Upload the list of indicators to the workspace specified operationId: microsoftAzureThreatintelligenceindicatorsUpload consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersionParameter_3' - in: path name: workspaceId description: The workspace ID for the indicators to be uploaded. required: true type: string - in: body name: body description: Body of the request with an array of indicators and other properties required: true schema: $ref: '#/definitions/UploadIndicatorsRequest' responses: '200': description: The API returns 200 when at least one indicator is successfully validated and published. schema: $ref: '#/definitions/UploadIndicatorsResponse' default: description: Upload Indicators API service error response. schema: $ref: '#/definitions/ErrorResponseBody' x-ms-error-response: true security: - azure_auth: - user_impersonation tags: - Workspaces /subscriptions/{subscriptionId}/providers/Microsoft.Easm/workspaces: get: tags: - Workspaces description: Returns a list of workspaces under the given subscription. operationId: microsoftAzureWorkspacesListbysubscription parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: List of workspaces. schema: $ref: '#/definitions/WorkspaceResourceList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workspaces: $ref: ./examples/Workspaces_ListBySubscription.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Easm Workspaces /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces: get: tags: - Workspaces description: Returns a list of workspaces in the given resource group. operationId: microsoftAzureWorkspacesListbyresourcegroup parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: List of workspaces. schema: $ref: '#/definitions/WorkspaceResourceList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workspaces: $ref: ./examples/Workspaces_ListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}: get: tags: - Workspaces description: Returns a workspace with the given name. operationId: microsoftAzureWorkspacesGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/WorkspaceNameParameter' responses: '200': description: Workspace details. schema: $ref: '#/definitions/WorkspaceResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces: $ref: ./examples/Workspaces_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename put: tags: - Workspaces description: Create or update a Workspace. operationId: microsoftAzureWorkspacesCreateandupdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/WorkspaceNameParameter' - name: WorkspaceResource description: Workspace details. in: body schema: $ref: '#/definitions/WorkspaceResource' responses: '200': description: Successful. schema: $ref: '#/definitions/WorkspaceResource' '201': description: Long running operation. schema: $ref: '#/definitions/WorkspaceResource' 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: azure-async-operation x-ms-examples: Workspaces: $ref: ./examples/Workspaces_CreateAndUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename patch: tags: - Workspaces description: Update a Workspace. operationId: microsoftAzureWorkspacesUpdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/WorkspaceNameParameter' - name: WorkspacePatchResource description: Workspace patch details. in: body schema: $ref: '#/definitions/WorkspacePatchResource' responses: '200': description: Successful. schema: $ref: '#/definitions/WorkspaceResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Workspaces: $ref: ./examples/Workspaces_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename delete: tags: - Workspaces description: Delete a Workspace. operationId: microsoftAzureWorkspacesDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/WorkspaceNameParameter' responses: '202': description: The Workspace will be deleted asynchronously. '204': description: The Workspace 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: azure-async-operation x-ms-examples: Workspaces: $ref: ./examples/Workspaces_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName} : get: tags: - Workspaces description: Gets the properties of the specified machine learning workspace. operationId: microsoftAzureWorkspacesGet parameters: - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupParameter_2' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/WorkspaceNameParameter_4' x-ms-examples: WorkspaceGet: $ref: examples/WorkspaceGet.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Workspace_6' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_4' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename put: tags: - Workspaces description: Creates or updates a machine learning workspace with the specified parameters. operationId: microsoftAzureWorkspacesCreateorupdate parameters: - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupParameter_2' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/WorkspaceNameParameter_4' - name: parameters in: body description: The parameters for creating or updating a machine learning workspace. required: true schema: $ref: '#/definitions/Workspace_6' x-ms-examples: WorkspaceCreate: $ref: examples/WorkspaceCreate.json responses: '200': description: The request was successful; the resource already exists and was updated. schema: $ref: '#/definitions/Workspace_6' '201': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Workspace_6' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_4' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename delete: tags: - Workspaces description: Deletes a machine learning workspace. operationId: microsoftAzureWorkspacesDelete parameters: - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupParameter_2' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/WorkspaceNameParameter_4' x-ms-examples: WorkspaceDelete: $ref: examples/WorkspaceDelete.json responses: '200': description: The request was successful; the request was well-formed and received properly. '204': description: The machine learning workspace does not exist in the subscription. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_4' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename patch: tags: - Workspaces description: Updates a machine learning workspace with the specified parameters. operationId: microsoftAzureWorkspacesUpdate parameters: - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupParameter_2' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/WorkspaceNameParameter_4' - name: parameters in: body description: The parameters for updating a machine learning workspace. required: true schema: $ref: '#/definitions/WorkspaceUpdateParameters_3' x-ms-examples: WorkspaceUpdate: $ref: examples/WorkspaceUpdate.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/Workspace_6' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_4' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces : get: tags: - Workspaces description: Lists all the available machine learning workspaces under the specified team account. operationId: microsoftAzureWorkspacesListbyaccounts parameters: - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/ResourceGroupParameter_2' x-ms-examples: ListWorkspacesByAccounts: $ref: examples/ListWorkspacesByAccounts.json responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/WorkspaceListResult_4' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_4' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/workspaces : get: x-ms-pageable: nextLinkName: null tags: - Workspaces operationId: microsoftAzureWorkspacesList description: Retrieves all existing Power BI workspaces in the specified workspace collection. consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: Azure resource group required: true type: string - name: workspaceCollectionName in: path description: Power BI Embedded Workspace Collection name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: Get workspaces completed successfully schema: $ref: '#/definitions/WorkspaceList_3' default: description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown. schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname Workspaces /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces: get: operationId: microsoftAzureWorkspacesListbyresourcegroup description: Returns a list of workspaces in a resource group tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter responses: '200': schema: $ref: '#/definitions/WorkspaceInfoListResult' description: '' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-pageable: nextLinkName: nextLink x-ms-examples: List workspaces in resource group: $ref: ./examples/ListWorkspacesInResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}: get: operationId: microsoftAzureWorkspacesGet description: Gets a workspace tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' responses: '200': schema: $ref: '#/definitions/Workspace_8' description: '' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-examples: Get a workspace: $ref: ./examples/GetWorkspace.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename patch: operationId: microsoftAzureWorkspacesUpdate description: Updates a workspace tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' - schema: $ref: '#/definitions/WorkspacePatchInfo' in: body name: workspacePatchInfo required: true description: Workspace patch request properties responses: '200': schema: $ref: '#/definitions/Workspace_8' description: '' '201': schema: $ref: '#/definitions/Workspace_8' description: '' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' 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: Update a workspace: $ref: ./examples/UpdateWorkspace.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename put: operationId: microsoftAzureWorkspacesCreateorupdate description: Creates or updates a workspace tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' - description: Workspace create or update request properties schema: $ref: '#/definitions/Workspace_8' in: body name: workspaceInfo required: true responses: '200': schema: $ref: '#/definitions/Workspace_8' description: '' '201': schema: $ref: '#/definitions/Workspace_8' description: '' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' 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: Create or update a workspace: $ref: ./examples/CreateOrUpdateWorkspace.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename delete: operationId: microsoftAzureWorkspacesDelete description: Deletes a workspace tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' responses: '200': schema: type: object description: OK '202': schema: type: object description: '' '204': description: '' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Delete a workspace: $ref: ./examples/DeleteWorkspace.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename /subscriptions/{subscriptionId}/providers/Microsoft.Synapse/workspaces: get: operationId: microsoftAzureWorkspacesList description: Returns a list of workspaces in a subscription tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter responses: '200': schema: $ref: '#/definitions/WorkspaceInfoListResult' description: '' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-pageable: nextLinkName: nextLink x-ms-examples: List workspaces in subscription: $ref: ./examples/ListWorkspacesInSubscription.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Synapse Workspaces ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory : get: operationId: microsoftAzureWorkspaceaadadminsGet description: Gets a workspace active directory admin tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' responses: '200': schema: $ref: '#/definitions/WorkspaceAadAdminInfo' description: OK default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-examples: Get workspace active directory admin: $ref: ./examples/GetWorkspaceAadAdmin.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Administrators Activedirectory put: operationId: microsoftAzureWorkspaceaadadminsCreateorupdate description: Creates or updates a workspace active directory admin tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' - description: Workspace active directory administrator properties schema: $ref: '#/definitions/WorkspaceAadAdminInfo' in: body name: aadAdminInfo required: true responses: '200': description: '' schema: $ref: '#/definitions/WorkspaceAadAdminInfo' '202': description: '' schema: $ref: '#/definitions/WorkspaceAadAdminInfo' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' 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: Create or update workspace active directory admin: $ref: ./examples/CreateOrUpdateWorkspaceAadAdmin.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Administrators Activedirectory delete: operationId: microsoftAzureWorkspaceaadadminsDelete description: Deletes a workspace active directory admin tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' responses: '200': description: '' '202': description: '' '204': description: Accepted default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Delete workspace active directory admin: $ref: ./examples/DeleteWorkspaceAadAdmin.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Administrators Activedirectory ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory : get: operationId: microsoftAzureWorkspacesqlaadadminsGet description: Gets a workspace SQL active directory admin tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' responses: '200': schema: $ref: '#/definitions/WorkspaceAadAdminInfo' description: OK default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-examples: Get workspace active directory admin: $ref: ./examples/GetWorkspaceAadAdmin.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Sqladministrators Activedirectory put: operationId: microsoftAzureWorkspacesqlaadadminsCreateorupdate description: Creates or updates a workspace SQL active directory admin tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' - description: Workspace active directory administrator properties schema: $ref: '#/definitions/WorkspaceAadAdminInfo' in: body name: aadAdminInfo required: true responses: '200': description: '' schema: $ref: '#/definitions/WorkspaceAadAdminInfo' '202': description: '' schema: $ref: '#/definitions/WorkspaceAadAdminInfo' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' 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: Create or update workspace active directory admin: $ref: ./examples/CreateOrUpdateWorkspaceAadAdmin.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Sqladministrators Activedirectory delete: operationId: microsoftAzureWorkspacesqlaadadminsDelete description: Deletes a workspace SQL active directory admin tags: - Workspaces deprecated: false parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/workspaceNameParameter' responses: '200': description: '' '202': description: '' '204': description: Accepted default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: '' consumes: [] produces: - application/json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Delete workspace active directory admin: $ref: ./examples/DeleteWorkspaceAadAdmin.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Sqladministrators Activedirectory definitions: ApiSpecification: type: object description: API specification properties: name: type: string description: API specification name, e.g. 'swagger' or 'openapi'. version: type: string description: API specification version, e.g. '3.0.1'. required: - name - version ComplianceStandardDefinition: description: Compliance standard that can be associated with a workspace. type: string enum: - NONE - HIPAA - PCI_DSS x-ms-enum: modelAsString: true name: ComplianceStandard errorResponse: title: Error details. description: Contains details when the response code indicates an error. type: object properties: error: description: The error details. $ref: '#/definitions/errorInfo' required: - error IndicatorValidationError: description: Object that stores a list of errors encountered when executing the Upload Indicators operation. type: object properties: recordIndex: format: int64 description: Index of the indicator in indicators array from request. type: integer validationErrorMessages: description: List of validation errors for a single indicator. type: array items: type: string ErrorDetail: description: This is the top-level error object whose code matches the x-ms-error-code response header properties: code: description: This is one of a server-defined set of error codes. type: string details: description: This is an array of details about specific errors that led to this reported error. items: $ref: '#/definitions/ErrorDetail' type: array innererror: $ref: '#/definitions/InnerError' message: description: This is a human-readable representation of the error. type: string target: description: This is the error target. type: string required: - code - message type: object PurviewConfiguration: description: Purview Configuration type: object properties: purviewResourceId: description: Purview Resource ID type: string WorkspaceUpdateParameters: 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 ProvisioningState_2: description: Provisioning status of the workspace. readOnly: true enum: - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Updating type: string x-ms-enum: name: ProvisioningState modelAsString: true metadataQuery: title: A stored query. description: Queries are stored pieces of KQL, along with a list of relevant metadata items. type: object properties: id: description: The ID of the query. type: string displayName: description: The display name of the query. type: string description: description: The description of the query. type: string body: description: The KQL body of the query. type: string labels: description: The user defined labels associated with the query. type: array items: type: string tags: description: The tags associated with the query. $ref: '#/definitions/tags' properties: description: The properties of the query. type: object related: description: The related metadata items for the query. type: object properties: categories: description: The related categories for the query. type: array items: type: string solutions: description: The related Log Analytics solutions for the query. type: array items: type: string resourceTypes: description: The related resource types for the query. type: array items: type: string tables: description: The related tables for the query. type: array items: type: string required: - id - body Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message WorkspaceProperties_6: type: object description: The properties of a machine learning team account workspace. required: - friendlyName properties: description: description: The description of this workspace. type: string accountId: description: The immutable id of the team account which contains this workspace. type: string readOnly: true workspaceId: description: The immutable id of this workspace. type: string readOnly: true friendlyName: description: The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created type: string creationDate: format: date-time description: The creation date of the machine learning workspace in ISO8601 format. type: string readOnly: true provisioningState: type: string enum: - Creating - Succeeded - Updating - Deleting - Failed x-ms-enum: name: ProvisioningState modelAsString: false readOnly: true description: The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning. workspacesParam: description: Workspace names to include in cross-workspace queries. type: array items: type: string Workspace_6: type: object description: An object that represents a machine learning team account workspace. allOf: - $ref: '#/definitions/Resource_3' properties: properties: $ref: '#/definitions/WorkspaceProperties_6' description: The properties of the machine learning team account workspace. x-ms-client-flatten: true Environment: type: object description: Environment resource model. properties: name: type: string description: Environment identifier. maxLength: 50 title: type: string description: The name of the environment. maxLength: 50 kind: $ref: '#/definitions/EnvironmentKind' description: Kind of deployment environment. description: type: string description: Description of the environment. maxLength: 1000 server: $ref: '#/definitions/EnvironmentServer' description: Server information of the environment. onboarding: $ref: '#/definitions/EnvironmentOnboardingModel' description: Onboarding information for this environment. customProperties: type: object description: The custom metadata defined for environment entities. required: - name - title - kind Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error 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 WorkspaceResource: type: object description: Workspace details. properties: properties: description: Workspace properties. $ref: '#/definitions/WorkspaceResourceProperties' x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource x-ms-azure-resource: true WorkspaceUpdateParameters_3: description: The parameters for updating a machine learning team account workspace. properties: tags: description: The resource tags for the machine learning team account workspace. type: object additionalProperties: type: string properties: $ref: '#/definitions/WorkspacePropertiesUpdateParameters_3' description: The properties that the machine learning workspace will be updated with. x-ms-client-flatten: true ListAmlUserFeatureResult: type: object properties: value: readOnly: true type: array items: $ref: '#/definitions/AmlUserFeature' description: The list of AML user facing features. nextLink: readOnly: true type: string description: The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information. description: The List Aml user feature operation response. Contact: type: object description: API contact information properties: name: type: string description: Name of the contact. maxLength: 100 url: type: string format: uri description: URL for the contact. email: type: string description: Email address for the contact. maxLength: 100 required: - name metadataFunction: title: A stored function. description: Functions are stored Kusto queries that can be specified as part of queries by using their name. type: object properties: id: description: The ID of the function. type: string name: description: The name of the function, to be used in queries. type: string parameters: description: The parameters/arguments of the function, if any. type: string displayName: description: The display name of the function. type: string description: description: The description of the function. type: string body: description: The KQL body of the function. type: string tags: description: The tags associated with the function. $ref: '#/definitions/tags' properties: description: The properties of the function. type: object related: description: The related metadata items for the function. type: object properties: tables: description: The related tables for the function. type: array items: type: string solutions: description: The related Log Analytics solutions for the function. type: array items: type: string resourceTypes: description: The related resource types for the function. type: array items: type: string categories: description: The related categories for the function. type: array items: type: string workspaces: description: The related workspaces for the function. type: array items: type: string required: - id - name - body ComputeRuntimeDto: type: object properties: sparkRuntimeVersion: type: string column: title: A table column. description: A column in a table. type: object properties: name: description: The name of this column. type: string type: description: The data type of this column. $ref: '#/definitions/logsColumnType' PublicNetworkAccessType: description: The public network access flag. enum: - Enabled - Disabled type: string x-ms-enum: name: PublicNetworkAccessType modelAsString: true VirtualNetworkProfile: description: Virtual Network Profile type: object properties: computeSubnetId: description: Subnet ID used for computes in workspace type: string WorkspacePrivateEndpointResource: description: The Private Endpoint resource. 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 PrivateEndpointConnection: description: The Private Endpoint Connection 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: 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 logsColumnType: type: string description: The data type of this column. enum: - bool - datetime - dynamic - int - long - real - string - guid - decimal - timespan x-ms-enum: name: logsColumnType modelAsString: true 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 PrivateLinkServiceConnectionState_2: description: The current state of a private endpoint connection type: object properties: status: description: The status of a private endpoint connection enum: - Pending - Approved - Rejected - Disconnected type: string x-ms-enum: name: PrivateLinkServiceConnectionStatus modelAsString: true description: type: string description: The description for the current state of a private endpoint connection actionsRequired: type: string description: Actions required for a private endpoint connection required: - status ApiDeployment: type: object description: API deployment resource model. properties: name: type: string description: Deployment identifier. maxLength: 50 title: type: string description: The name of the deployment. maxLength: 50 description: type: string description: The description of the deployment. maxLength: 1000 environment: type: string description: The name of the deployment environment. server: $ref: '#/definitions/ApiDeploymentServer' description: The server information of the API deployment. customProperties: type: object description: The custom metadata defined for API deployment entities. recommended: type: boolean description: Indicates if this is currently recommended deployment. required: - name - title - environment - server Error: type: object properties: code: type: string message: type: string target: type: string details: type: array items: $ref: '#/definitions/ErrorDetail_3' x-ms-identifiers: - code ErrorResponseBody: description: The definition of an error object. required: - error type: object properties: error: $ref: '#/definitions/ErrorData' PrivateEndpointConnectionProperties_2: description: The properties of a private endpoint connection type: object properties: privateEndpoint: title: Private endpoint description: Private endpoint $ref: '#/definitions/PrivateEndpoint' groupIds: type: array description: GroupIds from the private link service resource. items: type: string privateLinkServiceConnectionState: title: Private link service service connection state description: Private endpoint connection state $ref: '#/definitions/PrivateLinkServiceConnectionState_2' provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProvisioningState_2' description: Provisioning state of the private endpoint connection. required: - privateLinkServiceConnectionState table: title: A query response table. description: Contains the columns and rows for one table in a query response. type: object properties: name: description: The name of the table. type: string columns: description: The list of columns in this table. type: array items: $ref: '#/definitions/column' rows: description: The resulting rows from this query. type: array items: type: array items: type: object required: - name - columns - rows EnvironmentServer: type: object description: Environment Server properties: type: type: string description: Type of the server that represents the environment. managementPortalUris: type: array description: URIs of the server's management portal. items: type: string format: uri required: - type - managementPortalUris AadAdminProperties: description: Workspace active directory administrator properties type: object properties: tenantId: description: Tenant ID of the workspace active directory administrator type: string login: description: Login of the workspace active directory administrator type: string administratorType: description: Workspace active directory administrator type type: string sid: description: Object ID of the workspace active directory administrator type: string 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 ExternalDocumentation: type: object description: Api External Documentation Model properties: title: type: string description: Title of the documentation. maxLength: 50 description: type: string description: Description of the documentation. maxLength: 1000 url: type: string format: uri description: URL pointing to the documentation. required: - title - description - url Workspace_2: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkspaceProperties_2' description: The workspace properties. sku: $ref: '#/definitions/Sku' description: The SKU of the resource. systemData: description: The system metadata relating to this resource type: object readOnly: true $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData required: - properties allOf: - $ref: '#/definitions/TrackedResource' description: Information about workspace. metadataCategory: title: A metadata category. description: Categories are used to group other metadata entities. type: object properties: id: description: The ID of the category type: string displayName: description: The display name of the category type: string description: description: The description of the category type: string related: description: The related metadata items for the category type: object properties: tables: description: The tables related to the category type: array items: type: string functions: description: The functions related to the category type: array items: type: string resourceTypes: description: The resource types related to the category type: array items: type: string queries: description: The saved queries related to the category type: array items: type: string solutions: description: The Log Analytics solutions related to the category type: array items: type: string required: - id - displayName ErrorData: description: Detailed information about the errors from the operation. type: object required: - code - message properties: code: description: Server defined code for the error type: string message: description: Error message type: string WorkspaceListResult_3: description: The result of a request to list machine learning workspace keys. 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_5' nextLink: description: The URI that can be used to request the next list of machine learning workspaces. type: string PrivateEndpoint: description: The private endpoint property of a private endpoint connection type: object properties: id: readOnly: true type: string description: The resource identifier. Workspace: description: An object that represents a machine learning 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 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 WorkspaceHubConfig: description: WorkspaceHub's configuration object. type: object properties: additionalWorkspaceStorageAccounts: type: array items: type: string defaultWorkspaceResourceGroup: type: string ServerlessComputeSettings: type: object properties: serverlessComputeCustomSubnet: description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed type: string format: arm-id serverlessComputeNoPublicIP: description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint type: boolean WorkspaceList: type: object description: Return a list of firmware analysis workspaces. properties: value: type: array readOnly: true items: $ref: '#/definitions/Workspace_3' description: The list of firmware analysis workspaces. nextLink: type: string description: The uri to fetch the next page of asset. queryParam: description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) type: string WorkspaceKeyDetails: description: Details of the customer managed key associated with the workspace type: object properties: name: description: Workspace Key sub-resource name type: string keyVaultUrl: description: Workspace Key sub-resource key vault url type: string WorkspaceCustomObjectParameter: properties: type: $ref: '#/definitions/WorkspaceCustomParameterType' description: The type of variable that this is value: type: object description: The value which should be used for this field. required: - value description: The value which should be used for this field. queryResults: title: A query response. description: Contains the tables, columns & rows resulting from a query. type: object properties: tables: description: The list of tables, columns and rows. type: array items: $ref: '#/definitions/table' statistics: type: object description: Statistics represented in JSON format. properties: {} render: type: object description: Visualization data in JSON format. properties: {} error: $ref: '#/definitions/errorInfo' required: - tables metadataResults: title: A metadata response. description: The metadata response for the app, including available tables, etc. type: object properties: categories: description: The list of categories that are referenced in this metadata response. type: array items: $ref: '#/definitions/metadataCategory' uniqueItems: true resourceTypes: description: The list of resource types that are referenced in this metadata response. type: array items: $ref: '#/definitions/metadataResourceType' uniqueItems: true solutions: description: The list of Log Analytics solutions installed on the workspace. type: array items: $ref: '#/definitions/metadataSolution' uniqueItems: true tables: description: The list of tables and columns that comprise the schema of the workspace. type: array items: $ref: '#/definitions/metadataTable' uniqueItems: true functions: description: The list of functions stored on the workspace, or introduced by solutions etc. type: array items: $ref: '#/definitions/metadataFunction' uniqueItems: true queries: description: The list of saved queries stored on the workspace, or introduced by solutions, resource types, etc. type: array items: $ref: '#/definitions/metadataQuery' uniqueItems: true applications: description: The list of Application Insights apps that were referenced in the metadata request. type: array items: $ref: '#/definitions/metadataApplication' uniqueItems: true workspaces: description: The list of Log Analytics workspaces that were referenced in the metadata request. type: array items: $ref: '#/definitions/metadataWorkspace' uniqueItems: true resources: description: The list of Azure resources that were referenced in the metadata request. type: array items: $ref: '#/definitions/metadataResource' uniqueItems: true permissions: description: The list of permission rules that affected the metadata request. type: array items: $ref: '#/definitions/metadataPermissions' uniqueItems: true PrivateEndpointConnectionProperties: description: Private endpoint connection properties. type: object properties: privateEndpoint: $ref: '#/definitions/WorkspacePrivateEndpointResource' privateLinkServiceConnectionState: description: The connection state. $ref: '#/definitions/PrivateLinkServiceConnectionState' provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProvisioningState' WorkspaceInfoListResult: description: List of workspaces type: object properties: nextLink: description: Link to the next page of results type: string value: description: List of workspaces type: array items: $ref: '#/definitions/Workspace_8' errorInfo: title: The code and message for an error. type: object properties: code: description: A machine readable error code. type: string message: description: A human readable error message. type: string details: description: error details. type: array items: $ref: '#/definitions/errorDetail' innererror: description: Inner error details if they exist. $ref: '#/definitions/errorInfo' additionalProperties: description: Additional properties that can be provided on the error info object type: object required: - code - message 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 enableSoftwareBillOfMaterials: description: Flag to tell if SoftwareBillOfMaterial should be enabled for this workspace 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 ipAllowlist: description: The list of IPv4 addresses that are allowed to access the workspace. type: array items: type: string managedNetwork: $ref: '#/definitions/ManagedNetworkSettings' primaryUserAssignedIdentity: description: The user assigned identity resource id that represents the workspace identity. type: string publicNetworkAccess: description: Whether requests from Public Network are allowed. $ref: '#/definitions/PublicNetworkAccessType' serverlessComputeSettings: description: Settings for serverless compute in a workspace $ref: '#/definitions/ServerlessComputeSettings' 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 ManagedNetworkStatus: description: Status for the managed network of a machine learning workspace. enum: - Inactive - Active type: string x-ms-enum: name: ManagedNetworkStatus modelAsString: true metadataApplication: title: An Application Insights application. description: Application Insights apps that were part of the metadata request and that the user has access to. type: object properties: id: description: The ID of the Application Insights app. type: string resourceId: description: The ARM resource ID of the Application Insights app. type: string name: description: The name of the Application Insights app. type: string region: description: The Azure region of the Application Insights app. type: string related: description: The related metadata items for the Application Insights app. type: object properties: tables: description: The related tables for the Application Insights app. type: array items: type: string functions: description: The related functions for the Application Insights app. type: array items: type: string required: - id - resourceId - name - region 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 enableSoftwareBillOfMaterials: description: Flag to tell if SoftwareBillOfMaterial should be enabled for this workspace 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 ipAllowlist: description: The list of IPv4 addresses that are allowed to access the workspace. 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 keyVaults: type: array items: type: string managedNetwork: $ref: '#/definitions/ManagedNetworkSettings' mlFlowTrackingUri: description: The URI associated with this workspace that machine learning flow must point at to set up tracking. type: string readOnly: true x-ms-mutability: - read notebookInfo: description: The notebook info of Azure ML workspace. $ref: '#/definitions/NotebookResourceInfo' readOnly: true x-ms-mutability: - read primaryUserAssignedIdentity: description: The user assigned identity resource id that represents the workspace identity. type: string 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' serverlessComputeSettings: description: Settings for serverless compute in a workspace $ref: '#/definitions/ServerlessComputeSettings' 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: description: WorkspaceHub's configuration object. $ref: '#/definitions/WorkspaceHubConfig' workspaceId: description: The immutable id associated with this workspace. type: string readOnly: true x-ms-mutability: - read CustomerManagedKeyDetails: description: Details of the customer managed key associated with the workspace type: object properties: status: description: The customer managed key status on the workspace type: string readOnly: true key: description: The key object of the workspace $ref: '#/definitions/WorkspaceKeyDetails' tags: description: String-based key-value tags type: object 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 EncryptionV2: properties: keySource: type: string description: 'The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault' enum: - Microsoft.Keyvault x-ms-enum: name: EncryptionKeySource modelAsString: true keyVaultProperties: properties: keyVaultUri: type: string description: The Uri of KeyVault. keyName: type: string description: The name of KeyVault key. keyVersion: type: string description: The version of KeyVault key. required: - keyVaultUri - keyName - keyVersion description: Key Vault input properties for encryption. required: - keySource description: The object that contains details of encryption used on the workspace. IsolationMode: description: Isolation mode for the managed network of a machine learning workspace. enum: - Disabled - AllowInternetOutbound - AllowOnlyApprovedOutbound type: string x-ms-enum: name: IsolationMode modelAsString: true Encryption: properties: keySource: type: string description: 'The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault' enum: - Default - Microsoft.Keyvault x-ms-enum: name: KeySource modelAsString: true default: Default KeyName: type: string description: The name of KeyVault key. keyversion: type: string description: The version of KeyVault key. x-ms-client-name: KeyVersion keyvaulturi: type: string description: The Uri of KeyVault. x-ms-client-name: KeyVaultUri description: The object that contains details of encryption used on the workspace. WorkspaceUpdate: description: An update to a workspace. type: object properties: tags: description: Resource tags. type: object additionalProperties: type: string WorkspaceList_3: type: object properties: value: type: array items: $ref: '#/definitions/Workspace_7' Workspace_7: type: object properties: id: description: Workspace id type: string name: description: Workspace name type: string type: description: Resource type type: string properties: description: Property bag type: object WorkspaceResourceProperties: description: Workspace properties. type: object properties: dataPlaneEndpoint: description: Data plane endpoint. type: string readOnly: true allOf: - $ref: '#/definitions/ResourceBaseProperties' Resource_3: description: An Azure resource. required: - location properties: id: description: The resource ID. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. This cannot be changed after the resource is created. type: string tags: description: The tags of the resource. type: object additionalProperties: type: string x-ms-azure-resource: true PagedApiDeployment: type: object description: Paged collection of ApiDeployment items properties: value: type: array description: The ApiDeployment items on this page items: $ref: '#/definitions/ApiDeployment' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value IdentityForCmk: description: Identity object used for encryption. type: object properties: userAssignedIdentity: description: UserAssignedIdentity to be used to fetch the encryption key from keyVault type: string metadataPermissions: title: Permission information. description: Permission information for the metadata call, includes apps/workspaces/resource the user didn't have access to. type: object properties: workspaces: description: The permission indication for the workspaces on the metadata request. type: array items: type: object properties: resourceId: description: The resource ID on the permission indication. type: string denyTables: description: The list of tables that were denied access for the resource ID. type: array items: type: string required: - resourceId resources: description: The permission indication for the Azure resources on the metadata request. type: array items: type: object properties: resourceId: description: The resource ID on the permission indication. type: string denyTables: description: The list of tables that were denied access for the resource ID. type: array items: type: string required: - resourceId applications: description: The permission indication for the Application Insights apps on the metadata request. type: array items: type: object properties: resourceId: description: The resource ID on the permission indication. type: string required: - resourceId required: - workspaces ErrorResponse: properties: error: $ref: '#/definitions/ErrorDetail' required: - error type: object FeatureStoreSettings: type: object properties: computeRuntime: $ref: '#/definitions/ComputeRuntimeDto' offlineStoreConnectionName: type: string onlineStoreConnectionName: type: string ApiSpecExportResultFormat: type: string description: Export specification result format enum: - link x-ms-enum: name: ApiSpecExportResultFormat modelAsString: true values: - name: Link value: link description: Link format WorkspacePropertiesUpdateParameters_2: description: The parameters for updating the properties of a machine learning workspace. properties: workspaceState: type: string enum: - Deleted - Enabled - Disabled - Migrated - Updated - Registered - Unregistered x-ms-enum: name: WorkspaceState modelAsString: false description: The current state of workspace resource. keyVaultIdentifierId: description: The key vault identifier used for encrypted workspaces. type: string sku: $ref: '#/definitions/Sku_2' description: The sku of the workspace. ResourceBaseProperties: description: Resource base properties. type: object properties: provisioningState: description: Resource provisioning state. $ref: '#/definitions/ResourceState' readOnly: true metadataWorkspace: title: A Log Analytics workspace. description: Log Analytics workspaces that were part of the metadata request and that the user has access to. type: object properties: id: description: The ID of the Log Analytics workspace. type: string resourceId: description: The ARM resource ID of the Log Analytics workspace. type: string name: description: The name of the Log Analytics workspace. type: string region: description: The Azure region of the Log Analytics workspace. type: string related: description: The related metadata items for the Log Analytics workspace. type: object properties: tables: description: The related tables for the Log Analytics workspace. type: array items: type: string solutions: description: The related Log Analytics solutions for the Log Analytics workspace. type: array items: type: string resourceTypes: description: The related resource types for the Log Analytics workspace. type: array items: type: string functions: description: The related functions for the Log Analytics workspace. type: array items: type: string resources: description: The related Azure resources for the Log Analytics workspace. type: array items: type: string required: - id - resourceId - name - region ResourceState: description: Resources provisioning states. enum: - NotSpecified - Accepted - Creating - Succeeded - Failed - Canceled - ProvisioningResources - InstallingApplication - ConfiguringApplication - MigratingApplicationData - RunningValidations - CreatingArtifacts - DeletingArtifacts type: string x-ms-enum: name: ResourceState modelAsString: true WorkspacePropertiesUpdateParameters_3: description: The parameters for updating the properties of a machine learning team account workspace. properties: friendlyName: description: Friendly name of this workspace. type: string description: description: Description for this workspace. type: string metadataTable: title: A data table that takes part in a workspace schema. description: Tables are part of the workspace schema, and contain a list of columns and a reference to other relevant metadata items. type: object properties: id: description: The ID of the table type: string name: description: The name of the table type: string description: description: The description of the table type: string timespanColumn: description: The column associated with the timespan query parameter for the table type: string labels: description: The user defined labels of the table type: array items: type: string tags: description: The tags associated with the table $ref: '#/definitions/tags' properties: description: The properties of the table type: object columns: description: The list of columns defined on the table type: array items: properties: name: description: The name of the column type: string description: description: The description of the column type: string type: description: The data type of the column type: string enum: - bool - datetime - dynamic - int - long - real - string - guid - decimal - timespan x-ms-enum: name: MetadataColumnDataType modelAsString: true isPreferredFacet: description: A flag indicating this column is a preferred facet type: boolean source: description: an indication of the source of the column, used only when multiple workspaces have conflicting definition for the column type: object required: - name - type related: description: The related metadata items for the table type: object properties: categories: description: The related categories for the table type: array items: type: string solutions: description: The related Log Analytics solutions for the table type: array items: type: string resourceTypes: description: The related resource types for the table type: array items: type: string workspaces: description: The related Log Analytics workspaces for the table type: array items: type: string functions: description: The related functions for the table type: array items: type: string queries: description: The related saved queries for the table type: array items: type: string required: - id - name PrivateEndpointConnection_2: description: The private endpoint connection of a workspace x-ms-azure-resource: true type: object properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: The resource name. type: readOnly: true type: string description: The resource type. properties: type: object description: The private endpoint connection properties. x-ms-client-flatten: false $ref: '#/definitions/PrivateEndpointConnectionProperties_2' required: - properties WorkspaceRepositoryConfiguration: description: Git integration settings type: object properties: type: description: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration type: string hostName: description: 'GitHub Enterprise host name. For example: `https://github.mydomain.com`' type: string accountName: description: Account name type: string projectName: description: VSTS project name type: string repositoryName: description: Repository name type: string collaborationBranch: description: Collaboration branch type: string rootFolder: description: Root folder to use in the repository type: string lastCommitId: description: The last commit ID type: string tenantId: description: The VSTS tenant ID type: string format: uuid DefaultCatalogProperties: type: object properties: initialType: type: string description: 'Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog' enum: - HiveMetastore - UnityCatalog x-ms-enum: name: initialType modelAsString: true default: HiveMetastore initialName: type: string description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. description: These properties lets user specify default catalog properties during workspace creation. Api: type: object description: API resource model. properties: name: type: string description: Api identifier. maxLength: 50 title: type: string description: The name of the API. maxLength: 50 summary: type: string description: Short description of the API. maxLength: 200 description: type: string description: The description of the API maxLength: 1000 kind: $ref: '#/definitions/ApiKind' description: Kind of API. For example, REST or GraphQL. lifecycleStage: $ref: '#/definitions/LifecycleStage' description: Current lifecycle stage of the API. readOnly: true termsOfService: $ref: '#/definitions/TermsOfService' description: Terms of service for the API. license: $ref: '#/definitions/License' description: The license information for the API. externalDocumentation: type: array description: External documentation items: $ref: '#/definitions/ExternalDocumentation' x-ms-identifiers: [] contacts: type: array description: Points of contact for the API. items: $ref: '#/definitions/Contact' x-ms-identifiers: [] customProperties: type: object description: The custom metadata defined for API entities. lastUpdated: type: string format: date-time description: Last updated date and time. readOnly: true required: - name - title - kind ManagedNetworkSettings: description: Managed Network settings for a machine learning workspace. type: object properties: isolationMode: description: Isolation mode for the managed network of a machine learning workspace. $ref: '#/definitions/IsolationMode' networkId: type: string readOnly: true outboundRules: type: object additionalProperties: description: Outbound Rule for the managed network of a machine learning workspace. $ref: '#/definitions/OutboundRule' x-nullable: true status: description: Status of the Provisioning for the managed network of a machine learning workspace. $ref: '#/definitions/ManagedNetworkProvisionStatus' changeableIsolationModes: type: array items: $ref: '#/definitions/IsolationMode' readOnly: true metadataSolution: title: A Log Analytics solution. description: Solutions can group tables and functions that are associated with a certain Azure Log Analytics offering. type: object properties: id: description: The ID of the Log Analytics solution type: string name: description: The name of the Log Analytics solution type: string displayName: description: The display name of the Log Analytics solution type: string description: description: The description of the Log Analytics solution type: string tags: description: The tags that are associated with the Log Analytics solution $ref: '#/definitions/tags' properties: description: The properties of the Log Analytics solution type: object related: description: The related metadata items for the Log Analytics solution type: object properties: tables: description: The tables related to the Log Analytics solution type: array items: type: string functions: description: The functions related to the Log Analytics solution type: array items: type: string categories: description: The categories related to the Log Analytics solution type: array items: type: string queries: description: The saved queries related to the Log Analytics solution type: array items: type: string workspaces: description: The Workspaces referenced in the metadata request that are related to the Log Analytics solution type: array items: type: string required: - tables required: - id - name - related ErrorDetail_2: title: Error details. type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string target: description: Indicates which property in the request is responsible for the error. type: string required: - code - message EncryptionKeyVaultUpdateProperties: required: - keyIdentifier type: object properties: keyIdentifier: minLength: 1 pattern: '[a-zA-Z0-9_]' type: string ErrorInfo: title: The code and message for an error. type: object properties: code: description: A machine readable error code. type: string message: description: A human readable error message. type: string details: description: error details. type: array items: $ref: '#/definitions/ErrorDetail_2' innererror: description: Inner error details if they exist. type: string required: - code - message CreatedBy: properties: oid: type: string format: uuid description: The Object ID that created the workspace. readOnly: true puid: type: string description: The Personal Object ID corresponding to the object ID above readOnly: true applicationId: type: string format: uuid description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. readOnly: true description: Provides details of the entity that created/updated the workspace. WorkspacePatchProperties: description: Workspace patch properties type: object properties: sqlAdministratorLoginPassword: description: SQL administrator login password type: string managedVirtualNetworkSettings: description: Managed Virtual Network Settings $ref: '#/definitions/ManagedVirtualNetworkSettings' workspaceRepositoryConfiguration: description: Git integration settings $ref: '#/definitions/WorkspaceRepositoryConfiguration' purviewConfiguration: description: Purview Configuration $ref: '#/definitions/PurviewConfiguration' provisioningState: description: Resource provisioning state type: string readOnly: true encryption: description: The encryption details of the workspace $ref: '#/definitions/EncryptionDetails' publicNetworkAccess: enum: - Enabled - Disabled description: Enable or Disable public network access to workspace type: string x-ms-enum: name: WorkspacePublicNetworkAccess modelAsString: true OutboundRule: description: Outbound Rule for the managed network of a machine learning workspace. required: - type type: object properties: category: description: Category of a managed network Outbound Rule of a machine learning workspace. $ref: '#/definitions/RuleCategory' status: description: Type of a managed network Outbound Rule of a machine learning workspace. $ref: '#/definitions/RuleStatus' type: description: Type of a managed network Outbound Rule of a machine learning workspace. $ref: '#/definitions/RuleType' discriminator: type EnvironmentKind: type: string description: Environment kind enum: - development - testing - staging - production x-ms-enum: name: EnvironmentKind modelAsString: true values: - name: Development value: development description: Environment is in the development stage - name: Testing value: testing description: Environment is in the testing stage - name: Staging value: staging description: Environment is in the staging stage - name: Production value: production description: Environment is in the production stage ApiVersion: type: object description: API version resource model. properties: name: type: string description: Version identifier. maxLength: 50 title: type: string description: Version title. lifecycleStage: $ref: '#/definitions/LifecycleStage' description: Current lifecycle stage of the API version. required: - name - title - lifecycleStage 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 UploadIndicatorsRequest: description: Schema for request body. type: object properties: sourcesystem: description: Source of the indicators to be uploaded. Source system name cannot be Microsoft Sentinel. type: string indicators: description: The indicators param is an array of STIX indictors. Indicators need to be in STIX format (STIX Indicator documentation). Indicators need to contain the “ID” field. We only support Stix 2.0 and 2.1 format. type: array items: $ref: '#/definitions/JsonPropertyBag' timespanParam: description: Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression. type: string Workspace_5: type: object description: An object that represents a machine learning workspace. allOf: - $ref: '#/definitions/Resource_2' properties: properties: $ref: '#/definitions/WorkspaceProperties_5' description: The properties of the machine learning workspace. x-ms-client-flatten: true AmlUserFeature: description: Features enabled for a workspace type: object properties: id: description: Specifies the feature ID type: string displayName: description: 'Specifies the feature name ' type: string description: description: Describes the feature for user experience type: string WorkspaceResponse: properties: displayName: type: string id: type: string mode: $ref: '#/definitions/WorkspaceMode' name: type: string type: object 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' SharedPrivateLinkResource: type: object properties: name: description: Unique name of the private link type: string properties: description: Properties of a shared private link resource. $ref: '#/definitions/SharedPrivateLinkResourceProperty' x-ms-client-flatten: true WorkspaceAadAdminInfo: description: Workspace active directory administrator type: object x-ms-azure-resource: true allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource properties: properties: description: Workspace active directory administrator properties $ref: '#/definitions/AadAdminProperties' x-ms-client-flatten: true JsonPropertyBag: description: An object that stores a list of JSON properties from a given JObject. type: object PagedEnvironment: type: object description: Paged collection of Environment items properties: value: type: array description: The Environment items on this page items: $ref: '#/definitions/Environment' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value Resource: description: The core properties of ARM resources properties: id: readOnly: true type: string description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} name: readOnly: true type: string description: The name of the resource type: readOnly: true type: string description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. x-ms-azure-resource: true CosmosDbSettings: type: object properties: collectionsThroughput: format: int32 type: integer NotebookPreparationError: type: object properties: errorMessage: type: string statusCode: format: int32 type: integer WorkspaceCustomParameters: properties: amlWorkspaceId: $ref: '#/definitions/WorkspaceCustomStringParameter' description: The ID of a Azure Machine Learning workspace to link with Databricks workspace customVirtualNetworkId: $ref: '#/definitions/WorkspaceCustomStringParameter' description: The ID of a Virtual Network where this Databricks Cluster should be created customPublicSubnetName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: The name of a Public Subnet within the Virtual Network customPrivateSubnetName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: The name of the Private Subnet within the Virtual Network enableNoPublicIp: $ref: '#/definitions/WorkspaceCustomBooleanParameter' description: Should the Public IP be Disabled? loadBalancerBackendPoolName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). loadBalancerId: $ref: '#/definitions/WorkspaceCustomStringParameter' description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. natGatewayName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. publicIpName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: Name of the Public IP for No Public IP workspace with managed vNet. prepareEncryption: $ref: '#/definitions/WorkspaceCustomBooleanParameter' description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. encryption: $ref: '#/definitions/WorkspaceEncryptionParameter' description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. requireInfrastructureEncryption: $ref: '#/definitions/WorkspaceCustomBooleanParameter' description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. storageAccountName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: Default DBFS storage account name. storageAccountSkuName: $ref: '#/definitions/WorkspaceCustomStringParameter' description: 'Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs.' vnetAddressPrefix: $ref: '#/definitions/WorkspaceCustomStringParameter' description: Address prefix for Managed virtual network. Default value for this input is 10.139. resourceTags: $ref: '#/definitions/WorkspaceCustomObjectParameter' readOnly: true description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. description: Custom Parameters used for Cluster Creation. WorkspaceProperties_5: type: object description: The properties of a machine learning workspace. required: - userStorageAccountId - ownerEmail properties: userStorageAccountId: description: The fully qualified arm id of the storage account associated with this workspace. type: string ownerEmail: description: The email id of the owner for this workspace. type: string workspaceType: type: string enum: - Production - Free - Anonymous - PaidStandard - PaidPremium x-ms-enum: name: WorkspaceType modelAsString: false readOnly: true description: The type of this workspace. workspaceState: type: string enum: - Deleted - Enabled - Disabled - Migrated - Updated - Registered - Unregistered x-ms-enum: name: WorkspaceState modelAsString: false readOnly: true description: The current state of workspace resource. workspaceId: description: The immutable id associated with this workspace. type: string readOnly: true creationTime: description: The creation time for this workspace resource. type: string readOnly: true studioEndpoint: description: The regional endpoint for the machine learning studio service which hosts this workspace. type: string readOnly: true keyVaultIdentifierId: description: The key vault identifier used for encrypted workspaces. type: string PagedApi: type: object description: Paged collection of Api items properties: value: type: array description: The Api items on this page items: $ref: '#/definitions/Api' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value metadataResourceType: title: A type of resource in Azure. description: Metadata about types of Azure resources, containing relevant tables, functions, etc. type: object properties: id: description: The ID of the resource-type type: string type: description: The type of the resource-type type: string displayName: description: The display name of the resource-type type: string description: description: The description of the resource-type type: string labels: description: The user-defined labels of the resource-type type: array items: type: string tags: description: The tags associated with the resource-type $ref: '#/definitions/tags' properties: description: The properties of the resource-type type: object related: description: The related metadata items for the resource-type type: object properties: tables: description: The tables related to the resource-type type: array items: type: string functions: description: The functions related to the resource-type type: array items: type: string categories: description: The categories related to the resource-type type: array items: type: string queries: description: The queries related to the resource-type type: array items: type: string workspaces: description: The Log Analytics workspaces related to the resource-type type: array items: type: string resources: description: The Azure resources related to the resource-type type: array items: type: string required: - id - type WorkspacePatchResource: type: object description: Workspace patch properties. properties: tags: description: resource tags. type: object readOnly: false additionalProperties: type: string systemData: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData Azure.Core.Foundations.OperationState: type: string description: Enum describing allowed operation states. enum: - NotStarted - Running - Succeeded - Failed - Canceled x-ms-enum: name: OperationState modelAsString: true values: - name: NotStarted value: NotStarted description: The operation has not started. - name: Running value: Running description: The operation is in progress. - name: Succeeded value: Succeeded description: The operation has completed successfully. - name: Failed value: Failed description: The operation has failed. - name: Canceled value: Canceled description: The operation has been canceled by the user. queryBody: description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) type: object properties: query: description: The query to execute. $ref: '#/definitions/queryParam' timespan: description: Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression. $ref: '#/definitions/timespanParam' workspaces: description: A list of workspaces that are included in the query. $ref: '#/definitions/workspacesParam' required: - query SharedPrivateLinkResourceProperty: description: Properties of a shared private link resource. 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' Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. 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 errorDetail: title: Error details. type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string target: description: Indicates which property in the request is responsible for the error. type: string value: description: Indicates which value in 'target' is responsible for the error. type: string resources: description: Indicates resources which were responsible for the error. type: array items: type: string additionalProperties: description: Additional properties that can be provided on the error details object type: object required: - code - message ApiDefinition: type: object description: API definition resource model. properties: name: type: string description: Definition identifier. maxLength: 50 title: type: string description: The name of the API definition. maxLength: 50 description: type: string description: The description of the API definition. maxLength: 1000 specification: $ref: '#/definitions/ApiSpecification' description: The API specification details. required: - name - title ManagedIdentity: description: The workspace managed identity type: object properties: principalId: description: The principal ID of the workspace managed identity type: string readOnly: true tenantId: description: The tenant ID of the workspace managed identity type: string format: uuid readOnly: true type: description: The type of managed identity for the workspace enum: - None - SystemAssigned type: string x-ms-enum: name: ResourceIdentityType modelAsString: false WorkspaceCustomParameterType: description: Provisioning status of the workspace. readOnly: true enum: - Bool - Object - String type: string x-ms-enum: name: CustomParameterType modelAsString: true PrivateEndpointConnectionProvisioningState: description: The current provisioning state. enum: - Succeeded - Creating - Deleting - Failed type: string x-ms-enum: name: PrivateEndpointConnectionProvisioningState modelAsString: true ManagedNetworkProvisionStatus: description: Status of the Provisioning for the managed network of a machine learning workspace. type: object properties: sparkReady: type: boolean status: description: Status for the managed network of a machine learning workspace. $ref: '#/definitions/ManagedNetworkStatus' Resource_2: description: An Azure resource. required: - location properties: id: description: The resource ID. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. This cannot be changed after the resource is created. type: string tags: description: The tags of the resource. type: object additionalProperties: type: string sku: $ref: '#/definitions/Sku_2' description: The sku of the workspace. x-ms-azure-resource: true PagedApiDefinition: type: object description: Paged collection of ApiDefinition items properties: value: type: array description: The ApiDefinition items on this page items: $ref: '#/definitions/ApiDefinition' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value ApiKind: type: string description: API kind enum: - rest - graphql - grpc - soap - webhook - websocket x-ms-enum: name: ApiKind modelAsString: true values: - name: Rest value: rest description: REST API - name: Graphql value: graphql description: GraphQL API - name: Grpc value: grpc description: GRPC API - name: Soap value: soap description: SOAP API - name: Webhook value: webhook description: Webhook API - name: Websocket value: websocket description: Websocket API License: type: object description: API License Model properties: name: type: string description: Name of the license. maxLength: 50 url: type: string format: uri description: URL pointing to the license details. The URL field is mutually exclusive of the identifier field. identifier: type: string description: SPDX license information for the API. The identifier field is mutually exclusive of the URL field. maxLength: 200 required: - name AutomaticClusterUpdateDefinition: type: object description: Status of automated cluster updates feature. properties: value: type: string enum: - Enabled - Disabled x-ms-enum: modelAsString: true name: AutomaticClusterUpdateValue ErrorResponse_4: description: The error response send when an operation fails. properties: code: type: string description: error code message: type: string description: error message required: - code - message ApiSpecExportResult: type: object description: Export specification result model. properties: value: type: string description: The result of the specification export. format: $ref: '#/definitions/ApiSpecExportResultFormat' description: The format of the specification export result. required: - value - format WorkspaceCustomBooleanParameter: properties: type: $ref: '#/definitions/WorkspaceCustomParameterType' description: The type of variable that this is value: type: boolean description: The value which should be used for this field. required: - value description: The value which should be used for this field. WorkspaceMode: properties: freeTrial: type: boolean readOnly: type: boolean setup: type: boolean type: object metadataResource: title: An Azure resource. description: Azure resources that were part of the metadata request and that the user has access to. ErrorDetail_3: type: object properties: code: type: string message: type: string target: type: string GenerateUploadUrlRequest: type: object description: Properties for generating an upload URL properties: firmwareId: type: string description: A unique ID for the firmware to be uploaded. DataLakeStorageAccountDetails: description: Details of the data lake storage account associated with the workspace type: object properties: accountUrl: description: Account URL type: string filesystem: description: Filesystem name type: string WorkspaceCustomStringParameter: properties: type: $ref: '#/definitions/WorkspaceCustomParameterType' description: The type of variable that this is value: type: string description: The value which should be used for this field. required: - value description: The Value. WorkspaceProperties_2: properties: managedResourceGroupId: type: string description: The managed resource group Id. parameters: $ref: '#/definitions/WorkspaceCustomParameters' description: The workspace's custom parameters. provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState_2' description: The workspace provisioning state. uiDefinitionUri: type: string description: The blob URI where the UI definition file is located. authorizations: description: The workspace provider authorizations. type: array x-ms-identifiers: [] items: $ref: '#/definitions/WorkspaceProviderAuthorization' createdBy: description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. $ref: '#/definitions/CreatedBy' updatedBy: description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. $ref: '#/definitions/CreatedBy' createdDateTime: description: Specifies the date and time when the workspace is created. $ref: '#/definitions/CreatedDateTime' workspaceId: readOnly: true description: The unique identifier of the databricks workspace in databricks control plane. type: string workspaceUrl: readOnly: true description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' type: string storageAccountIdentity: description: The details of Managed Identity of Storage Account $ref: '#/definitions/ManagedIdentityConfiguration' managedDiskIdentity: description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption $ref: '#/definitions/ManagedIdentityConfiguration' diskEncryptionSetId: readOnly: true type: string description: The resource Id of the managed disk encryption set. encryption: type: object description: Encryption properties for databricks workspace properties: entities: $ref: '#/definitions/EncryptionEntitiesDefinition' description: Encryption entities definition for the workspace. required: - entities enhancedSecurityCompliance: description: Contains settings related to the Enhanced Security and Compliance Add-On. $ref: '#/definitions/EnhancedSecurityComplianceDefinition' privateEndpointConnections: readOnly: true description: Private endpoint connections created on the workspace type: array items: $ref: '#/definitions/PrivateEndpointConnection_2' publicNetworkAccess: type: string description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. enum: - Enabled - Disabled x-ms-enum: modelAsString: true name: PublicNetworkAccess requiredNsgRules: type: string description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. enum: - AllRules - NoAzureDatabricksRules - NoAzureServiceRules x-ms-enum: modelAsString: true name: RequiredNsgRules defaultCatalog: description: Properties for Default Catalog configuration during workspace creation. $ref: '#/definitions/DefaultCatalogProperties' isUcEnabled: readOnly: true description: Indicates whether unity catalog enabled for the workspace or not. type: boolean required: - managedResourceGroupId description: The workspace properties. WorkspaceResourceList: description: The list of workspaces. type: object properties: nextLink: description: The link used to get the next page of Workspace list. type: string value: description: The list of workspaces. type: array items: $ref: '#/definitions/WorkspaceResource' Sku: properties: name: type: string description: The SKU name. tier: type: string description: The SKU tier. required: - name description: SKU for the resource. WorkspaceListResult_4: description: The result of a request to list machine learning team account workspaces. properties: value: description: The list of machine learning team account workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning team accounts. type: array items: $ref: '#/definitions/Workspace_6' nextLink: description: The URI that can be used to request the next list of machine learning workspaces. type: string ServiceManagedResourcesSettings: type: object properties: cosmosDb: $ref: '#/definitions/CosmosDbSettings' WorkspaceProperties_7: description: Workspace properties type: object properties: defaultDataLakeStorage: description: Workspace default data lake storage account details $ref: '#/definitions/DataLakeStorageAccountDetails' sqlAdministratorLoginPassword: description: SQL administrator login password type: string managedResourceGroupName: description: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.' type: string provisioningState: description: Resource provisioning state type: string readOnly: true sqlAdministratorLogin: description: Login for workspace SQL active directory administrator type: string virtualNetworkProfile: description: Virtual Network profile $ref: '#/definitions/VirtualNetworkProfile' connectivityEndpoints: description: Connectivity endpoints additionalProperties: type: string type: object managedVirtualNetwork: description: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. type: string privateEndpointConnections: description: Private endpoint connections to the workspace type: array items: $ref: ../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection encryption: description: The encryption details of the workspace $ref: '#/definitions/EncryptionDetails' workspaceUID: description: The workspace unique identifier type: string readOnly: true format: uuid extraProperties: description: Workspace level configs and feature flags additionalProperties: type: object type: object readOnly: true managedVirtualNetworkSettings: description: Managed Virtual Network Settings $ref: '#/definitions/ManagedVirtualNetworkSettings' workspaceRepositoryConfiguration: description: Git integration settings $ref: '#/definitions/WorkspaceRepositoryConfiguration' purviewConfiguration: description: Purview Configuration $ref: '#/definitions/PurviewConfiguration' adlaResourceId: description: The ADLA resource ID. type: string readOnly: true publicNetworkAccess: enum: - Enabled - Disabled description: Enable or Disable public network access to workspace type: string x-ms-enum: name: WorkspacePublicNetworkAccess modelAsString: true TermsOfService: type: object description: API Terms of Service properties: url: type: string format: uri description: URL pointing to the terms of service. required: - url WorkspaceProviderAuthorization: properties: principalId: type: string format: uuid description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. roleDefinitionId: type: string format: uuid description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. required: - principalId - roleDefinitionId description: The workspace provider authorization. PrivateLinkServiceConnectionState: description: A collection of information about the state of the connection between service consumer and provider. 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' LifecycleStage: type: string description: API Lifecycle Stage enum: - design - development - testing - preview - production - deprecated - retired x-ms-enum: name: LifecycleStage modelAsString: true values: - name: Design value: design description: API is in the design stage - name: Development value: development description: API is in the development stage - name: Testing value: testing description: API is in the testing stage - name: Preview value: preview description: API is in the preview stage - name: Production value: production description: API is in the production stage - name: Deprecated value: deprecated description: API is in the deprecated stage - name: Retired value: retired description: API is in the retired stage PrivateEndpointConnectionProvisioningState_2: type: string readOnly: true description: The current provisioning state. enum: - Succeeded - Creating - Updating - Deleting - Failed x-ms-enum: name: PrivateEndpointConnectionProvisioningState modelAsString: true CreatedDateTime: type: string format: date-time description: The date and time stamp when the workspace was created. readOnly: true RuleStatus: description: Type of a managed network Outbound Rule of a machine learning workspace. enum: - Inactive - Active type: string x-ms-enum: name: RuleStatus modelAsString: true EncryptionDetails: description: Details of the encryption associated with the workspace type: object properties: doubleEncryptionEnabled: description: Double Encryption enabled type: boolean readOnly: true cmk: description: Customer Managed Key Details $ref: '#/definitions/CustomerManagedKeyDetails' WorkspaceUpdateDefinition: type: object description: Firmware analysis workspace. properties: properties: description: The editable workspace properties. x-ms-client-flatten: true $ref: '#/definitions/WorkspaceProperties_3' EncryptionEntitiesDefinition: properties: managedServices: type: object description: Encryption properties for the databricks managed services. $ref: '#/definitions/EncryptionV2' managedDisk: type: object description: Encryption properties for the databricks managed disks. $ref: '#/definitions/ManagedDiskEncryption' description: Encryption entities for databricks workspace resource. ErrorResponse_2: title: Error response. description: Contains details when the response code indicates an error. type: object properties: error: description: The error details. $ref: '#/definitions/ErrorInfo' required: - error Sku_2: description: Sku of the resource type: object properties: name: description: Name of the sku type: string tier: description: Tier of the sku like Basic or Enterprise type: string TrackedResource: description: The resource model definition for a ARM tracked top level resource properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives required: - location allOf: - $ref: '#/definitions/Resource' KeyVaultProperties: description: Customer Key vault properties. 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 WorkspaceUpdateParameters_2: 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 properties: $ref: '#/definitions/WorkspacePropertiesUpdateParameters_2' description: The properties that the machine learning workspace will be updated with. x-ms-client-flatten: true ManagedVirtualNetworkSettings: description: Managed Virtual Network Settings type: object properties: preventDataExfiltration: description: Prevent Data Exfiltration type: boolean linkedAccessCheckOnTargetResource: description: Linked Access Check On Target Resource type: boolean allowedAadTenantIdsForLinking: description: Allowed Aad Tenant Ids For Linking type: array items: type: string description: Tenant Id ManagedDiskEncryption: type: object properties: keySource: type: string description: 'The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault' enum: - Microsoft.Keyvault x-ms-enum: name: EncryptionKeySource modelAsString: true keyVaultProperties: type: object properties: keyVaultUri: type: string description: The URI of KeyVault. keyName: type: string description: The name of KeyVault key. keyVersion: type: string description: The version of KeyVault key. required: - keyVaultUri - keyName - keyVersion description: Key Vault input properties for encryption. rotationToLatestKeyVersionEnabled: type: boolean description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. required: - keySource - keyVaultProperties description: The object that contains details of encryption used on the workspace. WorkspaceKeysResponse: type: object description: Workspace authorization keys for a workspace. properties: primaryToken: type: string description: Primary authorization key for this workspace. secondaryToken: type: string description: Secondary authorization key for this workspace. Workspace_3: type: object description: Firmware analysis workspace. properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkspaceProperties_3' allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource WorkspaceListResult_2: properties: value: type: array items: $ref: '#/definitions/Workspace_2' description: The array of workspaces. nextLink: type: string description: The URL to use for getting the next set of results. description: List of workspaces. EnvironmentOnboardingModel: type: object description: Environment Onboarding Model properties: instructions: type: string description: Instructions how to onboard to the environment. maxLength: 1000 developerPortalUris: type: array description: Developer portal URIs of the environment. items: type: string format: uri required: - instructions - developerPortalUris ApiDeploymentServer: type: object description: Api Deployment Server properties: runtimeUris: type: array description: Base runtime URIs for this deployment. items: type: string format: uri required: - runtimeUris ManagedIdentityConfiguration: description: The Managed Identity details for storage account. properties: principalId: type: string format: uuid description: The objectId of the Managed Identity that is linked to the Managed Storage account. readOnly: true tenantId: type: string format: uuid description: The tenant Id where the Managed Identity is created. readOnly: true type: type: string description: The type of Identity created. It can be either SystemAssigned or UserAssigned. readOnly: true PagedApiVersion: type: object description: Paged collection of ApiVersion items properties: value: type: array description: The ApiVersion items on this page items: $ref: '#/definitions/ApiVersion' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value ComplianceSecurityProfileDefinition: type: object description: Status of Compliance Security Profile feature. properties: complianceStandards: description: Compliance standards associated with the workspace. type: array items: $ref: '#/definitions/ComplianceStandardDefinition' value: type: string enum: - Enabled - Disabled x-ms-enum: modelAsString: true name: ComplianceSecurityProfileValue Workspace_8: description: A workspace type: object allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource properties: properties: description: Workspace resource properties $ref: '#/definitions/WorkspaceProperties_7' x-ms-client-flatten: true identity: description: Identity of the workspace $ref: '#/definitions/ManagedIdentity' UploadIndicatorsResponse: description: Response object containing more details about the operation. type: object properties: errors: description: Details of the error. Contains a list of indicator validation errors type: array items: $ref: '#/definitions/IndicatorValidationError' EnhancedSecurityMonitoringDefinition: type: object description: Status of Enhanced Security Monitoring feature. properties: value: type: string enum: - Enabled - Disabled x-ms-enum: modelAsString: true name: EnhancedSecurityMonitoringValue WorkspaceEncryptionParameter: properties: type: $ref: '#/definitions/WorkspaceCustomParameterType' description: The type of variable that this is value: $ref: '#/definitions/Encryption' description: The value which should be used for this field. description: The object that contains details of encryption used on the workspace. WorkspacePatchInfo: description: Workspace patch details type: object properties: tags: description: Resource tags additionalProperties: type: string type: object identity: description: The identity of the workspace $ref: '#/definitions/ManagedIdentity' properties: description: Workspace patch properties $ref: '#/definitions/WorkspacePatchProperties' x-ms-client-flatten: true EnhancedSecurityComplianceDefinition: type: object description: Status of settings related to the Enhanced Security and Compliance Add-On. properties: automaticClusterUpdate: type: string description: Status of automated cluster updates feature. $ref: '#/definitions/AutomaticClusterUpdateDefinition' complianceSecurityProfile: type: object description: Status of Compliance Security Profile feature. $ref: '#/definitions/ComplianceSecurityProfileDefinition' enhancedSecurityMonitoring: type: object description: Status of Enhanced Security Monitoring feature. $ref: '#/definitions/EnhancedSecurityMonitoringDefinition' WorkspaceProperties_3: type: object properties: provisioningState: description: Provisioning state of the resource. type: string enum: - Accepted - Succeeded - Canceled - Failed x-ms-enum: name: ProvisioningState modelAsString: true readOnly: true description: Workspace properties. 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 EncryptionUpdateProperties: required: - keyVaultProperties type: object properties: keyVaultProperties: $ref: '#/definitions/EncryptionKeyVaultUpdateProperties' InnerError: description: This is an object containing more specific information than the current object about the error. properties: code: description: This is a more specific error code than was provided by the containing error.. type: string type: object ErrorResponse_3: description: The error response send when an operation fails. properties: code: type: string description: error code message: type: string description: error message required: - code - message parameters: ApiVersionParameter_5: name: api-version in: query required: true type: string description: Client Api Version. GenerateUploadUrlBodyParameter: name: generateUploadUrl in: body required: true schema: $ref: '#/definitions/GenerateUploadUrlRequest' description: Parameters when requesting a URL to upload firmware. x-ms-parameter-location: method workspaceNameParameter: name: workspaceName in: path required: true type: string description: The name of the workspace x-ms-parameter-location: method WorkspaceUpdateBodyParameter: name: workspace in: body required: true schema: $ref: '#/definitions/WorkspaceUpdateDefinition' description: Parameters when updating a firmware analysis workspace. x-ms-parameter-location: method ResourceGroupName: name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 x-ms-parameter-location: method ApiVersionParameter_4: name: api-version in: query description: The client API version. required: true type: string ResourceGroupParameter_2: name: resourceGroupName in: path description: The name of the resource group to which the machine learning team account belongs. required: true type: string x-ms-parameter-location: method WorkspaceNameParameter_2: 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}$ timespanParam: name: timespan in: query required: false format: duration x-ms-parameter-location: method description: Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression. type: string ApiVersionParameter_3: in: query name: api-version description: The api-version for operation required: true type: string x-ms-parameter-location: method queryBody: name: body in: body description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) required: true schema: $ref: '#/definitions/queryBody' x-ms-parameter-location: method Azure.Core.TopQueryParameter: name: top in: query description: The number of result items to return. required: false type: integer format: int32 x-ms-parameter-location: method WorkspaceKindParameter: in: query name: kind description: Kind of workspace. type: string x-ms-parameter-location: method AccountNameParameter: name: accountName in: path description: The name of the machine learning team account. required: true type: string maxLength: 50 minLength: 5 pattern: ^[a-zA-Z0-9]*$ x-ms-parameter-location: method queryParam: name: query in: query required: true x-ms-parameter-location: method description: The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/) type: string SubscriptionIdParameter_3: name: subscriptionId in: path description: The Microsoft Azure subscription ID. required: true type: string Azure.Core.SkipQueryParameter: name: skip in: query description: The number of result items to skip. required: false type: integer format: int32 default: 0 x-ms-parameter-location: method workspaceId: name: workspaceId description: ID of the workspace. This is Workspace ID from the Properties blade in the Azure portal. in: path required: true type: string x-ms-parameter-location: method Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion WorkspaceNameParameter_4: name: workspaceName in: path description: The name of the machine learning team account workspace. required: true type: string maxLength: 50 minLength: 5 pattern: ^[a-zA-Z0-9]*$ x-ms-parameter-location: method ApiVersionParameter_2: name: api-version in: query description: The client API version. required: true type: string SubscriptionIdParameter_4: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. WorkspaceNameParameter: description: The name of the Workspace. in: path name: workspaceName required: true type: string x-ms-parameter-location: method SubscriptionIdParameter_2: name: subscriptionId in: path description: The Microsoft Azure subscription ID. required: true type: string PreferHeaderParameter: name: Prefer in: header required: false type: string description: Optional. The prefer header to set server timeout, query statistics and visualization information. x-ms-parameter-location: method ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to use for this operation. PaginationParameter: in: query name: $skip description: Continuation token for pagination. type: string x-ms-parameter-location: method WorkspaceNameParameter_3: name: workspaceName in: path description: The name of the machine learning workspace. required: true type: string x-ms-parameter-location: method WorkspaceName: name: workspaceName in: path required: true type: string description: The name of the workspace. minLength: 3 maxLength: 64 x-ms-parameter-location: method WorkspaceCreateBodyParameter: name: workspace in: body required: true schema: $ref: '#/definitions/Workspace_3' description: Parameters when creating a firmware analysis workspace. x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The ID of the target subscription. Azure.Core.MaxPageSizeQueryParameter: name: maxpagesize in: query description: The maximum number of result items per page. required: false type: integer format: int32 x-ms-parameter-location: method ResourceGroupParameter: name: resourceGroupName in: path description: The name of the resource group to which the machine learning workspace belongs. required: true type: string x-ms-parameter-location: method WorkspaceForceToPurgeParameter: in: query name: forceToPurge description: Flag to indicate delete is a purge request. type: boolean default: false x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'