How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Workspaces API

The Workspaces API from Microsoft Azure — 43 operation(s) for workspaces.

Microsoft Azure Workspaces API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 70 operations across 43 paths, and defines 183 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

70 operations 43 paths 183 schemas 9 DELETE38 GET7 PATCH7 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 70

Across 43 paths, the API surfaces 70 operations — 9 DELETE, 38 GET, 7 PATCH, 7 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 70
GET
/workspaces/{workspaceName}/apis
Microsoft Azure Get Workspaces Workspacename Apis
microsoftAzureApisList 5 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}
Microsoft Azure Get Workspaces Workspacename Apis Apiname
microsoftAzureApisGet 3 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}/deployments
Microsoft Azure Get Workspaces Workspacename Apis Apiname Deployments
microsoftAzureApideploymentsListdeployments 6 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}
Microsoft Azure Get Workspaces Workspacename Apis Apiname Deployments Deploymentname
microsoftAzureApideploymentsGetdeployment 4 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}/versions
Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions
microsoftAzureApiversionsListversions 6 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}
Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname
microsoftAzureApiversionsGetversion 4 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions
Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname Definitions
microsoftAzureApidefinitionsListdefinitions 7 params → 200default
GET
/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}
Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname Definitions Definitionname
microsoftAzureApidefinitionsGetdefinition 5 params → 200default
POST
/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}:exportSpecification
Microsoft Azure Post Workspaces Workspacename Apis Apiname Versions Versionname Definitions Definitionname:exportspecification
microsoftAzureApidefinitionsExportspecification 5 params → 202default
GET
/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/operations/{operationId}
Microsoft Azure Get Workspaces Workspacename Apis Apiname Versions Versionname Definitions Definitionname Operations Operationid
microsoftAzureApidefinitionsGetexportspecificationoperationstatus 6 params → 200default
GET
/workspaces/{workspaceName}/environments
Microsoft Azure Get Workspaces Workspacename Environments
microsoftAzureEnvironmentsList 5 params → 200default
GET
/workspaces/{workspaceName}/environments/{environmentName}
Microsoft Azure Get Workspaces Workspacename Environments Environmentname
microsoftAzureEnvironmentsGet 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
Microsoft Azure Retrieve A Workspace By Workspacename
microsoftAzureWorkspacesGet 4 params → 200default
GET
/workspaces/{workspaceId}/query
Microsoft Azure Execute An Analytics Query
microsoftAzureQueryGet 3 params → 200default
POST
/workspaces/{workspaceId}/query
Microsoft Azure Execute An Analytics Query
microsoftAzureQueryExecute 3 params → 200default
GET
/workspaces/{workspaceId}/metadata
Microsoft Azure Gets Metadata Information
microsoftAzureMetadataGet 1 param → 200default
POST
/workspaces/{workspaceId}/metadata
Microsoft Azure Gets Metadata Information
microsoftAzureMetadataPost 1 param → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces
Microsoft Azure Lists All The Available Machine Learning Workspaces Under The Specified Subscription
microsoftAzureWorkspacesListbysubscription 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces
Microsoft Azure Lists All The Available Machine Learning Workspaces Under The Specified Resource Group
microsoftAzureWorkspacesListbyresourcegroup 6 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
Microsoft Azure Deletes A Machine Learning Workspace
microsoftAzureWorkspacesDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
Microsoft Azure Gets The Properties Of The Specified Machine Learning Workspace
microsoftAzureWorkspacesGet 4 params → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
Microsoft Azure Updates A Machine Learning Workspace With The Specified Parameters
microsoftAzureWorkspacesUpdate 4 params body → 200202default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
Microsoft Azure Creates Or Updates A Workspace With The Specified Parameters
microsoftAzureWorkspacesCreateorupdate 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningservices Workspaces Workspacename Features
microsoftAzureWorkspacefeaturesList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename
microsoftAzureWorkspacesGet 4 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename
microsoftAzureWorkspacesDelete 5 params → 200202204default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename
microsoftAzureWorkspacesCreateorupdate 4 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces Workspacename
microsoftAzureWorkspacesUpdate 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databricks Workspaces
microsoftAzureWorkspacesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databricks Workspaces
microsoftAzureWorkspacesListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.IoTFirmwareDefense/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Iotfirmwaredefense Workspaces
microsoftAzureWorkspacesListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces
microsoftAzureWorkspacesListbyresourcegroup 3 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename
microsoftAzureWorkspacesCreate 5 params → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename
microsoftAzureWorkspacesUpdate 5 params → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename
microsoftAzureWorkspacesDelete 4 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename
microsoftAzureWorkspacesGet 4 params → 200304default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTFirmwareDefense/workspaces/{workspaceName}/generateUploadUrl
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotfirmwaredefense Workspaces Workspacename Generateuploadurl
microsoftAzureWorkspacesGenerateuploadurl 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename
microsoftAzureWorkspacesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename
microsoftAzureWorkspacesCreateorupdate 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename
microsoftAzureWorkspacesDelete 4 params → 200204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename
microsoftAzureWorkspacesUpdate 4 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/resyncStorageKeys
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename Resyncstoragekeys
microsoftAzureWorkspacesResyncstoragekeys 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/listWorkspaceKeys
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces Workspacename Listworkspacekeys
microsoftAzureWorkspacesListworkspacekeys 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Workspaces
microsoftAzureWorkspacesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Machinelearning Workspaces
microsoftAzureWorkspacesList 2 params → 200default
POST
/workspaces/{workspaceId}/threatintelligenceindicators:upload
Microsoft Azure Upload The Indicators To The Workspace
microsoftAzureThreatintelligenceindicatorsUpload 2 params body → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Easm/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Easm Workspaces
microsoftAzureWorkspacesListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces
microsoftAzureWorkspacesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename
microsoftAzureWorkspacesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename
microsoftAzureWorkspacesCreateandupdate 4 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename
microsoftAzureWorkspacesUpdate 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename
microsoftAzureWorkspacesDelete 4 params → 202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename
microsoftAzureWorkspacesGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename
microsoftAzureWorkspacesCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename
microsoftAzureWorkspacesDelete 5 params → 200204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces/{workspaceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces Workspacename
microsoftAzureWorkspacesUpdate 5 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningExperimentation/accounts/{accountName}/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearningexperimentation Accounts Accountname Workspaces
microsoftAzureWorkspacesListbyaccounts 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/workspaceCollections/{workspaceCollectionName}/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerbi Workspacecollections Workspacecollectionname Workspaces
microsoftAzureWorkspacesList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces
microsoftAzureWorkspacesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename
microsoftAzureWorkspacesGet 4 params → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename
microsoftAzureWorkspacesUpdate 4 params body → 200201default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename
microsoftAzureWorkspacesCreateorupdate 4 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename
microsoftAzureWorkspacesDelete 4 params → 200202204default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/workspaces
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Synapse Workspaces
microsoftAzureWorkspacesList 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Administrators Activedirectory
microsoftAzureWorkspaceaadadminsGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Administrators Activedirectory
microsoftAzureWorkspaceaadadminsCreateorupdate 4 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Administrators Activedirectory
microsoftAzureWorkspaceaadadminsDelete 4 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Sqladministrators Activedirectory
microsoftAzureWorkspacesqlaadadminsGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Sqladministrators Activedirectory
microsoftAzureWorkspacesqlaadadminsCreateorupdate 4 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Synapse Workspaces Workspacename Sqladministrators Activedirectory
microsoftAzureWorkspacesqlaadadminsDelete 4 params → 200202204default

Schemas 183

The contract defines 183 schemas that model the data the API accepts and returns. The most detailed are WorkspaceProperties (40 properties), WorkspaceProperties_2 (20 properties), WorkspacePropertiesUpdateParameters (17 properties), WorkspaceProperties_7 (17 properties). Each schema is shown below with its type and property counts.

WorkspaceCustomObjectParameter
object
The value which should be used for this field.
2 properties 1 required
PublicNetworkAccessType
string
The public network access flag.
tags
object
String-based key-value tags
WorkspaceCustomParameterType
string
Provisioning status of the workspace.
WorkspaceResource
object
Workspace details.
1 property
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
EnhancedSecurityComplianceDefinition
object
Status of settings related to the Enhanced Security and Compliance Add-On.
3 properties
WorkspacePrivateEndpointResource
object
The Private Endpoint resource.
2 properties
PrivateEndpointConnectionProvisioningState
string
The current provisioning state.
errorResponse
object
Contains details when the response code indicates an error.
1 property 1 required
UploadIndicatorsResponse
object
Response object containing more details about the operation.
1 property
ServiceManagedResourcesSettings
object
1 property
EncryptionStatus
string
Indicates whether or not the encryption is enabled for the workspace.
PagedEnvironment
object
Paged collection of Environment items
2 properties 1 required
WorkspaceProperties_6
object
The properties of a machine learning team account workspace.
6 properties 1 required
ApiKind
string
API kind
InnerError
object
This is an object containing more specific information than the current object about the error.
1 property
WorkspacePatchInfo
object
Workspace patch details
3 properties
UploadIndicatorsRequest
object
Schema for request body.
2 properties
PrivateLinkServiceConnectionState
object
A collection of information about the state of the connection between service consumer and provider.
3 properties
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
WorkspaceProperties_2
object
The workspace properties.
20 properties 1 required
WorkspaceRepositoryConfiguration
object
Git integration settings
9 properties
EncryptionEntitiesDefinition
object
Encryption entities for databricks workspace resource.
2 properties
PrivateEndpointConnectionProperties_2
object
The properties of a private endpoint connection
4 properties 1 required
metadataResourceType
object
Metadata about types of Azure resources, containing relevant tables, functions, etc.
8 properties 2 required
ApiDefinition
object
API definition resource model.
4 properties 2 required
Workspace_2
object
Information about workspace.
3 properties 1 required
PurviewConfiguration
object
Purview Configuration
1 property
Azure.Core.Foundations.OperationState
string
Enum describing allowed operation states.
VirtualNetworkProfile
object
Virtual Network Profile
1 property
WorkspaceListResult_3
object
The result of a request to list machine learning workspace keys.
2 properties
WorkspaceProperties_5
object
The properties of a machine learning workspace.
8 properties 2 required
SharedPrivateLinkResourceProperty
object
Properties of a shared private link resource.
4 properties
ResourceBaseProperties
object
Resource base properties.
1 property
EnvironmentOnboardingModel
object
Environment Onboarding Model
2 properties 2 required
ApiSpecification
object
API specification
2 properties 2 required
EncryptionUpdateProperties
object
1 property 1 required
ComputeRuntimeDto
object
1 property
TrackedResource
object
The resource model definition for a ARM tracked top level resource
2 properties 1 required
FeatureStoreSettings
object
3 properties
WorkspaceUpdateParameters_3
object
The parameters for updating a machine learning team account workspace.
2 properties
ErrorDetail_3
object
3 properties
WorkspaceResponse
object
4 properties
PrivateEndpointConnectionProperties
object
Private endpoint connection properties.
3 properties
ComplianceSecurityProfileDefinition
object
Status of Compliance Security Profile feature.
2 properties
metadataApplication
object
Application Insights apps that were part of the metadata request and that the user has access to.
5 properties 4 required
metadataWorkspace
object
Log Analytics workspaces that were part of the metadata request and that the user has access to.
5 properties 4 required
OutboundRule
object
Outbound Rule for the managed network of a machine learning workspace.
3 properties 1 required
metadataPermissions
object
Permission information for the metadata call, includes apps/workspaces/resource the user didn't have access to.
3 properties 1 required
IsolationMode
string
Isolation mode for the managed network of a machine learning workspace.
EnhancedSecurityMonitoringDefinition
object
Status of Enhanced Security Monitoring feature.
1 property
metadataSolution
object
Solutions can group tables and functions that are associated with a certain Azure Log Analytics offering.
7 properties 3 required
PagedApi
object
Paged collection of Api items
2 properties 1 required
WorkspaceList_3
object
1 property
Resource_2
object
An Azure resource.
6 properties 1 required
RuleStatus
string
Type of a managed network Outbound Rule of a machine learning workspace.
ErrorResponseBody
object
The definition of an error object.
1 property 1 required
ErrorDetail_2
object
3 properties 2 required
CreatedDateTime
string
The date and time stamp when the workspace was created.
AutomaticClusterUpdateDefinition
object
Status of automated cluster updates feature.
1 property
NotebookResourceInfo
object
4 properties
EncryptionV2
object
The object that contains details of encryption used on the workspace.
2 properties 1 required
PagedApiDefinition
object
Paged collection of ApiDefinition items
2 properties 1 required
ResourceState
string
Resources provisioning states.
Encryption
object
The object that contains details of encryption used on the workspace.
4 properties
WorkspacePropertiesUpdateParameters_3
object
The parameters for updating the properties of a machine learning team account workspace.
2 properties
metadataResource
Azure resources that were part of the metadata request and that the user has access to.
ErrorResponse_3
object
The error response send when an operation fails.
2 properties 2 required
EncryptionProperty
object
6 properties 2 required
CustomerManagedKeyDetails
object
Details of the customer managed key associated with the workspace
2 properties
ListAmlUserFeatureResult
object
The List Aml user feature operation response.
2 properties
WorkspaceListResult_4
object
The result of a request to list machine learning team account workspaces.
2 properties
WorkspaceResourceList
object
The list of workspaces.
2 properties
queryParam
string
The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)
errorInfo
object
5 properties 2 required
EnvironmentServer
object
Environment Server
2 properties 2 required
Environment
object
Environment resource model.
7 properties 3 required
CreatedBy
object
Provides details of the entity that created/updated the workspace.
3 properties
ErrorDetail
object
This is the top-level error object whose code matches the x-ms-error-code response header
5 properties 2 required
RuleCategory
string
Category of a managed network Outbound Rule of a machine learning workspace.
timespanParam
string
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 qu…
WorkspaceListResult
object
The result of a request to list machine learning workspaces.
2 properties
AadAdminProperties
object
Workspace active directory administrator properties
4 properties
PrivateEndpoint
object
The private endpoint property of a private endpoint connection
1 property
PrivateEndpointConnectionProvisioningState_2
string
The current provisioning state.
WorkspacePatchResource
object
Workspace patch properties.
2 properties
Error
object
4 properties
Resource_3
object
An Azure resource.
5 properties 1 required
ErrorInfo
object
4 properties 2 required
Workspace_7
object
4 properties
DataLakeStorageAccountDetails
object
Details of the data lake storage account associated with the workspace
2 properties
WorkspacePropertiesUpdateParameters
object
The parameters for updating a machine learning workspace.
17 properties
WorkspaceResourceProperties
object
Workspace properties.
1 property
ManagedIdentity
object
The workspace managed identity
3 properties
queryResults
object
Contains the tables, columns & rows resulting from a query.
4 properties 1 required
WorkspaceProviderAuthorization
object
The workspace provider authorization.
2 properties 2 required
ManagedDiskEncryption
object
The object that contains details of encryption used on the workspace.
3 properties 2 required
ManagedNetworkStatus
string
Status for the managed network of a machine learning workspace.
DefaultCatalogProperties
object
These properties lets user specify default catalog properties during workspace creation.
2 properties
WorkspaceMode
object
3 properties
IndicatorValidationError
object
Object that stores a list of errors encountered when executing the Upload Indicators operation.
2 properties
metadataFunction
object
Functions are stored Kusto queries that can be specified as part of queries by using their name.
9 properties 3 required
PrivateEndpointConnection
object
The Private Endpoint Connection resource.
5 properties
workspacesParam
array
Workspace names to include in cross-workspace queries.
WorkspaceProperties_3
object
Workspace properties.
1 property
ApiVersion
object
API version resource model.
3 properties 3 required
WorkspaceKeyDetails
object
Details of the customer managed key associated with the workspace
2 properties
WorkspaceUpdateParameters
object
The parameters for updating a machine learning workspace.
4 properties
queryBody
object
The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)
3 properties 1 required
ApiDeployment
object
API deployment resource model.
7 properties 4 required
ProvisioningState
string
The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
RuleType
string
Type of a managed network Outbound Rule of a machine learning workspace.
IdentityForCmk
object
Identity object used for encryption.
1 property
PrivateEndpointConnection_2
object
The private endpoint connection of a workspace
4 properties 1 required
ComplianceStandardDefinition
string
Compliance standard that can be associated with a workspace.
PagedApiVersion
object
Paged collection of ApiVersion items
2 properties 1 required
WorkspaceEncryptionParameter
object
The object that contains details of encryption used on the workspace.
2 properties
WorkspaceUpdateDefinition
object
Firmware analysis workspace.
1 property
AmlUserFeature
object
Features enabled for a workspace
3 properties
WorkspaceCustomStringParameter
object
The Value.
2 properties 1 required
Contact
object
API contact information
3 properties 1 required
ServerlessComputeSettings
object
2 properties
ErrorResponse_4
object
The error response send when an operation fails.
2 properties 2 required
PrivateLinkServiceConnectionState_2
object
The current state of a private endpoint connection
3 properties 1 required
ApiSpecExportResult
object
Export specification result model.
2 properties 2 required
EnvironmentKind
string
Environment kind
WorkspaceKeysResponse
object
Workspace authorization keys for a workspace.
2 properties
TermsOfService
object
API Terms of Service
1 property 1 required
WorkspaceListResult_2
object
List of workspaces.
2 properties
WorkspaceUpdate
object
An update to a workspace.
1 property
ManagedNetworkSettings
object
Managed Network settings for a machine learning workspace.
5 properties
License
object
API License Model
3 properties 1 required
ErrorResponse_2
object
Contains details when the response code indicates an error.
1 property 1 required
WorkspaceCustomParameters
object
Custom Parameters used for Cluster Creation.
16 properties
JsonPropertyBag
object
An object that stores a list of JSON properties from a given JObject.
WorkspaceAadAdminInfo
object
Workspace active directory administrator
1 property
WorkspaceUpdateParameters_2
object
The parameters for updating a machine learning workspace.
2 properties
metadataQuery
object
Queries are stored pieces of KQL, along with a list of relevant metadata items.
8 properties 2 required
Workspace_8
object
A workspace
2 properties
WorkspaceProperties
object
The properties of a machine learning workspace.
40 properties
Workspace_6
object
An object that represents a machine learning team account workspace.
1 property
WorkspacePatchProperties
object
Workspace patch properties
7 properties
SharedPrivateLinkResource
object
2 properties
Workspace_3
object
Firmware analysis workspace.
1 property
Sku_2
object
Sku of the resource
2 properties
Workspace
object
An object that represents a machine learning workspace.
6 properties 1 required
metadataTable
object
Tables are part of the workspace schema, and contain a list of columns and a reference to other relevant metadata items.
9 properties 2 required
ManagedIdentityConfiguration
object
The Managed Identity details for storage account.
3 properties
Resource
object
The core properties of ARM resources
3 properties
ErrorData
object
Detailed information about the errors from the operation.
2 properties 2 required
KeyVaultProperties
object
Customer Key vault properties.
3 properties 2 required
GenerateUploadUrlRequest
object
Properties for generating an upload URL
1 property
WorkspaceList
object
Return a list of firmware analysis workspaces.
2 properties
WorkspaceHubConfig
object
WorkspaceHub's configuration object.
2 properties
LifecycleStage
string
API Lifecycle Stage
table
object
Contains the columns and rows for one table in a query response.
3 properties 3 required
metadataCategory
object
Categories are used to group other metadata entities.
4 properties 2 required
ManagedVirtualNetworkSettings
object
Managed Virtual Network Settings
3 properties
WorkspacePropertiesUpdateParameters_2
object
The parameters for updating the properties of a machine learning workspace.
3 properties
WorkspaceInfoListResult
object
List of workspaces
2 properties
EncryptionDetails
object
Details of the encryption associated with the workspace
2 properties
column
object
A column in a table.
2 properties
Sku
object
SKU for the resource.
2 properties 1 required
metadataResults
object
The metadata response for the app, including available tables, etc.
10 properties
ManagedNetworkProvisionStatus
object
Status of the Provisioning for the managed network of a machine learning workspace.
2 properties
PagedApiDeployment
object
Paged collection of ApiDeployment items
2 properties 1 required
WorkspaceCustomBooleanParameter
object
The value which should be used for this field.
2 properties 1 required
ProvisioningState_2
string
Provisioning status of the workspace.
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
Api
object
API resource model.
12 properties 3 required
ErrorResponse
object
1 property 1 required
Workspace_5
object
An object that represents a machine learning workspace.
1 property
WorkspaceProperties_7
object
Workspace properties
17 properties
NotebookPreparationError
object
2 properties
EncryptionKeyVaultUpdateProperties
object
1 property 1 required
errorDetail
object
6 properties 2 required
ExternalDocumentation
object
Api External Documentation Model
3 properties 3 required
ApiDeploymentServer
object
Api Deployment Server
1 property 1 required
logsColumnType
string
The data type of this column.
PrivateEndpointServiceConnectionStatus
string
Connection status of the service consumer with the service provider Possible state transitions Pending - Approved (Service provider approves the connection req…
CosmosDbSettings
object
1 property
ApiSpecExportResultFormat
string
Export specification result format

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-workspaces-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.