Workspaces - List By Subscription
Lists all the available machine learning workspaces under the specified subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces?api-version=2025-06-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces?api-version=2025-06-01&$skip={$skip}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string minLength: 1 |
The ID of the target subscription. |
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
$skip
|
query |
string |
Continuation token for pagination. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request was successful; the request was well-formed and received properly. |
|
Other Status Codes |
Error response describing why the operation failed |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get Workspaces by subscription
Sample request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.MachineLearningServices/workspaces?api-version=2025-06-01
Sample response
{
"value": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace",
"name": "testworkspace",
"type": "Microsoft.MachineLearningServices/workspaces",
"location": "eastus2euap",
"properties": {
"containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry",
"keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv",
"applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights",
"storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount",
"discoveryUrl": "http://example.com",
"friendlyName": "HelloName",
"description": "test description"
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace",
"name": "testworkspace",
"type": "Microsoft.MachineLearningServices/workspaces",
"location": "eastus2euap",
"properties": {
"containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew",
"keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew",
"applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights",
"storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld",
"discoveryUrl": "http://example.com",
"friendlyName": "HelloName",
"description": "test description"
}
}
],
"nextLink": "nextLink"
}
Definitions
Name | Description |
---|---|
Compute |
Compute runtime config for feature store type workspace. |
Cosmos |
|
created |
The type of identity that created the resource. |
Encryption |
|
Encryption |
|
Encryption |
Indicates whether or not the encryption is enabled for the workspace. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Feature |
Settings for feature store type workspace. |
Firewall |
Firewall Sku used for FQDN Rules |
Fqdn |
FQDN Outbound Rule for the managed network of a machine learning workspace. |
Identity |
Identity that will be used to access key vault for encryption at rest |
Isolation |
Isolation mode for the managed network of a machine learning workspace. |
Managed |
The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. |
Managed |
Status of the Provisioning for the managed network of a machine learning workspace. |
Managed |
Managed Network settings for a machine learning workspace. |
Managed |
Status for the managed network of a machine learning workspace. |
Managed |
Managed service identity (system assigned and/or user assigned identities) |
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
Notebook |
|
Notebook |
|
Private |
The Private Endpoint resource. |
Private |
The Private Endpoint Connection resource. |
Private |
The current provisioning state. |
Private |
Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. |
Private |
Private Endpoint Outbound Rule for the managed network of a machine learning workspace. |
Private |
The private endpoint connection status. |
Private |
A collection of information about the state of the connection between service consumer and provider. |
Provisioning |
The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. |
Public |
Whether requests from Public Network are allowed. |
Rule |
The action enum for networking rule. |
Rule |
Category of a managed network Outbound Rule of a machine learning workspace. |
Rule |
Type of a managed network Outbound Rule of a machine learning workspace. |
Rule |
Type of a managed network Outbound Rule of a machine learning workspace. |
Serverless |
|
Service |
|
Service |
Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. |
Service |
Service Tag Outbound Rule for the managed network of a machine learning workspace. |
Shared |
|
Sku |
The resource model definition representing SKU |
Sku |
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. |
system |
Metadata pertaining to creation and last modification of the resource. |
system |
The auth mode used for accessing the system datastores of the workspace. |
User |
User assigned identity properties |
Workspace |
An object that represents a machine learning workspace. |
Workspace |
WorkspaceHub's configuration object. |
Workspace |
The result of a request to list machine learning workspaces. |
ComputeRuntimeDto
Compute runtime config for feature store type workspace.
Name | Type | Description |
---|---|---|
sparkRuntimeVersion |
string |
CosmosDbSettings
Name | Type | Description |
---|---|---|
collectionsThroughput |
integer (int32) |
The throughput of the collections in cosmosdb database |
createdByType
The type of identity that created the resource.
Value | Description |
---|---|
User | |
Application | |
ManagedIdentity | |
Key |
EncryptionKeyVaultProperties
Name | Type | Description |
---|---|---|
identityClientId |
string |
For future use - The client id of the identity which will be used to access key vault. |
keyIdentifier |
string |
Key vault uri to access the encryption key. |
keyVaultArmId |
string |
The ArmId of the keyVault where the customer owned encryption key is present. |
EncryptionProperty
Name | Type | Description |
---|---|---|
identity |
The identity that will be used to access the key vault for encryption at rest. |
|
keyVaultProperties |
Customer Key vault properties. |
|
status |
Indicates whether or not the encryption is enabled for the workspace. |
EncryptionStatus
Indicates whether or not the encryption is enabled for the workspace.
Value | Description |
---|---|
Enabled | |
Disabled |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
FeatureStoreSettings
Settings for feature store type workspace.
Name | Type | Description |
---|---|---|
computeRuntime |
Compute runtime config for feature store type workspace. |
|
offlineStoreConnectionName |
string |
|
onlineStoreConnectionName |
string |
FirewallSku
Firewall Sku used for FQDN Rules
Value | Description |
---|---|
Standard | |
Basic |
FqdnOutboundRule
FQDN Outbound Rule for the managed network of a machine learning workspace.
Name | Type | Description |
---|---|---|
category |
Category of a managed network Outbound Rule of a machine learning workspace. |
|
destination |
string |
|
errorInformation |
string |
Error information about an outbound rule of a machine learning workspace if RuleStatus is failed. |
parentRuleNames |
string[] |
|
status |
Type of a managed network Outbound Rule of a machine learning workspace. |
|
type |
string:
FQDN |
Type of a managed network Outbound Rule of a machine learning workspace. |
IdentityForCmk
Identity that will be used to access key vault for encryption at rest
Name | Type | Description |
---|---|---|
userAssignedIdentity |
string |
The ArmId of the user assigned identity that will be used to access the customer managed key vault |
IsolationMode
Isolation mode for the managed network of a machine learning workspace.
Value | Description |
---|---|
Disabled | |
AllowInternetOutbound | |
AllowOnlyApprovedOutbound |
ManagedNetworkKind
The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled.
Value | Description |
---|---|
V1 | |
V2 |
ManagedNetworkProvisionStatus
Status of the Provisioning for the managed network of a machine learning workspace.
Name | Type | Description |
---|---|---|
sparkReady |
boolean |
|
status |
Status for the managed network of a machine learning workspace. |
ManagedNetworkSettings
Managed Network settings for a machine learning workspace.
Name | Type | Description |
---|---|---|
firewallPublicIpAddress |
string |
Public IP address assigned to the Azure Firewall. |
firewallSku |
Firewall Sku used for FQDN Rules |
|
isolationMode |
Isolation mode for the managed network of a machine learning workspace. |
|
managedNetworkKind |
The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. |
|
networkId |
string |
|
outboundRules |
object |
|
status |
Status of the Provisioning for the managed network of a machine learning workspace. |
ManagedNetworkStatus
Status for the managed network of a machine learning workspace.
Value | Description |
---|---|
Inactive | |
Active |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Name | Type | Description |
---|---|---|
principalId |
string (uuid) |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId |
string (uuid) |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
userAssignedIdentities |
<string,
User |
User-Assigned Identities |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
None | |
SystemAssigned | |
UserAssigned | |
SystemAssigned,UserAssigned |
NotebookPreparationError
Name | Type | Description |
---|---|---|
errorMessage |
string |
|
statusCode |
integer (int32) |
NotebookResourceInfo
Name | Type | Description |
---|---|---|
fqdn |
string |
|
notebookPreparationError |
The error that occurs when preparing notebook. |
|
resourceId |
string |
the data plane resourceId that used to initialize notebook component |
PrivateEndpoint
The Private Endpoint resource.
Name | Type | Description |
---|---|---|
id |
string |
The ARM identifier for Private Endpoint |
PrivateEndpointConnection
The Private Endpoint Connection resource.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
The identity of the resource. |
|
location |
string |
Specifies the location of the resource. |
name |
string |
The name of the resource |
properties.privateEndpoint |
The resource of private end point. |
|
properties.privateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
|
properties.provisioningState |
The provisioning state of the private endpoint connection resource. |
|
sku |
The sku of the workspace. |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
tags |
object |
Contains resource tags defined as key/value pairs. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
The current provisioning state.
Value | Description |
---|---|
Succeeded | |
Creating | |
Deleting | |
Failed |
PrivateEndpointDestination
Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
Name | Type | Description |
---|---|---|
serviceResourceId |
string (arm-id) |
|
sparkEnabled |
boolean |
|
sparkStatus |
Type of a managed network Outbound Rule of a machine learning workspace. |
|
subresourceTarget |
string |
PrivateEndpointOutboundRule
Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
Name | Type | Description |
---|---|---|
category |
Category of a managed network Outbound Rule of a machine learning workspace. |
|
destination |
Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. |
|
errorInformation |
string |
Error information about an outbound rule of a machine learning workspace if RuleStatus is failed. |
parentRuleNames |
string[] |
|
status |
Type of a managed network Outbound Rule of a machine learning workspace. |
|
type | string: |
Type of a managed network Outbound Rule of a machine learning workspace. |
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
Value | Description |
---|---|
Pending | |
Approved | |
Rejected | |
Disconnected | |
Timeout |
PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
A message indicating if changes on the service provider require any updates on the consumer. |
description |
string |
The reason for approval/rejection of the connection. |
status |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
ProvisioningState
The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
Value | Description |
---|---|
Unknown | |
Updating | |
Creating | |
Deleting | |
Succeeded | |
Failed | |
Canceled |
PublicNetworkAccess
Whether requests from Public Network are allowed.
Value | Description |
---|---|
Enabled | |
Disabled |
RuleAction
The action enum for networking rule.
Value | Description |
---|---|
Allow | |
Deny |
RuleCategory
Category of a managed network Outbound Rule of a machine learning workspace.
Value | Description |
---|---|
Required | |
Recommended | |
UserDefined | |
Dependency |
RuleStatus
Type of a managed network Outbound Rule of a machine learning workspace.
Value | Description |
---|---|
Inactive | |
Active | |
Provisioning | |
Deleting | |
Failed |
RuleType
Type of a managed network Outbound Rule of a machine learning workspace.
Value | Description |
---|---|
FQDN | |
PrivateEndpoint | |
ServiceTag |
ServerlessComputeSettings
Name | Type | Description |
---|---|---|
serverlessComputeCustomSubnet |
string (arm-id) |
The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed |
serverlessComputeNoPublicIP |
boolean |
The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint |
ServiceManagedResourcesSettings
Name | Type | Description |
---|---|---|
cosmosDb |
The settings for the service managed cosmosdb account. |
ServiceTagDestination
Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.
Name | Type | Description |
---|---|---|
action |
The action enum for networking rule. |
|
addressPrefixes |
string[] |
Optional, if provided, the ServiceTag property will be ignored. |
portRanges |
string |
|
protocol |
string |
|
serviceTag |
string |
ServiceTagOutboundRule
Service Tag Outbound Rule for the managed network of a machine learning workspace.
Name | Type | Description |
---|---|---|
category |
Category of a managed network Outbound Rule of a machine learning workspace. |
|
destination |
Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. |
|
errorInformation |
string |
Error information about an outbound rule of a machine learning workspace if RuleStatus is failed. |
parentRuleNames |
string[] |
|
status |
Type of a managed network Outbound Rule of a machine learning workspace. |
|
type |
string:
Service |
Type of a managed network Outbound Rule of a machine learning workspace. |
SharedPrivateLinkResource
Name | Type | Description |
---|---|---|
name |
string |
Unique name of the private link. |
properties.groupId |
string |
The private link resource group id. |
properties.privateLinkResourceId |
string |
The resource id that private link links to. |
properties.requestMessage |
string |
Request message. |
properties.status |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
Sku
The resource model definition representing SKU
Name | Type | Description |
---|---|---|
capacity |
integer (int32) |
If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. |
family |
string |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
name |
string |
The name of the SKU. Ex - P3. It is typically a letter+number code |
size |
string |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
tier |
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. |
SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Value | Description |
---|---|
Free | |
Basic | |
Standard | |
Premium |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
systemDatastoresAuthMode
The auth mode used for accessing the system datastores of the workspace.
Value | Description |
---|---|
AccessKey | |
Identity | |
UserDelegationSAS |
UserAssignedIdentity
User assigned identity properties
Name | Type | Description |
---|---|---|
clientId |
string (uuid) |
The client ID of the assigned identity. |
principalId |
string (uuid) |
The principal ID of the assigned identity. |
Workspace
An object that represents a machine learning workspace.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
The identity of the resource. |
||
kind |
string |
||
location |
string |
Specifies the location of the resource. |
|
name |
string |
The name of the resource |
|
properties.allowPublicAccessWhenBehindVnet |
boolean |
False |
The flag to indicate whether to allow public access when behind VNet. |
properties.applicationInsights |
string |
ARM id of the application insights associated with this workspace. |
|
properties.associatedWorkspaces |
string[] |
||
properties.containerRegistry |
string |
ARM id of the container registry associated with this workspace. |
|
properties.description |
string |
The description of this workspace. |
|
properties.discoveryUrl |
string |
Url for the discovery service to identify regional endpoints for machine learning experimentation services |
|
properties.enableDataIsolation |
boolean |
||
properties.enableServiceSideCMKEncryption |
boolean |
||
properties.encryption |
The encryption settings of Azure ML workspace. |
||
properties.featureStoreSettings |
Settings for feature store type workspace. |
||
properties.friendlyName |
string |
The friendly name for this workspace. This name in mutable |
|
properties.hbiWorkspace |
boolean |
False |
The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service |
properties.hubResourceId |
string |
||
properties.imageBuildCompute |
string |
The compute name for image build |
|
properties.keyVault |
string |
ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created |
|
properties.managedNetwork |
Managed Network settings for a machine learning workspace. |
||
properties.mlFlowTrackingUri |
string |
The URI associated with this workspace that machine learning flow must point at to set up tracking. |
|
properties.notebookInfo |
The notebook info of Azure ML workspace. |
||
properties.primaryUserAssignedIdentity |
string |
The user assigned identity resource id that represents the workspace identity. |
|
properties.privateEndpointConnections |
The list of private endpoint connections in the workspace. |
||
properties.privateLinkCount |
integer (int32) |
Count of private connections in the workspace |
|
properties.provisioningState |
The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. |
||
properties.publicNetworkAccess |
Whether requests from Public Network are allowed. |
||
properties.serverlessComputeSettings |
Settings for serverless compute created in the workspace |
||
properties.serviceManagedResourcesSettings |
The service managed resource settings. |
||
properties.serviceProvisionedResourceGroup |
string |
The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace |
|
properties.sharedPrivateLinkResources |
The list of shared private link resources in this workspace. |
||
properties.storageAccount |
string |
ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created |
|
properties.storageHnsEnabled |
boolean |
If the storage associated with the workspace has hierarchical namespace(HNS) enabled. |
|
properties.systemDatastoresAuthMode |
The auth mode used for accessing the system datastores of the workspace. |
||
properties.tenantId |
string |
The tenant id associated with this workspace. |
|
properties.v1LegacyMode |
boolean |
False |
Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. |
properties.workspaceHubConfig |
WorkspaceHub's configuration object. |
||
properties.workspaceId |
string |
The immutable id associated with this workspace. |
|
sku |
The sku of the workspace. |
||
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
||
tags |
object |
Contains resource tags defined as key/value pairs. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
WorkspaceHubConfig
WorkspaceHub's configuration object.
Name | Type | Description |
---|---|---|
additionalWorkspaceStorageAccounts |
string[] |
|
defaultWorkspaceResourceGroup |
string |
WorkspaceListResult
The result of a request to list machine learning workspaces.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI that can be used to request the next list of machine learning workspaces. |
value |
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. |